{"openapi":"3.0.1","info":{"description":"De Aankoop API biedt toegang tot aankoopopdrachten en de bijbehorende woning-, relatie- en transactiedata binnen Realworks. Afhankelijk van inzagelevel zijn ook objectgegevens, relatiegegevens en financiële informatie beschikbaar.\n\n#### Zo gebruik je deze API\n1. Haal de aankoopopdrachten op voor een of meerdere afdelingen.\n2. Filter de resultaten indien gewenst op status, accountmanager of actieve dossiers.\n3. Verwerk de ontvangen aankoopgegevens binnen de eigen applicatie.\n4. Gebruik de paginering om alle beschikbare aankoopopdrachten op te halen.\n\n#### Bijzonderheden\n* De API is uitsluitend bedoeld voor het raadplegen van aankoopinformatie; wijzigen of aanmaken van gegevens is niet mogelijk.\n* Welke gegevens beschikbaar zijn, is afhankelijk van het access level van de gebruikte API-token.\n* Resultaten kunnen worden gefilterd op onder andere afdeling, status, accountmanager en actieve dossiers.\n* Bij meerdere vestigingen kan een afdelingscode worden gebruikt om alleen gegevens van een specifieke vestiging op te halen.\n\n#### Laatste wijzigingen\n##### 06-02-2026\n* De relatiestructuur is aangepast naar een generieke `id`/`type`-structuur.\n\n##### 15-07-2025\n* `courtageBedrag` en `courtagePercentage` toegevoegd.\n* Statuswaarde `LOPEND` hernoemd naar `BEZICHTIGING`.\n* `aankooprapportage.aankoopBeoordeling` verwijderd.","title":"Aankoop"},"externalDocs":{"description":"OpenAPI Specification","url":"/openapi-doc/v1/Aankoop"},"servers":[{"url":"https://api.realworks.nl"}],"security":[{"rwauth":[]}],"tags":[{"name":"Aankoop"}],"paths":{"/aankoop/v3/objecten/{afdelingscode}":{"get":{"description":"De response is inhoudelijk grotendeels gelijk gebleven, met enkele veldwijzigingen en uitbreidingen.\n\n### Migratie-overzicht (t.o.v. vorige versies)\n\n**Nieuw**\n* `courtageBedrag`\n* `courtagePercentage`\n\n**Gewijzigd**\n* `status`: waarde `LOPEND` → `BEZICHTIGING`\n* 06-02-2026: relatie structuur naar id/type variant aangepast.\n\n**Verwijderd**\n* `aankooprapportage.aankoopBeoordeling`\n\n### Wat moet je aanpassen\n* Verwijder eventuele mapping/afhankelijkheid op `aankooprapportage.aankoopBeoordeling`.\n* Verwerk de nieuwe velden `courtageBedrag` en `courtagePercentage` (indien je deze toont of opslaat).\n* Pas logica/validatie aan als je code expliciet rekent op `status = LOPEND` (de waarde is nu `BEZICHTIGING`).\n","operationId":"zoekenAankoopObjectenV3","parameters":[{"description":"Access Level: **BASIS**<br/><br/>Indien er sprake is van meerdere vestigingen, kan in het veld <b>Afdelingscode</b> op specifieke vestiging gefilterd worden. (veld leeg geeft alle beschikbare data van alle vestigingen)","in":"path","name":"afdelingscode","required":true,"schema":{"type":"string"}},{"description":"Access Level: **OBJECT**<br/><br/>","in":"query","name":"status","required":false,"schema":{"type":"string","enum":["BEZICHTIGING","GEANNULEERD","AANGEKOCHT","ONTBONDEN","BIEDING","IN_TRANSACTIE","GEARCHIVEERD"]}},{"description":"Access Level: **RELATIES**<br/><br/>","in":"query","name":"accountmanager","required":false,"schema":{"type":"string"}},{"description":"Access Level: **BASIS**<br/><br/>","in":"query","name":"actief","required":false,"schema":{"type":"string","enum":["true","false","all"],"default":"true"}},{"description":" (min: _1_, max: _100_)","in":"query","name":"aantal","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":100}},{"in":"query","name":"vanaf","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSearchResultsAankoopopdrachtV3"}}},"description":"Succes"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Fout in aanroep"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"content":{},"description":"Te veel aanvragen"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Zoeken door aankoop objecten","tags":["Aankoop"]}}},"components":{"schemas":{"AankoopDiversen":{"type":"object","properties":{"aankoopDossier":{"type":"string","description":"Access Levels: **OBJECT**<br/>"},"actief":{"type":"boolean","description":"Access Levels: **BASIS**<br/>"},"afdelingscode":{"type":"string","description":"Access Levels: **BASIS**<br/>","nullable":true},"bedrijfscode":{"type":"string","description":"Access Levels: **BASIS**<br/>"},"datumInvoer":{"type":"string","description":"Access Levels: **OBJECT**<br/>","format":"date-time","nullable":true},"korteOmschrijving":{"type":"string","description":"Access Levels: **OBJECT**<br/>"},"laatsteWijziging":{"type":"string","description":"Access Levels: **OBJECT**<br/>","format":"date-time","nullable":true},"projectCode":{"type":"string","description":"Access Levels: **BASIS**<br/>","nullable":true},"uitwisselingObject":{"type":"string","description":"Access Levels: **FINANCIEEL**<br/>"}},"nullable":true},"AankoopKenmerkenV2":{"type":"object","properties":{"aantalKamers":{"type":"integer","description":"Access Levels: **OBJECT**<br/>","format":"int32"},"bouwjaar":{"type":"string","description":"Access Levels: **OBJECT**<br/>"},"inhoudWoning":{"type":"integer","description":"Access Levels: **OBJECT**<br/>","format":"int32"},"soortObject":{"type":"string","description":"Access Levels: **OBJECT**<br/>","enum":["WOONHUIS","APPARTEMENT","BOUWGROND","OVERIGOG"]},"typeAppartement":{"type":"string","description":"Access Levels: **OBJECT**<br/>","enum":["BOVENWONING","BENEDENWONING","MAISONNETTE","GALERIJFLAT","PORTIEKFLAT","BENEDEN_BOVENWONING","PENTHOUSE","PORTIEKWONING","STUDENTENKAMER","DUBBEL_BENEDENHUIS","TUSSENVERDIEPING"]},"woningType":{"type":"string","description":"Access Levels: **OBJECT**<br/>","enum":["EENGEZINSWONING","HERENHUIS","VILLA","LANDHUIS","BUNGALOW","WOONBOERDERIJ","GRACHTENPAND","WOONBOOT","STACARAVAN","WOONWAGEN","LANDGOED"]},"woonoppervlakte":{"type":"integer","description":"Access Levels: **OBJECT**<br/>","format":"int32"}},"description":"AankoopKenmerkenV2"},"AankoopMarketing":{"type":"object","properties":{"publicatiedatum":{"type":"string","description":"Access Levels: **BASIS**<br/>Datum van publicatie voor huidige gebruiker","format":"date-time","nullable":true},"vrijgaveWebsite":{"type":"integer","description":"Access Levels: **OBJECT**<br/>","format":"int32"}}},"AankoopOverdrachtV2":{"type":"object","properties":{"bodemonderzoek":{"type":"string","description":"Access Levels: **FINANCIEEL**<br/>","format":"date"},"bouwkundigRapport":{"type":"string","description":"Access Levels: **FINANCIEEL**<br/>","format":"date"},"datumAanvaarding":{"type":"string","description":"Access Levels: **FINANCIEEL**<br/>","format":"date"},"datumOndertekeningAkte":{"type":"string","description":"Access Levels: **FINANCIEEL**<br/>","format":"date"},"datumOntbVoorwaarden":{"type":"string","description":"Access Levels: **FINANCIEEL**<br/>","format":"date"},"datumTransport":{"type":"string","description":"Access Levels: **FINANCIEEL**<br/>","format":"date"},"datumWaarborg":{"type":"string","description":"Access Levels: **FINANCIEEL**<br/>","format":"date"},"nhg":{"type":"string","description":"Access Levels: **FINANCIEEL**<br/>","format":"date"},"noRiskClausule":{"type":"string","description":"Access Levels: **FINANCIEEL**<br/>","format":"date"},"prijsConditie":{"type":"string","description":"Access Levels: **FINANCIEEL**<br/>","enum":["KOSTEN_KOPER","VRIJ_OP_NAAM"]},"transactieprijs":{"type":"number","description":"Access Levels: **FINANCIEEL**<br/>"},"verViaNotarieelTransport":{"type":"boolean","description":"Access Levels: **FINANCIEEL**<br/>"},"vraagprijs":{"type":"number","description":"Access Levels: **FINANCIEEL**<br/>"}},"description":"AankoopOverdrachtV2"},"AankoopTeksten":{"type":"object","properties":{"aantekeningen":{"$ref":"#/components/schemas/Aantekeningen"},"opmerkingen":{"$ref":"#/components/schemas/Opmerkingen"}}},"AankoopWoningRelatiesV2":{"type":"object","properties":{"id":{"type":"integer","description":"Access Levels: **RELATIES**<br/>","format":"int32"},"type":{"type":"string","description":"Access Levels: **RELATIES**<br/>","nullable":true}}},"AankoopWoningV3":{"type":"object","properties":{"aankooprapportage":{"$ref":"#/components/schemas/AankooprapportageV2"},"courtageBedrag":{"type":"string","description":"Access Levels: **OBJECT**<br/>"},"courtagePercentage":{"type":"integer","description":"Access Levels: **OBJECT**<br/>","format":"int32"},"huisnummer":{"type":"string","description":"Access Levels: **BASIS**<br/>"},"huisnummerToevoeging":{"type":"string","description":"Access Levels: **BASIS**<br/>"},"marketing":{"$ref":"#/components/schemas/AankoopMarketing"},"overdracht":{"$ref":"#/components/schemas/AankoopOverdrachtV2"},"plaatsnaam":{"type":"string","description":"Access Levels: **BASIS**<br/>"},"postcode":{"type":"string","description":"Access Levels: **BASIS**<br/>"},"relaties":{"type":"array","description":"Access Levels: **RELATIES**<br/>","items":{"$ref":"#/components/schemas/AankoopWoningRelatiesV2"}},"status":{"type":"string","description":"Access Levels: **OBJECT**<br/>","enum":["BEZICHTIGING","GEANNULEERD","AANGEKOCHT","ONTBONDEN","BIEDING","IN_TRANSACTIE","GEARCHIVEERD"]},"straat":{"type":"string","description":"Access Levels: **BASIS**<br/>"},"teksten":{"$ref":"#/components/schemas/AankoopTeksten"}},"description":"AankoopWoningV3"},"AankoopopdrachtV3":{"type":"object","properties":{"aankoopWoning":{"$ref":"#/components/schemas/AankoopWoningV3"},"diversen":{"$ref":"#/components/schemas/AankoopDiversen"},"systemid":{"type":"integer","description":"Access Levels: **BASIS**<br/>","format":"int32"}},"description":"AankoopopdrachtV3"},"AankooprapportageV2":{"type":"object","properties":{"kenmerken":{"$ref":"#/components/schemas/AankoopKenmerkenV2"},"media":{"type":"array","description":"Access Levels: **OBJECT**<br/>","nullable":true,"items":{"$ref":"#/components/schemas/Media"}}},"description":"AankooprapportageV2"},"Aantekeningen":{"type":"object","properties":{"aantekeningen":{"type":"string","description":"Access Levels: **OBJECT**<br/>"},"aantekeningenOpmerkingen":{"type":"string","description":"Access Levels: **OBJECT**<br/>"}}},"ApiSearchResultsAankoopopdrachtV3":{"type":"object","properties":{"paginering":{"$ref":"#/components/schemas/PaginationInfo"},"resultaten":{"type":"array","items":{"$ref":"#/components/schemas/AankoopopdrachtV3"}}},"description":"Zoekresultaten"},"ErrorResponse":{"type":"object","properties":{"meldingen":{"type":"array","items":{"type":"string"}}},"description":"Foutmeldingen"},"Media":{"type":"object","properties":{"link":{"type":"string","description":"Access Levels: **OBJECT**<br/>Link naar media. De media die hier wordt opgehaald is op thumbnail formaat. Voor het originele formaat gebruik achter de URL de \"resize=4\" query parameter. Voor video media moet er altijd \"resize=4\" worden toegevoegd achter de URL.","nullable":true},"mimetype":{"type":"string","description":"Access Levels: **OBJECT**<br/>Mimetype","nullable":true},"omschrijving":{"type":"string","description":"Access Levels: **OBJECT**<br/>Omschrijving","nullable":true},"soort":{"type":"string","description":"Access Levels: **OBJECT**<br/>Soort media","nullable":true,"enum":["HOOFDFOTO","FOTO","PLATTEGROND","IPIX","VIDEO","FLASH","SLIDESHOW","DOCUMENT","GELUID","CONNECTED_PARTNER","QR_CODE"]},"titel":{"type":"string","description":"Access Levels: **OBJECT**<br/>Titel","nullable":true},"volgnummer":{"type":"integer","description":"Access Levels: **OBJECT**<br/>Volgnummer van de media","format":"int32","nullable":true},"vrijgave":{"type":"boolean","description":"Access Levels: **OBJECT**<br/>Eigen site vrijgave","nullable":true},"wijzigingstijdstip":{"type":"string","description":"Access Levels: **OBJECT**<br/>Laatste wijziging","format":"date-time","nullable":true}}},"Opmerkingen":{"type":"object","properties":{"tekstenOpmerkingen":{"type":"string","description":"Access Levels: **OBJECT**<br/>"}}},"PaginationInfo":{"type":"object","properties":{"totaalAantal":{"type":"integer","format":"int64"},"volgende":{"type":"string","format":"uri","nullable":true}},"description":"Pagineringsinformatie"}},"securitySchemes":{"rwauth":{"in":"header","name":"Authorization","type":"apiKey"}}}}