# Commerciële Transacties API

## GET /commercial-transactions

> Retrieves commercial transactions for an object.

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"servers":[{"url":"https://api.matrixian.com/v1","description":"Matrixian API"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"{{API_KEY}}"}},"schemas":{"CommercialTransactionsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CommercialTransaction"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"CommercialTransactionsResponse"},"CommercialTransaction":{"properties":{"sourceFile":{"type":"string","title":"Sourcefile","description":"Source file"},"overBewK":{"type":"string","title":"Overbewk","description":"Custody code for the transaction."},"stukOntvDatum":{"type":"string","format":"date","title":"Stukontvdatum","description":"Date the document was received."},"overStuk":{"type":"string","title":"Overstuk","description":"Unique identifier for the transaction document."},"nnpVerkoperCode":{"type":"string","title":"Nnpverkopercode","description":"Code identifying the legal entity of the seller."},"nnpKoperCode":{"type":"string","title":"Nnpkopercode","description":"Code identifying the legal entity of the buyer."},"objeMutSrtK":{"type":"string","title":"Objemutsrtk","description":"Code for the type of mutation or transaction."},"indFamTrans":{"type":"string","title":"Indfamtrans","description":"Boolean indicating whether the transaction is a family transfer."},"objeObjekt":{"type":"string","title":"Objeobjekt","description":"Reference code for the object being transacted."},"kadGem":{"type":"string","title":"Kadgem","description":"Code representing the cadastral municipality."},"sectie":{"type":"string","title":"Sectie","description":"Section code related to the property parcel."},"perceelnr":{"type":"string","title":"Perceelnr","description":"Number representing the parcel within the section."},"indexlt":{"type":"string","title":"Indexlt","description":"Letter index for the property."},"indexnr":{"type":"string","title":"Indexnr","description":"Number index for the property."},"objeGrootte":{"type":"string","title":"Objegrootte","description":"Size of the object, typically area in square meters."},"objeKoopSom":{"type":"string","title":"Objekoopsom","description":"The purchase price of the property in the transaction."},"objeIndMeerOG":{"type":"string","title":"Objeindmeerog","description":"Boolean indicating if the transaction involves multiple ownerships."},"objeBurgGemNr":{"type":"string","title":"Objeburggemnr","description":"Number identifier for the municipality."},"objeBurgGemNaam":{"type":"string","title":"Objeburggemnaam","description":"Name of the municipality where the property is located."},"objeKultOngebK":{"type":"string","title":"Objekultongebk","description":"Cultural code for unbuilt structures."},"zakrZrK":{"type":"string","title":"Zakrzrk","description":"Code identifying any business rights attached to the transaction."},"toelichtingZakRecht":{"title":"Toelichtingzakrecht","description":"Description of any business rights attached to the transaction.","type":"string","nullable":true},"objbObjBelK":{"type":"string","title":"Objbobjbelk","description":"Code for any obstructions on the object."},"objeXCoord":{"type":"string","title":"Objexcoord","description":"X coordinate of the property's location."},"objeYCoord":{"type":"string","title":"Objeycoord","description":"Y coordinate of the property's location."},"objeKultText":{"type":"string","title":"Objekulttext","description":"Text providing cultural or contextual information about the property."},"objaKultGebK":{"type":"string","title":"Objakultgebk","description":"Cultural code for built structures on the property."},"objaPltsNaam":{"type":"string","title":"Objapltsnaam","description":"Name of the place where the property is located."},"objaStraat":{"type":"string","title":"Objastraat","description":"Street name of the property's location."},"objaHuisNr":{"title":"Objahuisnr","description":"House number of the property.","type":"string","nullable":true},"objaHuisLr":{"title":"Objahuislr","description":"House letter if applicable, otherwise blank.","type":"string","nullable":true},"objaToevoeging":{"title":"Objatoevoeging","description":"Any additional house extension code or description.","type":"string","nullable":true},"objaPttK":{"type":"string","title":"Objapttk","description":"Postal code associated with the property."},"pht":{"title":"Pht","description":"Unique identifier for the address.","type":"string","nullable":true},"overId":{"type":"string","title":"Overid","description":"Unique transfer identifier for the transaction."},"bagId":{"title":"Bagid","description":"ID of the building associated with the transaction.","type":"string","nullable":true}},"type":"object","required":["sourceFile","overBewK","stukOntvDatum","overStuk","nnpVerkoperCode","nnpKoperCode","objeMutSrtK","indFamTrans","objeObjekt","kadGem","sectie","perceelnr","indexlt","indexnr","objeGrootte","objeKoopSom","objeIndMeerOG","objeBurgGemNr","objeBurgGemNaam","objeKultOngebK","zakrZrK","objbObjBelK","objeXCoord","objeYCoord","objeKultText","objaKultGebK","objaPltsNaam","objaStraat","objaHuisNr","objaHuisLr","objaToevoeging","objaPttK","pht","overId"],"title":"CommercialTransaction"},"ErrorObject":{"properties":{"code":{"type":"integer","title":"Code"},"message":{"type":"string","title":"Message"},"errors":{"items":{"$ref":"#/components/schemas/ErrorDetail"},"type":"array","title":"Errors"}},"type":"object","required":["code","message","errors"],"title":"ErrorObject"},"ErrorDetail":{"properties":{"reason":{"type":"string","title":"Reason"},"message":{"type":"string","title":"Message"}},"type":"object","required":["reason","message"],"title":"ErrorDetail"}}},"paths":{"/commercial-transactions":{"get":{"description":"Retrieves commercial transactions for an object.","operationId":"commercialTransactions","parameters":[{"description":"Zipcode","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"postalCode","in":"query"},{"description":"House number","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"name":"houseNumber","in":"query"},{"description":"House letter","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"houseLetter","in":"query"},{"description":"House number extention","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"houseNumberExt","in":"query"},{"description":"Identification number according to the BAG.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"bagNummeraanduidingid","in":"query"},{"description":"Identification number of the building according to the BAG.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"pandId","in":"query"},{"description":"Over stuk","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"overStuk","in":"query"}],"responses":{"200":{"description":"CommercialTransactionsResponse","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"$ref":"#/components/schemas/CommercialTransactionsResponse"},"error":{"additionalProperties":{"type":"string"},"type":"object"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["data","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"400":{"description":"HTTP 400","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"401":{"description":"HTTP 401","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"403":{"description":"HTTP 403","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"404":{"description":"HTTP 404","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"500":{"description":"HTTP 500","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}}}}}}}
```

## The CommercialTransactionsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"components":{"schemas":{"CommercialTransactionsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CommercialTransaction"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"CommercialTransactionsResponse"},"CommercialTransaction":{"properties":{"sourceFile":{"type":"string","title":"Sourcefile","description":"Source file"},"overBewK":{"type":"string","title":"Overbewk","description":"Custody code for the transaction."},"stukOntvDatum":{"type":"string","format":"date","title":"Stukontvdatum","description":"Date the document was received."},"overStuk":{"type":"string","title":"Overstuk","description":"Unique identifier for the transaction document."},"nnpVerkoperCode":{"type":"string","title":"Nnpverkopercode","description":"Code identifying the legal entity of the seller."},"nnpKoperCode":{"type":"string","title":"Nnpkopercode","description":"Code identifying the legal entity of the buyer."},"objeMutSrtK":{"type":"string","title":"Objemutsrtk","description":"Code for the type of mutation or transaction."},"indFamTrans":{"type":"string","title":"Indfamtrans","description":"Boolean indicating whether the transaction is a family transfer."},"objeObjekt":{"type":"string","title":"Objeobjekt","description":"Reference code for the object being transacted."},"kadGem":{"type":"string","title":"Kadgem","description":"Code representing the cadastral municipality."},"sectie":{"type":"string","title":"Sectie","description":"Section code related to the property parcel."},"perceelnr":{"type":"string","title":"Perceelnr","description":"Number representing the parcel within the section."},"indexlt":{"type":"string","title":"Indexlt","description":"Letter index for the property."},"indexnr":{"type":"string","title":"Indexnr","description":"Number index for the property."},"objeGrootte":{"type":"string","title":"Objegrootte","description":"Size of the object, typically area in square meters."},"objeKoopSom":{"type":"string","title":"Objekoopsom","description":"The purchase price of the property in the transaction."},"objeIndMeerOG":{"type":"string","title":"Objeindmeerog","description":"Boolean indicating if the transaction involves multiple ownerships."},"objeBurgGemNr":{"type":"string","title":"Objeburggemnr","description":"Number identifier for the municipality."},"objeBurgGemNaam":{"type":"string","title":"Objeburggemnaam","description":"Name of the municipality where the property is located."},"objeKultOngebK":{"type":"string","title":"Objekultongebk","description":"Cultural code for unbuilt structures."},"zakrZrK":{"type":"string","title":"Zakrzrk","description":"Code identifying any business rights attached to the transaction."},"toelichtingZakRecht":{"title":"Toelichtingzakrecht","description":"Description of any business rights attached to the transaction.","type":"string","nullable":true},"objbObjBelK":{"type":"string","title":"Objbobjbelk","description":"Code for any obstructions on the object."},"objeXCoord":{"type":"string","title":"Objexcoord","description":"X coordinate of the property's location."},"objeYCoord":{"type":"string","title":"Objeycoord","description":"Y coordinate of the property's location."},"objeKultText":{"type":"string","title":"Objekulttext","description":"Text providing cultural or contextual information about the property."},"objaKultGebK":{"type":"string","title":"Objakultgebk","description":"Cultural code for built structures on the property."},"objaPltsNaam":{"type":"string","title":"Objapltsnaam","description":"Name of the place where the property is located."},"objaStraat":{"type":"string","title":"Objastraat","description":"Street name of the property's location."},"objaHuisNr":{"title":"Objahuisnr","description":"House number of the property.","type":"string","nullable":true},"objaHuisLr":{"title":"Objahuislr","description":"House letter if applicable, otherwise blank.","type":"string","nullable":true},"objaToevoeging":{"title":"Objatoevoeging","description":"Any additional house extension code or description.","type":"string","nullable":true},"objaPttK":{"type":"string","title":"Objapttk","description":"Postal code associated with the property."},"pht":{"title":"Pht","description":"Unique identifier for the address.","type":"string","nullable":true},"overId":{"type":"string","title":"Overid","description":"Unique transfer identifier for the transaction."},"bagId":{"title":"Bagid","description":"ID of the building associated with the transaction.","type":"string","nullable":true}},"type":"object","required":["sourceFile","overBewK","stukOntvDatum","overStuk","nnpVerkoperCode","nnpKoperCode","objeMutSrtK","indFamTrans","objeObjekt","kadGem","sectie","perceelnr","indexlt","indexnr","objeGrootte","objeKoopSom","objeIndMeerOG","objeBurgGemNr","objeBurgGemNaam","objeKultOngebK","zakrZrK","objbObjBelK","objeXCoord","objeYCoord","objeKultText","objaKultGebK","objaPltsNaam","objaStraat","objaHuisNr","objaHuisLr","objaToevoeging","objaPttK","pht","overId"],"title":"CommercialTransaction"}}}}
```

## The CommercialTransaction object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"components":{"schemas":{"CommercialTransaction":{"properties":{"sourceFile":{"type":"string","title":"Sourcefile","description":"Source file"},"overBewK":{"type":"string","title":"Overbewk","description":"Custody code for the transaction."},"stukOntvDatum":{"type":"string","format":"date","title":"Stukontvdatum","description":"Date the document was received."},"overStuk":{"type":"string","title":"Overstuk","description":"Unique identifier for the transaction document."},"nnpVerkoperCode":{"type":"string","title":"Nnpverkopercode","description":"Code identifying the legal entity of the seller."},"nnpKoperCode":{"type":"string","title":"Nnpkopercode","description":"Code identifying the legal entity of the buyer."},"objeMutSrtK":{"type":"string","title":"Objemutsrtk","description":"Code for the type of mutation or transaction."},"indFamTrans":{"type":"string","title":"Indfamtrans","description":"Boolean indicating whether the transaction is a family transfer."},"objeObjekt":{"type":"string","title":"Objeobjekt","description":"Reference code for the object being transacted."},"kadGem":{"type":"string","title":"Kadgem","description":"Code representing the cadastral municipality."},"sectie":{"type":"string","title":"Sectie","description":"Section code related to the property parcel."},"perceelnr":{"type":"string","title":"Perceelnr","description":"Number representing the parcel within the section."},"indexlt":{"type":"string","title":"Indexlt","description":"Letter index for the property."},"indexnr":{"type":"string","title":"Indexnr","description":"Number index for the property."},"objeGrootte":{"type":"string","title":"Objegrootte","description":"Size of the object, typically area in square meters."},"objeKoopSom":{"type":"string","title":"Objekoopsom","description":"The purchase price of the property in the transaction."},"objeIndMeerOG":{"type":"string","title":"Objeindmeerog","description":"Boolean indicating if the transaction involves multiple ownerships."},"objeBurgGemNr":{"type":"string","title":"Objeburggemnr","description":"Number identifier for the municipality."},"objeBurgGemNaam":{"type":"string","title":"Objeburggemnaam","description":"Name of the municipality where the property is located."},"objeKultOngebK":{"type":"string","title":"Objekultongebk","description":"Cultural code for unbuilt structures."},"zakrZrK":{"type":"string","title":"Zakrzrk","description":"Code identifying any business rights attached to the transaction."},"toelichtingZakRecht":{"title":"Toelichtingzakrecht","description":"Description of any business rights attached to the transaction.","type":"string","nullable":true},"objbObjBelK":{"type":"string","title":"Objbobjbelk","description":"Code for any obstructions on the object."},"objeXCoord":{"type":"string","title":"Objexcoord","description":"X coordinate of the property's location."},"objeYCoord":{"type":"string","title":"Objeycoord","description":"Y coordinate of the property's location."},"objeKultText":{"type":"string","title":"Objekulttext","description":"Text providing cultural or contextual information about the property."},"objaKultGebK":{"type":"string","title":"Objakultgebk","description":"Cultural code for built structures on the property."},"objaPltsNaam":{"type":"string","title":"Objapltsnaam","description":"Name of the place where the property is located."},"objaStraat":{"type":"string","title":"Objastraat","description":"Street name of the property's location."},"objaHuisNr":{"title":"Objahuisnr","description":"House number of the property.","type":"string","nullable":true},"objaHuisLr":{"title":"Objahuislr","description":"House letter if applicable, otherwise blank.","type":"string","nullable":true},"objaToevoeging":{"title":"Objatoevoeging","description":"Any additional house extension code or description.","type":"string","nullable":true},"objaPttK":{"type":"string","title":"Objapttk","description":"Postal code associated with the property."},"pht":{"title":"Pht","description":"Unique identifier for the address.","type":"string","nullable":true},"overId":{"type":"string","title":"Overid","description":"Unique transfer identifier for the transaction."},"bagId":{"title":"Bagid","description":"ID of the building associated with the transaction.","type":"string","nullable":true}},"type":"object","required":["sourceFile","overBewK","stukOntvDatum","overStuk","nnpVerkoperCode","nnpKoperCode","objeMutSrtK","indFamTrans","objeObjekt","kadGem","sectie","perceelnr","indexlt","indexnr","objeGrootte","objeKoopSom","objeIndMeerOG","objeBurgGemNr","objeBurgGemNaam","objeKultOngebK","zakrZrK","objbObjBelK","objeXCoord","objeYCoord","objeKultText","objaKultGebK","objaPltsNaam","objaStraat","objaHuisNr","objaHuisLr","objaToevoeging","objaPttK","pht","overId"],"title":"CommercialTransaction"}}}}
```