{"openapi":"3.1.0","jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","info":{"title":"Credifin Public API","version":"1.2.0","summary":"Kerncontract voor dossieraanlevering en legacy-compatibiliteit","description":"Dit document beschrijft de geïmplementeerde publieke kern. De `/api/...`-routes vormen een compatibiliteitsfacade voor bestaande CollectOnline-koppelingen; nieuwe koppelingen gebruiken bij voorkeur de atomaire `POST /api/v1/dossiers`-route. Credifin activeert de koppeling per klant; daarna maakt de klantbeheerder in het klantportaal met één klik een API-key met de juiste scopes en geldigheid.","contact":{"name":"Credifin API support"},"x-release-status":"implemented-core","x-versioning-policy":{"breakingChanges":"Breaking changes aan een stabiele API verschijnen uitsluitend onder een nieuwe `/api/vN`-majorversie.","deprecation":"Stabiele v1-operaties krijgen minimaal 12 maanden deprecatietijd voordat ze worden verwijderd.","legacyFacade":"De ongenummerde `/api/...`-facade is migratiegericht en volgt alleen de expliciet gedocumenteerde CollectOnline-kernroutes."},"x-migration-note":{"title":"Migratie van CollectOnline","existingIntegrations":"Vervang het CollectOnline-adres door het API-adres van Credifin en gebruik uw nieuwe sleutel in de header `Api-Key`. De gedocumenteerde kernroutes behouden de legacy-paden en JSON-veldnamen. Controleer vóór overstap welke routes uw bestaande koppeling gebruikt; niet elke CollectOnline-functie valt onder deze API.","identifiers":"Nieuwe resources krijgen eigen UUID’s; klantreferenties en debiteurnummers blijven behouden. Geïmporteerde CollectOnline-ID’s worden via hun bewaarde bronidentiteit herkend, ook na sleutelwisseling. Een oude ID zonder bevestigde bronkoppeling wordt niet op naam of nummer geraden.","createSemantics":"Legacy create-operaties antwoorden compatibel met HTTP 200. Een optionele `Idempotency-Key` voorkomt dubbele records bij retries. Workflowactivatie vindt pas plaats na de laatste vervaldatum.","newIntegrations":"Nieuwe klanten controleren dezelfde body eerst zonder mutatie via `POST /api/v1/dossiers/validate` en leveren hem daarna aan via `POST /api/v1/dossiers` met een verplichte `Idempotency-Key`. Debiteur, dossier en facturen worden als één transactie verwerkt: alles slaagt of niets wordt vastgelegd. Bijlagen (pdf, afbeeldingen (ook HEIC), HTML, XML/UBL, EML, MSG, DOCX, XLSX, tekst en csv, maximaal 10 MB) gaan als base64 mee in dezelfde aanvraag."}},"servers":[{"url":"/","description":"Dezelfde host als waarop deze documentatie wordt aangeboden"}],"tags":[{"name":"Legacy creditors","description":"De klanten waarvoor een sleutel werkt; voor agenten alle klanten onder het agentschap."},{"name":"Legacy debtors","description":"Drop-in compatibiliteit voor debiteuren, adressen en contacten: aanmaken en lezen."},{"name":"Legacy dossiers","description":"Compatibele kernroutes voor dossieraanlevering, lijsten, status, saldo en financieel overzicht."},{"name":"Legacy invoices","description":"Compatibele kernroutes voor factuuraanlevering en het lezen van facturen."},{"name":"Legacy finance","description":"Betalingen, creditnota-regels, kosten en gerechtskosten per dossier lezen."},{"name":"Legacy documents","description":"Bijlagen van een dossier opvragen en downloaden."},{"name":"Dossiers v1","description":"Atomaire aanlevering voor nieuwe klantintegraties."}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/dossier/{dossier}/close":{"post":{"operationId":"ominimoCloseDossier","tags":["Legacy dossiers"],"security":[{"ApiKeyAuth":[]}],"summary":"Ominimo-dossier afsluiten","description":"Alleen beschikbaar voor Ominimo en Test Ominimo binnen de bestaande toegang. Vereist dossiers:create en Idempotency-Key. Sluit uitsluitend naar lost (Gesloten min) met reden en toelichting; verwijdert geen dossier en boekt geen betaling of kwijtschelding. Alle afmeldingen komen in één controletaak per opdrachtgever en Nederlandse kalenderdag. In de WIK-fase volgen de afgesproken briefkosten via de normale afrekening. Andere opdrachtgevers krijgen 403 CLOSURE_NOT_ENABLED.","parameters":[{"$ref":"#/components/parameters/DossierId"},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["reason","note"],"properties":{"reason":{"type":"string","enum":["withdrawn","incorrect_submission"],"description":"Afmelden sluit uitsluitend negatief (lost). Gebruik withdrawn of incorrect_submission met een toelichting."},"note":{"type":"string","minLength":3,"maxLength":2000,"description":"Inhoudelijke toelichting op de afmelding."}}},"example":{"reason":"withdrawn","note":"De opdrachtgever trekt de vordering in."}}}},"responses":{"200":{"description":"Gesloten, of al eerder gesloten. Een herhaling maakt geen tweede afmelding of briefvergoeding.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"},"Idempotency-Replayed":{"description":"`true` als deze response uit een eerdere succesvolle aanvraag is herhaald.","schema":{"type":"boolean"}}},"content":{"application/json":{"schema":{"type":"object","required":["uuid","status","closedAt","alreadyClosed","balanceCents","reviewRequired"],"properties":{"uuid":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["closed","lost"]},"closedAt":{"type":["string","null"],"format":"date-time"},"alreadyClosed":{"type":"boolean"},"balanceCents":{"type":"integer","description":"Resterend dossiersaldo in eurocenten; sluiten is geen financiële nulboeking."},"reviewRequired":{"type":"boolean","description":"De afmelding staat in de dagelijkse interne controle."}}},"example":{"uuid":"11111111-1111-4111-8111-111111111111","status":"lost","closedAt":"2026-10-08T10:00:00.000Z","alreadyClosed":false,"balanceCents":2500,"reviewRequired":true}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/debtor":{"get":{"operationId":"legacyListDebtors","tags":["Legacy debtors"],"summary":"Haal uw debiteuren op","description":"Gepagineerde lijst binnen uw opdrachtgever, inclusief eigen API-debiteuren zonder dossier. Zoek exact en hoofdlettergevoelig met X-API-FILTER-REFERENCE of de queryparameter reference. Beide moeten overeenkomen als u ze samen gebruikt. Onbekende referenties geven een lege lijst; meerdere historische matches blijven afzonderlijke resultaten. Paginering via X-API-NEXT-PAGE en X-API-PAGE-LIMIT, of page en limit.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/XApiNextPage"},{"$ref":"#/components/parameters/XApiPageLimit"},{"name":"X-API-FILTER-REFERENCE","in":"header","required":false,"schema":{"type":"string","minLength":1,"maxLength":200},"description":"Exacte eigen debiteurreferentie."},{"name":"reference","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200},"description":"Alternatief voor X-API-FILTER-REFERENCE; bij beide moeten de waarden overeenkomen."}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"},"X-API-NEXT-PAGE":{"$ref":"#/components/headers/XApiNextPage"},"X-API-PAGE":{"$ref":"#/components/headers/XApiPage"},"X-API-PAGE-LIMIT":{"$ref":"#/components/headers/XApiPageLimitResponse"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyDebtor"}},"example":[{"uuid":"4d9de86e-5d39-4fef-85a5-055426333625","reference":"KLANT-1042","companyName":"Voorbeeld Handel B.V.","email":"administratie@voorbeeld.nl","country":"NL","language":"nl","isCompany":true}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"post":{"operationId":"legacyCreateDebtor","tags":["Legacy debtors"],"summary":"Maak een debiteur aan","description":"Compatibele create-operatie. De response bevat een opaque `uuid` dat in vervolgaanroepen als `{debtor}` wordt gebruikt.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDebtorCreate"},"examples":{"company":{"summary":"Zakelijke debiteur","value":{"creditor":"creditor-demo","reference":"KLANT-1042","companyName":"Voorbeeld Handel B.V.","companyNumber":"12345678","email":"administratie@voorbeeld.nl","street":"Keizersgracht","houseNumber":"100","postalCode":"1015CS","city":"Amsterdam","country":"NL","language":"nl"}}}}}},"responses":{"200":{"description":"Debiteur aangemaakt.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDebtor"},"example":{"uuid":"4d9de86e-5d39-4fef-85a5-055426333625","reference":"KLANT-1042","companyName":"Voorbeeld Handel B.V.","country":"NL","language":"nl"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/debtor/{debtor}":{"put":{"operationId":"legacyUpdateDebtor","tags":["Legacy debtors"],"summary":"Werk een bestaande debiteur bij","description":"Gedeeltelijke update met dossiers:create en een verplichte Idempotency-Key. Weggelaten velden blijven behouden; null of leeg wist optionele velden. UUID en reference blijven gelijk. Een agentsleutel moet creditor meesturen. Adresvelden wijzigen het primaire actieve adres, anders het eerste actieve adres; zonder actief adres wordt bij ingevulde adresvelden een nieuw adres aangemaakt. Alleen het gevonden debiteurrecord wordt gewijzigd, niet afzonderlijke historische kopieën. Delen meerdere opdrachtgevers dit record, dan volgt 409 SHARED_DEBTOR. Gebruik een nieuwe sleutel per wijziging en dezelfde sleutel bij retries. POST blijft aanmaken/terugvinden. Technische notities blijven intern.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DebtorId"},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDebtorUpdate"},"example":{"email":"nieuw@voorbeeld.nl","telephone":null,"mobile":"+31612345678","postalCode":"7005 AM","city":"Doetinchem"}}}},"responses":{"200":{"description":"Debiteur bijgewerkt.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDebtor"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"get":{"operationId":"legacyGetDebtor","tags":["Legacy debtors"],"summary":"Haal een debiteur op","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DebtorId"},{"name":"creditor","in":"query","required":false,"schema":{"type":"string"},"description":"Opdrachtgever voor een gedeelde oude debiteur-UUID."}],"responses":{"200":{"description":"De debiteur.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDebtor"},"example":{"uuid":"4d9de86e-5d39-4fef-85a5-055426333625","reference":"KLANT-1042","companyName":"Voorbeeld Handel B.V.","email":"administratie@voorbeeld.nl","country":"NL","language":"nl"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/debtor/{debtor}/address":{"get":{"operationId":"legacyListDebtorAddresses","tags":["Legacy debtors"],"summary":"Haal de adressen van een debiteur op","description":"Alle adressen, het standaardadres eerst.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DebtorId"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyDebtorAddress"}},"example":[{"uuid":"9f4d2b1c-0e7a-4c6b-8d5e-3f2a1b0c9d8e","street":"Keizersgracht","houseNumber":"100","postalCode":"1015CS","city":"Amsterdam","country":"NL","default":true,"active":true}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"post":{"operationId":"legacyCreateDebtorAddress","tags":["Legacy debtors"],"summary":"Voeg een adres toe aan een debiteur","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DebtorId"},{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDebtorAddressCreate"},"example":{"street":"Keizersgracht","houseNumber":"100","postalCode":"1015CS","city":"Amsterdam","country":"NL","default":true,"active":true}}}},"responses":{"200":{"description":"Adres aangemaakt.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDebtorAddress"},"example":{"uuid":"33c19c0d-eb20-496c-a906-348d38017947","street":"Keizersgracht","houseNumber":"100","postalCode":"1015CS","city":"Amsterdam","country":"NL","default":true,"active":true}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/debtor/{debtor}/contact":{"get":{"operationId":"legacyListDebtorContacts","tags":["Legacy debtors"],"summary":"Haal de actieve contacten van een debiteur op","description":"Alleen actieve contactpersonen. Gebruik `GET /api/debtor/{debtor}/contact/all` voor de volledige lijst.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DebtorId"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyDebtorContact"}},"example":[{"uuid":"2c8f1a3b-4d5e-4f60-9a7b-8c9d0e1f2a3b","title":"MR","function":"Boekhouder","firstName":"Jan","lastName":"Jansen","phone":"+31201234567","mobile":null,"fax":null,"email":"jan@voorbeeld.nl","default":true,"active":true}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"post":{"operationId":"legacyCreateDebtorContact","tags":["Legacy debtors"],"summary":"Voeg een contact toe aan een debiteur","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DebtorId"},{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDebtorContactCreate"},"example":{"firstName":"Samira","lastName":"De Vries","function":"Financiële administratie","email":"samira.devries@voorbeeld.nl","phone":"+31201234567","default":true,"active":true}}}},"responses":{"200":{"description":"Contact aangemaakt.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDebtorContact"},"example":{"uuid":"d39bfae1-aa13-42a7-a21c-0fa594e2f75b","firstName":"Samira","lastName":"De Vries","email":"samira.devries@voorbeeld.nl","default":true,"active":true}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier":{"get":{"operationId":"legacyListDossiers","tags":["Legacy dossiers"],"summary":"Haal uw dossiers op","description":"Gepagineerde lijst, laatst gewijzigd eerst. Filter op wijzigingsmoment met `X-API-FILTER-FROM` en `X-API-FILTER-TO` (Nederlandse tijd) of op betalingskenmerk met `X-API-FILTER-OGM`. De responseheader `X-API-NEXT-PAGE` bevat het volgende paginanummer en is leeg op de laatste pagina.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/XApiNextPage"},{"$ref":"#/components/parameters/XApiPageLimit"},{"$ref":"#/components/parameters/XApiFilterFrom"},{"$ref":"#/components/parameters/XApiFilterTo"},{"$ref":"#/components/parameters/XApiFilterOgm"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"},"X-API-NEXT-PAGE":{"$ref":"#/components/headers/XApiNextPage"},"X-API-PAGE":{"$ref":"#/components/headers/XApiPage"},"X-API-PAGE-LIMIT":{"$ref":"#/components/headers/XApiPageLimitResponse"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyDossierRow"}},"example":[{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ogm":"262/1273/93157","ownerReference":"IN146900","reference":"ORDER-73145","currency":"EUR","creditor":"Voorbeeld opdrachtgever B.V.","creditorUuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","creditorReference":"10042","debtor":"Voorbeeld Handel B.V.","debtorUuid":"4d9de86e-5d39-4fef-85a5-055426333625","debtorReference":"KLANT-1042","groupReference":null,"isGroupMaster":false,"dossierClosed":false,"balance":847.5,"status":"open","substatus":"IN_BEHANDELING","updatedAt":"2026-09-01T12:30:00.000Z","workflow":"Zakelijke incasso","meta":[{"uuid":"0f4e5b2a-3c6d-4e7f-8a9b-0c1d2e3f4a5b","name":"ordernummer","value":"73145"}]}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"post":{"operationId":"legacyCreateDossier","tags":["Legacy dossiers"],"summary":"Maak een dossier aan","description":"Maakt een dossier voor een bestaande legacy-debiteur. `reference` mag worden weggelaten als Credifin het dossiernummer moet genereren.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierCreate"},"example":{"reference":"DOS-2026-0042","creditor":"creditor-demo","debtor":"4d9de86e-5d39-4fef-85a5-055426333625","currency":"EUR"}}}},"responses":{"200":{"description":"Dossier aangemaakt.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierCreated"},"example":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"DOS-2026-0042","creditor":"creditor-demo","debtor":"4d9de86e-5d39-4fef-85a5-055426333625","currency":"EUR"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}":{"get":{"operationId":"legacyGetDossier","tags":["Legacy dossiers"],"summary":"Haal een dossier op","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"Het dossier.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossier"},"example":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ogm":"+++123/4567/89012+++","ownerReference":"IN-000042","creditor":"Voorbeeld opdrachtgever B.V.","debtor":"Voorbeeld Handel B.V.","isGroupMaster":false,"dossierClosed":false,"status":"open","substatus":"IN_BEHANDELING","balance":847.5,"updatedAt":"2026-09-01T12:30:00.000Z","workflow":"Zakelijke incasso","meta":[]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/status":{"get":{"operationId":"legacyGetDossierStatus","tags":["Legacy dossiers"],"summary":"Haal de dossierstatus op","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De legacy status en substatus.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierStatus"},"example":{"status":"open","substatus":"IN_BEHANDELING"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/open-amount":{"get":{"operationId":"legacyGetDossierOpenAmount","tags":["Legacy dossiers"],"summary":"Haal het openstaande bedrag op","description":"Retourneert zowel `balance` als het door oudere consumers gebruikte aliasveld `openAmount`, met dezelfde actuele berekening als financial, dossierdetails en dossierlijst.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"Het openstaande bedrag in de valuta van het dossier.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyOpenAmount"},"example":{"balance":"847.50","openAmount":847.5}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/attachment":{"get":{"operationId":"legacyListDossierAttachments","tags":["Legacy documents"],"summary":"Haal de bijlagen van een dossier op","description":"Metadata van alle voor de klant zichtbare bijlagen en van uw eigen uploads.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyAttachment"}},"example":[{"uuid":"d44cb8a4-8e34-4822-a172-cf4cb7b9d622","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","invoice":null,"attachmentName":"overeenkomst.pdf","filename":"overeenkomst.pdf","contentType":"application/pdf","size":48213,"note":"Ondertekende overeenkomst","type":"OTHER","visibility":"public","date":"2026-06-01T10:00:00.000Z"}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"post":{"operationId":"legacyCreateDossierAttachment","tags":["Legacy dossiers"],"summary":"Voeg een bijlage toe aan een dossier","description":"Voegt een bestand toe aan het dossier. Toegestaan zijn pdf, afbeeldingen (ook HEIC), HTML, XML/UBL, EML, MSG, DOCX, XLSX, tekst en csv tot 10 MB, als base64 in `data`. Met `visibility: \"public\"` ziet de debiteur het bestand in het debiteurenportaal; zonder die optie is de bijlage standaard voor u beschikbaar in het klantenportaal en via de API. Expliciet interne bijlagen blijven afgeschermd in het klantenportaal.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"},{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierAttachmentCreate"},"example":{"filename":"overeenkomst.pdf","data":"JVBERi0xLjQKJcTl8uXrCg==","note":"Ondertekende overeenkomst","type":"OTHER","visibility":"public"}}}},"responses":{"200":{"description":"Bijlage opgeslagen.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierAttachmentResult"},"example":{"upload":"success","uuid":"d44cb8a4-8e34-4822-a172-cf4cb7b9d622"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/invoice":{"post":{"operationId":"legacyCreateInvoice","tags":["Legacy invoices"],"summary":"Maak een factuur aan","description":"Geef `dossier` op om een factuur toe te voegen aan een open dossier van uw klant, ook na migratie of sleutelwisseling. Het bestaande traject wordt daarbij niet opnieuw gestart. Met alleen `debtor` wordt het enige open dossier hergebruikt, of een dossier aangemaakt als er geen is. Bij meerdere open dossiers is `dossier` verplicht (HTTP 409); een expliciet onbekend dossier geeft HTTP 404. Minimaal één van beide velden is vereist. De factuurvaluta moet gelijk zijn aan de dossiervaluta. Een onvoltooide aanlevering blijft gekoppeld aan de oorspronkelijke API-client.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyInvoiceCreate"},"examples":{"existingDossier":{"summary":"Factuur in een bestaand dossier","value":{"dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","creditor":"creditor-demo","reference":"INV-2026-0815","date":"2026-12-01","dueDate":"2026-12-31","amount":847.5,"currency":"EUR","invoiceType":"INVOICE"}}}}}},"responses":{"200":{"description":"Factuur aangemaakt.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyInvoice"},"example":{"uuid":"251ab794-7c85-443a-aeb9-44603080dd1d","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"INV-2026-0815","date":"2026-12-01","dueDate":"2026-12-31","amount":847.5,"hasAttachment":false,"meta":[]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/invoice/{invoice}":{"get":{"operationId":"legacyGetInvoice","tags":["Legacy invoices"],"summary":"Haal een factuur op","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/InvoiceId"}],"responses":{"200":{"description":"De factuur.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyInvoice"},"example":{"uuid":"251ab794-7c85-443a-aeb9-44603080dd1d","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"INV-2026-0815","date":"2026-12-01","dueDate":"2026-12-31","amount":847.5,"hasAttachment":true,"meta":[]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/invoice/{invoice}/attachment":{"get":{"operationId":"legacyDownloadInvoiceAttachment","tags":["Legacy invoices"],"summary":"Download het factuurbestand","description":"Net als in CollectOnline levert deze route het bestand zelf (binair), geen JSON. Zonder zichtbaar factuurbestand antwoordt de route met 404.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/InvoiceId"}],"responses":{"200":{"description":"De bestandsinhoud.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"},"Content-Disposition":{"$ref":"#/components/headers/ContentDisposition"}},"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"$ref":"#/components/responses/DocumentStorageUnreachable"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"post":{"operationId":"legacyCreateInvoiceAttachment","tags":["Legacy invoices"],"summary":"Voeg een bijlage toe aan een factuur","description":"Voegt de factuurkopie toe aan een factuur. Toegestaan zijn pdf, afbeeldingen (ook HEIC), HTML, XML/UBL, EML, MSG, DOCX, XLSX, tekst en csv tot 10 MB, als base64 in `data`. Een factuurkopie is voor de debiteur zichtbaar in het debiteurenportaal, net als kopieën die Credifin zelf toevoegt.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/InvoiceId"},{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyAttachmentCreate"},"example":{"filename":"INV-2026-0815.pdf","data":"JVBERi0xLjQKJcTl8uXrCg=="}}}},"responses":{"200":{"description":"Bijlage opgeslagen.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyAttachmentResult"},"example":{"upload":"success"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/v1/dossiers":{"post":{"operationId":"v1CreateDossier","tags":["Dossiers v1"],"summary":"Dien een compleet dossier atomair in","description":"Voorkeursroute voor nieuwe koppelingen. Debiteur, adres, contact, dossier en facturen worden in één transactie verwerkt. Bij een fout wordt niets gedeeltelijk opgeslagen. Een retry met dezelfde `Idempotency-Key` en dezelfde body retourneert dezelfde uitkomst; hergebruik met een andere body geeft HTTP 409. Bijlagen bij het dossier en bij facturen gaan als base64 mee. Extra gegevens zoals polisnummer, kenteken of opzegdatum gaan mee als dossiervelden.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1DossierCreate"},"examples":{"completeDossier":{"summary":"Dossier met één factuur","value":{"reference":"DOS-2026-0042","currency":"EUR","debtor":{"reference":"KLANT-1042","companyName":"Voorbeeld Handel B.V.","companyNumber":"12345678","email":"administratie@voorbeeld.nl","language":"nl","address":{"street":"Keizersgracht","houseNumber":"100","postalCode":"1015CS","city":"Amsterdam","country":"NL"},"contact":{"firstName":"Samira","lastName":"De Vries","email":"samira.devries@voorbeeld.nl","phone":"+31201234567"}},"invoices":[{"reference":"INV-2026-0815","date":"2026-12-01","dueDate":"2026-12-31","amount":847.5}],"meta":[{"name":"polisnummer","value":"POL-2026-1042"},{"name":"kenteken","value":"GF-132-X"},{"name":"polis_ingangsdatum","value":"2026-01-15"},{"name":"opzegdatum","value":"2026-05-01"}]}}}}}},"responses":{"201":{"description":"Het volledige dossier is aangemaakt.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"},"Idempotency-Replayed":{"description":"`true` als deze response uit een eerdere succesvolle aanvraag is herhaald.","schema":{"type":"boolean"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1DossierCreated"},"example":{"dossierId":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"DOS-2026-0042","debtorId":"4d9de86e-5d39-4fef-85a5-055426333625","invoiceIds":["251ab794-7c85-443a-aeb9-44603080dd1d"],"createdAt":"2026-09-01T12:30:00Z"}}}},"400":{"$ref":"#/components/responses/V1BadRequest"},"401":{"$ref":"#/components/responses/V1Unauthorized"},"403":{"$ref":"#/components/responses/V1Forbidden"},"409":{"$ref":"#/components/responses/V1Conflict"},"413":{"$ref":"#/components/responses/V1PayloadTooLarge"},"415":{"$ref":"#/components/responses/V1UnsupportedMediaType"},"422":{"$ref":"#/components/responses/V1UnprocessableEntity"},"429":{"$ref":"#/components/responses/V1RateLimited"},"500":{"$ref":"#/components/responses/V1InternalServerError"},"503":{"$ref":"#/components/responses/V1ServiceUnavailable"}}}},"/api/v1/dossiers/validate":{"post":{"operationId":"v1ValidateDossier","tags":["Dossiers v1"],"summary":"Controleer een dossier zonder het op te slaan","description":"Valideert met dezelfde parser de JSON-structuur en inhoudelijke veldregels van de dossierintake, maar maakt geen debiteur, dossier, factuur, alias of idempotency-record aan. Gebruik deze preflight tijdens implementatie en vóór een productieaanlevering. Een `Idempotency-Key` is niet nodig omdat deze operatie geen dossiergegevens muteert; de echte intake kan nog afwijzen bij een conflict met actuele gegevens.","security":[{"ApiKeyAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1DossierCreate"},"examples":{"completeDossier":{"summary":"Te valideren dossier met één factuur","value":{"reference":"DOS-2026-0042","currency":"EUR","debtor":{"reference":"KLANT-1042","companyName":"Voorbeeld Handel B.V.","language":"nl","address":{"street":"Keizersgracht","houseNumber":"100","postalCode":"1015CS","city":"Amsterdam","country":"NL"}},"invoices":[{"reference":"INV-2026-0815","date":"2026-12-01","dueDate":"2026-12-31","amount":847.5}]}}}}}},"responses":{"200":{"description":"De body is geldig en kan naar de dossierintake worden gestuurd.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1DossierValidationResult"},"example":{"valid":true,"stored":false,"reference":"DOS-2026-0042","debtorReference":"KLANT-1042","currency":"EUR","invoiceCount":1,"attachmentCount":0,"totalAmount":847.5,"message":"Validatie geslaagd. Er is geen dossier opgeslagen."}}}},"400":{"$ref":"#/components/responses/V1BadRequest"},"401":{"$ref":"#/components/responses/V1Unauthorized"},"403":{"$ref":"#/components/responses/V1Forbidden"},"413":{"$ref":"#/components/responses/V1PayloadTooLarge"},"415":{"$ref":"#/components/responses/V1UnsupportedMediaType"},"422":{"$ref":"#/components/responses/V1UnprocessableEntity"},"429":{"$ref":"#/components/responses/V1RateLimited"},"500":{"$ref":"#/components/responses/V1InternalServerError"},"503":{"$ref":"#/components/responses/V1ServiceUnavailable"}}}},"/api/creditor":{"get":{"operationId":"legacyListCreditors","tags":["Legacy creditors"],"summary":"Haal de klanten op waarvoor deze sleutel werkt","description":"Een klantsleutel geeft alleen de eigen opdrachtgever terug. Een agentsleutel geeft alle klanten die op dit moment onder het agentschap vallen, inclusief klanten die vandaag zijn aangemaakt. Gebruik `reference` (het klantnummer) of `uuid` als `creditor` bij het aanleveren van debiteuren, dossiers en facturen.","security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyCreditor"}},"example":[{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V.","email":"administratie@voorbeeld.nl","phone":"+31201234567","address":{"street":"Keizersgracht","houseNumber":"100","postalCode":"1015CS","city":"Amsterdam","country":"NL"},"companyNumber":"12345678","vatNumber":"NL123456789B01","language":"nl","agency":{"uuid":"0f3a6c1d-7b2e-4a8f-9c4d-5e6f7a8b9c0d","name":"Mobiliteitsdiensten"},"createdAt":"2026-09-02T09:15:00.000Z"}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"post":{"operationId":"agencyCreateCreditor","tags":["Legacy creditors"],"summary":"Maak een bedrijf aan onder uw agentschap","description":"Alleen voor agentsleutels met creditors:create en een verplichte Idempotency-Key. Het bedrijf valt automatisch onder de agent; een groepssleutel kiest een eigen vestiging met agencyId. Gebruik dezelfde sleutel en inhoud bij herhalingen. Het antwoord bevat uuid en reference (klantnummer); gebruik één daarvan als creditor bij dossieraanlevering. Er wordt geen login aangemaakt en geen uitnodiging verstuurd. Een gewone agent levert een geldige iban aan; een vestiging gebruikt haar ingestelde uitbetalingsrekening. Bestaande bedrijven worden niet overgenomen. Nieuwe agentsleutels hebben dit recht; bestaande sleutels krijgen het niet automatisch.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["name","vatTreatment"],"properties":{"name":{"type":"string","maxLength":200},"email":{"type":"string","maxLength":254,"description":"Lever email, companyNumber of vatNumber aan voor een betrouwbare identificatie."},"phone":{"type":"string","maxLength":32},"mobile":{"type":"string","maxLength":32},"street":{"type":"string","maxLength":255},"houseNumber":{"type":"string","maxLength":32},"postalCode":{"type":"string","maxLength":20},"city":{"type":"string","maxLength":160},"country":{"type":"string","maxLength":8},"companyNumber":{"type":"string","maxLength":64},"vatNumber":{"type":"string","maxLength":64},"language":{"type":"string","maxLength":16},"iban":{"type":"string","maxLength":64},"bic":{"type":"string","maxLength":16},"vatTreatment":{"type":"string","enum":["vat_21","not_vat_liable","reverse_charge"]},"agencyId":{"type":"string","format":"uuid","description":"Optioneel voor een gewone agent of vestiging. Verplicht voor een groep: de UUID van een eigen directe vestiging."}}},"example":{"name":"Voorbeeldbedrijf B.V.","email":"administratie@example.test","street":"Teststraat","houseNumber":"10","postalCode":"1234 AB","city":"Amsterdam","country":"NL","language":"nl","vatTreatment":"vat_21","iban":"NL91ABNA0417164300"}}}},"responses":{"201":{"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"},"Idempotency-Replayed":{"description":"true bij herhaling van een eerder geslaagde aanvraag.","schema":{"type":"string","enum":["true"]}}},"description":"Bedrijf aangemaakt; identieke herhalingen geven hetzelfde antwoord en Idempotency-Replayed: true.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyCreditor"}}}},"401":{"description":"Ongeldige API-key."},"403":{"description":"Ontbrekende creditors:create, een klantsleutel of een agentschap buiten uw toegang."},"409":{"description":"CUSTOMER_REQUIRES_REVIEW, IDEMPOTENCY_KEY_REUSED of IDEMPOTENCY_IN_PROGRESS."},"422":{"description":"Ongeldige invoer, ontbrekende Idempotency-Key of een ontbrekende of ongeldige uitbetalingsrekening."},"429":{"description":"Aanvraaglimiet bereikt; wacht Retry-After af."},"503":{"description":"CUSTOMER_NUMBERING_UNAVAILABLE: neem contact op met Credifin."}}}},"/api/debtor/{debtor}/address/{debtorAddress}":{"get":{"operationId":"legacyGetDebtorAddress","tags":["Legacy debtors"],"summary":"Haal een adres van een debiteur op","description":"Eén adres, inclusief de vlaggen `default` en `active`.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DebtorId"},{"$ref":"#/components/parameters/DebtorAddressId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDebtorAddress"},"example":{"uuid":"9f4d2b1c-0e7a-4c6b-8d5e-3f2a1b0c9d8e","street":"Keizersgracht","houseNumber":"100","postalCode":"1015CS","city":"Amsterdam","country":"NL","default":true,"active":true}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/debtor/{debtor}/contact/all":{"get":{"operationId":"legacyListAllDebtorContacts","tags":["Legacy debtors"],"summary":"Haal alle contacten van een debiteur op, ook inactieve","description":"Zelfde vorm als `GET /api/debtor/{debtor}/contact`, maar inclusief gedeactiveerde contacten.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DebtorId"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyDebtorContact"}},"example":[{"uuid":"2c8f1a3b-4d5e-4f60-9a7b-8c9d0e1f2a3b","title":"MR","function":"Boekhouder","firstName":"Jan","lastName":"Jansen","phone":"+31201234567","mobile":null,"fax":null,"email":"jan@voorbeeld.nl","default":true,"active":false}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/debtor/{debtor}/contact/{entityContact}":{"get":{"operationId":"legacyGetDebtorContact","tags":["Legacy debtors"],"summary":"Haal een contact van een debiteur op","description":"Eén contactpersoon; `{entityContact}` is de UUID uit de contactenlijst of de eigen `uuid` die bij aanmaken is meegegeven.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DebtorId"},{"$ref":"#/components/parameters/EntityContactId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDebtorContact"},"example":{"uuid":"2c8f1a3b-4d5e-4f60-9a7b-8c9d0e1f2a3b","title":"MR","function":"Boekhouder","firstName":"Jan","lastName":"Jansen","phone":"+31201234567","mobile":null,"fax":null,"email":"jan@voorbeeld.nl","default":true,"active":true}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/debtor/{debtor}/invoice":{"get":{"operationId":"legacyListDebtorInvoices","tags":["Legacy invoices"],"summary":"Haal alle facturen van een debiteur op","description":"Facturen uit alle dossiers van deze debiteur bij uw opdrachtgever, oudste eerst.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DebtorId"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyInvoice"}},"example":[{"uuid":"251ab794-7c85-443a-aeb9-44603080dd1d","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"2026-0417","ogm":null,"date":"2026-06-01","dueDate":"2026-06-15","amount":750,"hasAttachment":true,"meta":[]}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/verification":{"get":{"operationId":"legacyVerifyDossierReference","tags":["Legacy dossiers"],"summary":"Controleer of een klantreferentie al een dossier heeft","description":"Zoekt op uw eigen `reference` of op het Credifin-dossiernummer. Antwoordt altijd met HTTP 200; `exists` zegt of er een dossier is. Handig om dubbele aanlevering te voorkomen.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierReference"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierVerification"},"example":{"reference":"ORDER-73145","exists":true,"dossiers":[{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","status":"open","updatedAt":"2026-09-01T12:30:00.000Z"}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/financial":{"get":{"operationId":"legacyGetDossierFinancial","tags":["Legacy dossiers"],"summary":"Haal het financiële overzicht van een dossier op","description":"Alle facturen, creditnota’s, betalingen, kosten en gerechtskosten plus de scalars `interest` (rente) en `penalty` (incassokosten). `balance` volgt dezelfde actuele berekening als open-amount, dossierdetails en de dossierlijst. Creditnota’s verlagen de rentebasis vanaf hun weergegeven datum: gekoppeld aan hun factuur of anders oudste factuur eerst. Vastgestelde bedragen blijven behouden; wijzigingen of dagelijkse rente kunnen het saldo tussen aanvragen veranderen.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierFinancial"},"example":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","currency":"EUR","balance":847.5,"principal":750,"interest":4.49,"penalty":143.01,"interestKind":"commercial","interestBase":650,"claimAdjusted":false,"totals":{"principal":750,"interest":4.49,"penalty":143.01,"costs":100,"payments":100,"creditnotes":50,"balance":847.5},"invoices":[{"uuid":"251ab794-7c85-443a-aeb9-44603080dd1d","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"2026-0417","ogm":null,"date":"2026-06-01","dueDate":"2026-06-15","amount":750,"hasAttachment":true,"meta":[]}],"creditnotes":[{"uuid":"7d0ca6f2-1a6c-4e3b-9b8d-2f0e5c4a1b23","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","invoice":null,"hasAttachment":false,"reference":"CN-2026-12","date":"2026-06-20","amount":50,"description":"Retour geleverde goederen"}],"payments":[{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-07-03","valueDate":"2026-07-03","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-07-03T09:14:00.000Z"}],"costs":[{"uuid":"5b6c7d8e-9f01-4a23-b456-c789d0e1f2a3","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","type":"OTHER","typeName":"Overige kosten","description":"Adresonderzoek","date":"2026-06-18","periodFrom":null,"periodTo":null,"amount":12.5,"amountVat":0,"vatPercent":0}],"courtcosts":[{"uuid":"e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","type":"DAGV","label":"Dagvaarding","description":null,"date":"2026-08-02","amount":132.4,"amountVat":0,"paidByCreditor":false,"thirdParty":"Gerechtsdeurwaarderskantoor Voorbeeld"}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/entity":{"get":{"operationId":"legacyGetDossierEntity","tags":["Legacy dossiers"],"summary":"Haal de partijen van een dossier op","description":"Partijenlijst in CollectOnline-vorm: debiteur, opdrachtgever en incassobureau.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierEntity"},"example":[{"uuid":"4d9de86e-5d39-4fef-85a5-055426333625","name":"Voorbeeld Handel B.V.","type":"debtor","reference":"KLANT-1042"},{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","name":"Voorbeeld opdrachtgever B.V.","type":"creditor","reference":"10042"}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/interest":{"get":{"operationId":"legacyGetDossierInterest","tags":["Legacy dossiers"],"summary":"Haal de renteopbouw van een dossier op","description":"Wettelijke (handels)rente over de dalende hoofdsom. Het totaal bevat ook vast ingestelde factuurrente; de regels tonen alleen de automatisch berekende rente. Bij een handmatig gecorrigeerde vordering is adjusted true en zijn er geen regels.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierInterest"},"example":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","kind":"commercial","interestKind":"COMMERCIAL","interest":4.49,"base":650,"adjusted":false,"asOf":"2026-09-01","rows":[{"from":"2026-06-15","to":"2026-07-03","days":18,"ratePercent":12.15,"base":750,"interest":4.49}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/indemnification":{"get":{"operationId":"legacyGetDossierIndemnification","tags":["Legacy dossiers"],"summary":"Haal de vrijwaring van een dossier op","description":"Of het dossier onder vrijwaring valt, met de bijbehorende toelichting.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierIndemnification"},"example":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","indemnified":false,"note":null}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/rpv":{"get":{"operationId":"legacyGetDossierRpv","tags":["Legacy dossiers"],"summary":"Haal de rolpremie en verschotten van een dossier op","description":"De kostenposten van het type `RPV` met hun totaal.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierRpv"},"example":{"dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","total":87.5,"costs":[{"uuid":"5b6c7d8e-9f01-4a23-b456-c789d0e1f2a3","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","type":"RPV","typeName":"Rolpremie / verschotten","description":"Verschotten deurwaarder","date":"2026-06-18","periodFrom":null,"periodTo":null,"amount":87.5,"amountVat":0,"vatPercent":0}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/paymentplan":{"get":{"operationId":"legacyGetDossierPaymentPlan","tags":["Legacy dossiers"],"summary":"Haal de lopende betalingsregeling op","description":"De actieve of voorgestelde regeling met haar termijnen. Termijnen dragen zowel de CollectOnline-namen `deadline_at` en `paid_at` als `dueDate` en `paidAt`. Zonder lopende regeling antwoordt deze route met 404.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyPaymentPlan"},"example":{"uuid":"3e4f5a6b-7c8d-4e9f-a0b1-c2d3e4f5a6b7","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","status":"active","period":"monthly","total":847.5,"installment":211.88,"startDate":"2026-09-15","createdAt":"2026-09-01T12:30:00.000Z","payments":[{"uuid":"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d","deadline_at":"2026-09-15","dueDate":"2026-09-15","amount":211.88,"paid":false,"paid_at":null,"paidAt":null}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/meta":{"get":{"operationId":"legacyListDossierMeta","tags":["Legacy dossiers"],"summary":"Haal alle metavelden van een dossier op","description":"Vrije naam-waardeparen die u zelf aan het dossier koppelt, bijvoorbeeld uw ordernummer.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyDossierMeta"}},"example":[{"uuid":"0f4e5b2a-3c6d-4e7f-8a9b-0c1d2e3f4a5b","name":"ordernummer","value":"73145","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038"}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"post":{"operationId":"legacyUpsertDossierMeta","tags":["Legacy dossiers"],"summary":"Zet een metaveld op dit dossier","description":"Zelfde werking als `POST /api/meta`, met het dossier in het pad. Een bestaand veld met dezelfde naam wordt overschreven. Credifin gebruikt deze velden bij het beantwoorden van vragen van de debiteur.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"},{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyMetaCreate"},"example":{"name":"ordernummer","value":"73145"}}}},"responses":{"200":{"description":"Het opgeslagen metaveld.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierMeta"},"example":{"uuid":"0f4e5b2a-3c6d-4e7f-8a9b-0c1d2e3f4a5b","name":"ordernummer","value":"73145","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/meta/{name}":{"get":{"operationId":"legacyGetDossierMeta","tags":["Legacy dossiers"],"summary":"Haal één metaveld van een dossier op","description":"Het metaveld met exact deze naam.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"},{"$ref":"#/components/parameters/MetaName"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierMeta"},"example":{"uuid":"0f4e5b2a-3c6d-4e7f-8a9b-0c1d2e3f4a5b","name":"ordernummer","value":"73145","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/meta/{name}":{"get":{"operationId":"legacyListMetaByName","tags":["Legacy dossiers"],"summary":"Zoek een metaveld over al uw dossiers","description":"Alle dossiers van uw opdrachtgever die een metaveld met deze naam hebben, met het dossier-UUID erbij. Maximaal 500 regels.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/MetaName"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyDossierMeta"}},"example":[{"uuid":"0f4e5b2a-3c6d-4e7f-8a9b-0c1d2e3f4a5b","name":"ordernummer","value":"73145","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038"}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/stage/{stage}":{"get":{"operationId":"legacyGetStage","tags":["Legacy dossiers"],"summary":"Haal een fase op","description":"Naam en volgorde van een dossierfase.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/StageId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyStage"},"example":{"uuid":"6a7b8c9d-0e1f-4a2b-b3c4-d5e6f7a8b9c0","name":"Minnelijk","order":1}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/invoice":{"get":{"operationId":"legacyListDossierInvoices","tags":["Legacy invoices"],"summary":"Haal de facturen van een dossier op","description":"Alle facturen in het dossier, oudste eerst.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyInvoice"}},"example":[{"uuid":"251ab794-7c85-443a-aeb9-44603080dd1d","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"2026-0417","ogm":null,"date":"2026-06-01","dueDate":"2026-06-15","amount":750,"hasAttachment":true,"meta":[]}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/invoice/{invoice}/interest":{"get":{"operationId":"legacyGetInvoiceInterest","tags":["Legacy invoices"],"summary":"Haal de renteopbouw van een factuur op","description":"Bruto renteopbouw vanaf de vervaldatum, of het met PUT ingestelde vaste rentebedrag. Bij vaste rente is adjusted true en zijn rows leeg. Bestaande dossierafspraken blijven leidend. paymentsApplied is false: gebruik GET /api/dossier/{dossier}/interest voor de netto rente op dossierniveau.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/InvoiceId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyInvoiceInterest"},"example":{"uuid":"251ab794-7c85-443a-aeb9-44603080dd1d","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","kind":"commercial","interest":19.38,"from":"2026-06-15","asOf":"2026-09-01","adjusted":false,"paymentsApplied":false,"rows":[{"from":"2026-06-15","to":"2026-09-01","days":78,"ratePercent":12.15,"base":750,"interest":19.38}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"put":{"operationId":"legacySetInvoiceInterest","tags":["Legacy invoices"],"summary":"Stel een vast rentebedrag op een factuur in","description":"`amount` is een absoluut eurobedrag, geen percentage en geen bijboeking. Vereist dossiers:create. Idempotency-Key is optioneel; stuur per wijziging een unieke sleutel mee om retries na een latere wijziging te herkennen. Zonder sleutel wordt elk verzoek als een nieuwe absolute instelling verwerkt. Het vervangt de automatische rente van deze factuur en werkt door in het dossiersaldo; overige facturen blijven rente opbouwen. Betalingen verlagen de hoofdsom op volgorde van vervaldatum. Een gesloten dossier, kosteloos WIK-traject, uitgesloten rente of handmatig vastgestelde vordering geeft 409; deze afspraken worden niet overschreven.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"invoice","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyInvoiceInterestUpdate"},"example":{"amount":2}}}},"responses":{"200":{"description":"De ingestelde rente.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyInvoiceInterestSetResult"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/creditnote":{"get":{"operationId":"legacyListDossierCreditNotes","tags":["Legacy finance"],"summary":"Haal de creditnota’s van een dossier op","description":"Alle creditnota’s die de hoofdsom van dit dossier verlagen.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyCreditNote"}},"example":[{"uuid":"7d0ca6f2-1a6c-4e3b-9b8d-2f0e5c4a1b23","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","invoice":null,"hasAttachment":false,"reference":"CN-2026-12","date":"2026-06-20","amount":50,"description":"Retour geleverde goederen"}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/creditnote/{creditNote}":{"get":{"operationId":"legacyGetCreditNote","tags":["Legacy finance"],"summary":"Haal een creditnota op","description":"Eén creditnota binnen de dossiers van uw opdrachtgever.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/CreditNoteId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyCreditNote"},"example":{"uuid":"7d0ca6f2-1a6c-4e3b-9b8d-2f0e5c4a1b23","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","invoice":null,"hasAttachment":false,"reference":"CN-2026-12","date":"2026-06-20","amount":50,"description":"Retour geleverde goederen"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/payment":{"get":{"operationId":"legacyListDossierPayments","tags":["Legacy finance"],"summary":"Haal de betalingen van een dossier op","description":"Alle op het dossier geboekte betalingen. `receivedBy` zegt of het geld op de derdengeldenrekening van Credifin (`OWN_ACCOUNT`) of rechtstreeks bij u (`CLIENT`) is ontvangen; `iban` is alleen gevuld bij ontvangst op de derdengeldenrekening.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyPayment"}},"example":[{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-07-03","valueDate":"2026-07-03","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-07-03T09:14:00.000Z"}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/payment/{payment}":{"get":{"operationId":"legacyGetPayment","tags":["Legacy finance"],"summary":"Haal een betaling op","description":"Eén betaling binnen de dossiers van uw opdrachtgever.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/PaymentId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyPayment"},"example":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-07-03","valueDate":"2026-07-03","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-07-03T09:14:00.000Z"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/cost":{"get":{"operationId":"legacyListDossierCosts","tags":["Legacy finance"],"summary":"Haal de kostenposten van een dossier op","description":"Alle kostenposten op het dossier. Rente staat hier niet tussen; die wordt live berekend en staat in `GET /api/dossier/{dossier}/interest`.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyCost"}},"example":[{"uuid":"5b6c7d8e-9f01-4a23-b456-c789d0e1f2a3","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","type":"OTHER","typeName":"Overige kosten","description":"Adresonderzoek","date":"2026-06-18","periodFrom":null,"periodTo":null,"amount":12.5,"amountVat":0,"vatPercent":0}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier-cost/{cost}":{"get":{"operationId":"legacyGetCost","tags":["Legacy finance"],"summary":"Haal een kostenpost op","description":"Eén kostenpost binnen de dossiers van uw opdrachtgever.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/CostId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyCost"},"example":{"uuid":"5b6c7d8e-9f01-4a23-b456-c789d0e1f2a3","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","type":"OTHER","typeName":"Overige kosten","description":"Adresonderzoek","date":"2026-06-18","periodFrom":null,"periodTo":null,"amount":12.5,"amountVat":0,"vatPercent":0}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier-cost/type":{"get":{"operationId":"legacyListCostTypes","tags":["Legacy finance"],"summary":"Haal de kostentypen op","description":"De vaste lijst kostentypen die in `type` van een kostenpost kan voorkomen.","security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyCostType"}},"example":[{"uuid":"OTHER","name":"Overige kosten"},{"uuid":"RPV","name":"Rolpremie / verschotten"}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier-cost/type/{costType}":{"get":{"operationId":"legacyGetCostType","tags":["Legacy finance"],"summary":"Haal een kostentype op","description":"Eén kostentype op code.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/CostTypeId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyCostType"},"example":{"uuid":"RPV","name":"Rolpremie / verschotten"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/court-cost":{"get":{"operationId":"legacyListDossierCourtCosts","tags":["Legacy finance"],"summary":"Haal de gerechtskosten van een dossier op","description":"Gerechtskosten en deurwaarderskosten die in het gerechtelijke traject zijn gemaakt.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DossierId"}],"responses":{"200":{"description":"De lijst.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyCourtCost"}},"example":[{"uuid":"e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","type":"DAGV","label":"Dagvaarding","description":null,"date":"2026-08-02","amount":132.4,"amountVat":0,"paidByCreditor":false,"thirdParty":"Gerechtsdeurwaarderskantoor Voorbeeld"}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/attachment/{attachment}":{"get":{"operationId":"legacyGetDossierAttachment","tags":["Legacy documents"],"summary":"Haal de gegevens van een bijlage op","description":"Metadata van één bijlage. Download de inhoud via `GET /api/dossier/attachment/{attachment}/download`.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/AttachmentId"}],"responses":{"200":{"description":"De resource.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyAttachment"},"example":{"uuid":"d44cb8a4-8e34-4822-a172-cf4cb7b9d622","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","invoice":null,"attachmentName":"overeenkomst.pdf","filename":"overeenkomst.pdf","contentType":"application/pdf","size":48213,"note":"Ondertekende overeenkomst","type":"OTHER","visibility":"public","date":"2026-06-01T10:00:00.000Z"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/attachment/{attachment}/download":{"get":{"operationId":"legacyDownloadDossierAttachment","tags":["Legacy documents"],"summary":"Download een bijlage","description":"De bestandsinhoud met `Content-Type` en `Content-Disposition`. Alleen voor de klant vrijgegeven documenten en uw eigen uploads zijn bereikbaar.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/AttachmentId"}],"responses":{"200":{"description":"De bestandsinhoud.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"},"Content-Disposition":{"$ref":"#/components/headers/ContentDisposition"}},"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"$ref":"#/components/responses/DocumentStorageUnreachable"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/payment":{"post":{"operationId":"legacyReportPayment","tags":["Legacy finance"],"summary":"Meld een betaling die u zelf heeft ontvangen","description":"Registreert een rechtstreekse betaling van de debiteur aan u. Het dossiersaldo, een lopende regeling en een eventuele afrekening worden direct bijgewerkt en uw behandelaar krijgt een melding. Betalingen op de derdengeldenrekening boekt Credifin zelf; `receivedBy` mag daarom alleen `CLIENT` zijn. Werkt op elk open dossier van uw opdrachtgever, ook op dossiers uit CollectOnline.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyPaymentCreate"},"example":{"dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","amount":100,"date":"2026-07-03","reference":"Bankafschrift 2026-118"}}}},"responses":{"200":{"description":"De geboekte betaling.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyPayment"},"example":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"Bankafschrift 2026-118","date":"2026-07-03","valueDate":"2026-07-03","amount":100,"iban":null,"receivedBy":"CLIENT","status":"matched","source":"manual","sender":null,"note":null,"createdAt":"2026-07-03T09:14:00.000Z"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/creditnote":{"post":{"operationId":"legacyCreateCreditNote","tags":["Legacy finance"],"summary":"Voeg een creditnota toe aan een dossier","description":"Verlaagt de hoofdsom van het dossier met het creditbedrag. Rente en incassokosten worden opnieuw berekend; uw behandelaar krijgt een melding. Niet mogelijk op een gesloten dossier.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyCreditNoteCreate"},"example":{"dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"CN-2026-12","amount":50,"date":"2026-06-20","description":"Retour geleverde goederen"}}}},"responses":{"200":{"description":"De vastgelegde creditnota.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyCreditNote"},"example":{"uuid":"7d0ca6f2-1a6c-4e3b-9b8d-2f0e5c4a1b23","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"CN-2026-12","date":"2026-06-20","amount":50,"description":"Retour geleverde goederen"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier-cost":{"post":{"operationId":"legacyCreateCost","tags":["Legacy finance"],"summary":"Voeg een kostenpost toe aan een dossier","description":"Legt kosten vast die u contractueel bij de debiteur in rekening mag brengen, altijd van het type `OTHER`. Rente, incassokosten en gerechtskosten beheert Credifin. Uw behandelaar beoordeelt de post; niet mogelijk op een gesloten dossier.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyCostCreate"},"example":{"dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","amount":12.5,"description":"Contractuele administratiekosten","date":"2026-06-18"}}}},"responses":{"200":{"description":"De vastgelegde kostenpost.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyCost"},"example":{"uuid":"5b6c7d8e-9f01-4a23-b456-c789d0e1f2a3","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","type":"OTHER","typeName":"Overige kosten","description":"Contractuele administratiekosten","date":"2026-06-18","periodFrom":null,"periodTo":"2026-06-18","amount":12.5,"amountVat":0,"vatPercent":0}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/meta":{"post":{"operationId":"legacyUpsertMeta","tags":["Legacy dossiers"],"summary":"Zet een metaveld op een dossier","description":"Maakt het metaveld aan of overschrijft de waarde als de naam al bestaat. Sommige namen zijn gereserveerd voor Credifin.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyMetaCreateWithDossier"},"example":{"dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","name":"ordernummer","value":"73145"}}}},"responses":{"200":{"description":"Het opgeslagen metaveld.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierMeta"},"example":{"uuid":"0f4e5b2a-3c6d-4e7f-8a9b-0c1d2e3f4a5b","name":"ordernummer","value":"73145","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/group":{"put":{"operationId":"legacySetDossierGroup","tags":["Legacy dossiers"],"summary":"Groepeer dossiers onder één groepsreferentie","description":"Zet `groupReference` op alle opgegeven dossiers en markeert één dossier als `isGroupMaster`. Alle dossiers moeten van uw opdrachtgever zijn; anders wordt niets gewijzigd.","security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierGroupSet"},"example":{"reference":"GROEP-2026-07","master":"c3069230-ff95-4c95-aa73-9c57945ae038","dossiers":["c3069230-ff95-4c95-aa73-9c57945ae038","1f2e3d4c-5b6a-4798-8a9b-0c1d2e3f4a5b"]}}}},"responses":{"200":{"description":"De dossiers in de groep.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyDossierGroup"},"example":{"reference":"GROEP-2026-07","dossiers":[{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","groupReference":"GROEP-2026-07","isGroupMaster":true},{"uuid":"1f2e3d4c-5b6a-4798-8a9b-0c1d2e3f4a5b","ownerReference":"IN146901","groupReference":"GROEP-2026-07","isGroupMaster":false}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dossier/{dossier}/status/history":{"get":{"operationId":"legacyDossierStatusHistory","tags":["Legacy dossiers"],"summary":"Lees de statushistorie van een dossier","description":"Nieuwste eerst. timestamp is het werkelijke statusmoment in Europe/Amsterdam (YYYY-MM-DD HH:mm), niet de importdatum. Alleen aantoonbare statuswissels worden getoond; zonder historie volgt een lege lijst. lost is afboeken, closed is positief sluiten. Interne opmerkingen worden niet gedeeld. Vereist dossiers:read.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"dossier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Statuswissels.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegacyStatusHistoryRow"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/creditnote/{creditNote}/attachment":{"post":{"operationId":"legacyCreditNoteAttachment","tags":["Legacy documents"],"summary":"Upload een creditnota-PDF","description":"Koppelt de bijlage aan de creditnota en het dossier, zonder het creditbedrag te wijzigen. JSON met filename en base64 data, maximaal 10 MB, inhoudscontrole en virusscan zoals bij factuurbijlagen. Vereist dossiers:create. Werkt op open dossiers binnen uw klantscope; gesloten dossiers geven 409.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"creditNote","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/LegacyIdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyAttachmentCreate"},"example":{"filename":"creditnota.pdf","data":"<base64-encoded-pdf>"}}}},"responses":{"200":{"description":"Bijlage opgeslagen.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyAttachmentResult"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"get":{"operationId":"legacyDownloadCreditNoteAttachment","tags":["Legacy documents"],"summary":"Download een creditnotabijlage","description":"Download een creditnotabijlage","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"creditNote","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"De bestandsinhoud.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset"},"Content-Disposition":{"$ref":"#/components/headers/ContentDisposition"}},"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"$ref":"#/components/responses/DocumentStorageUnreachable"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}}},"webhooks":{"dossier.created":{"post":{"operationId":"webhook_dossier_created","summary":"Dossier aangemaakt","description":"Een nieuw dossier is voor u geopend. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"dossier.created","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"dossier.status.changed":{"post":{"operationId":"webhook_dossier_status_changed","summary":"Statuswijziging","description":"De status of substatus van een dossier is gewijzigd, inclusief sluiten. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"dossier.status.changed","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"dossier.paid":{"post":{"operationId":"webhook_dossier_paid","summary":"Hoofdsom voldaan","description":"Het openstaande saldo van een dossier is op nul gekomen. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"dossier.paid","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"paymentplan.created":{"post":{"operationId":"webhook_paymentplan_created","summary":"Regeling","description":"Er is een betalingsregeling vastgelegd. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"paymentplan.created","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"note.added":{"post":{"operationId":"webhook_note_added","summary":"Dossierbericht","description":"Een behandelaar heeft een voor u zichtbaar bericht in het dossier gezet. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"note.added","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"payment.received":{"post":{"operationId":"webhook_payment_received","summary":"Betaling","description":"Er is een betaling op het dossier geboekt, bij Credifin of bij u. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"payment.received","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"invoice.created":{"post":{"operationId":"webhook_invoice_created","summary":"Factuur toegevoegd","description":"Een factuur is aan het dossier toegevoegd. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"invoice.created","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"creditnote.created":{"post":{"operationId":"webhook_creditnote_created","summary":"Creditnota","description":"Een creditnota is op het dossier geboekt. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"creditnote.created","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"cost.created":{"post":{"operationId":"webhook_cost_created","summary":"Kosten","description":"Een kostenpost is aan het dossier toegevoegd. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"cost.created","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"courtcost.created":{"post":{"operationId":"webhook_courtcost_created","summary":"Gerechtskosten","description":"Gerechtskosten zijn op het dossier geboekt. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"courtcost.created","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"communication.sent":{"post":{"operationId":"webhook_communication_sent","summary":"Bericht verzonden","description":"Credifin heeft de debiteur een e-mail, brief of sms gestuurd. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"communication.sent","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"communication.received":{"post":{"operationId":"webhook_communication_received","summary":"Inkomende e-mail","description":"De debiteur heeft gereageerd per e-mail. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"communication.received","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"phone.call":{"post":{"operationId":"webhook_phone_call","summary":"Telefonische actie","description":"Er is een telefoongesprek met de debiteur gevoerd of geprobeerd. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"phone.call","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"debtor.updated":{"post":{"operationId":"webhook_debtor_updated","summary":"Debiteur gewijzigd","description":"De gegevens van een debiteur zijn gewijzigd. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"debtor.updated","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"debtor.contact.updated":{"post":{"operationId":"webhook_debtor_contact_updated","summary":"Debiteurcontact gewijzigd","description":"Een adres of contactpersoon van een debiteur is gewijzigd. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"debtor.contact.updated","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"creditor.created":{"post":{"operationId":"webhook_creditor_created","summary":"Klant aangemaakt (alleen agenten)","description":"Er is een nieuwe klant onder uw agentschap aangemaakt. `data` bevat uuid, klantnummer, naam, contactgegevens, adres en het agentschap. Alleen beschikbaar voor webhooks van een agent. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"creditor.created","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}},"webhook.test":{"post":{"operationId":"webhook_webhook_test","summary":"Testmelding","description":"Handmatig verstuurd vanuit het klantportaal om de ontvanger te controleren. Credifin POST de envelop naar uw geregistreerde URL met de headers `Credifin-Event`, `Credifin-Event-Id`, `Credifin-Delivery-Id`, `Credifin-Timestamp` en `Credifin-Signature`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEnvelope"},"example":{"id":"5f1c4a2b-0d3e-4f6a-9b8c-7d6e5f4a3b2c","type":"webhook.test","version":1,"occurredAt":"2026-09-01T12:30:00.000Z","createdAt":"2026-09-01T12:31:04.000Z","delivery":{"id":"e7c1b2a3-4d5e-4f60-8a7b-9c0d1e2f3a4b","attempt":1},"creditor":{"uuid":"b1a7c8e2-1234-4f5a-8b9d-123456789abc","reference":"106861","name":"Voorbeeld B.V."},"agency":null,"dossier":{"uuid":"c3069230-ff95-4c95-aa73-9c57945ae038","ownerReference":"IN146900","reference":"ORDER-73145","ogm":"262/1273/93157","currency":"EUR","status":"open","substatus":"IN_BEHANDELING","dossierClosed":false,"balance":747.5,"createdAt":"2026-06-01T10:00:00.000Z"},"data":{"uuid":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9","dossier":"c3069230-ff95-4c95-aa73-9c57945ae038","reference":"262/1273/93157","date":"2026-09-01","valueDate":"2026-09-01","amount":100,"iban":"NL02ABNA0123456789","receivedBy":"OWN_ACCOUNT","status":"matched","source":"bank","sender":"Voorbeeld Handel B.V.","note":null,"createdAt":"2026-09-01T12:30:00.000Z"}}}}},"responses":{"2XX":{"description":"Uw ontvanger bevestigt de melding. Elke andere status wordt als mislukt beschouwd en opnieuw geprobeerd."}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"Klantgebonden API-key. Verstuur de sleutel uitsluitend via HTTPS en log hem niet."}},"headers":{"XApiNextPage":{"description":"Het volgende paginanummer, of leeg als dit de laatste pagina is.","schema":{"type":"string"},"example":"2"},"XApiPage":{"description":"Het paginanummer van deze response.","schema":{"type":"integer","minimum":1},"example":1},"XApiPageLimitResponse":{"description":"Het toegepaste maximum aantal rijen per pagina.","schema":{"type":"integer","minimum":1,"maximum":200},"example":20},"ContentDisposition":{"description":"Bestandsnaam van de download als `attachment`.","schema":{"type":"string"},"example":"attachment; filename=\"overeenkomst.pdf\""},"XRateLimitLimit":{"description":"Maximum aantal aanvragen binnen het huidige limietvenster.","schema":{"type":"integer","minimum":1},"example":120},"XRateLimitRemaining":{"description":"Aantal aanvragen dat binnen het huidige limietvenster resteert.","schema":{"type":"integer","minimum":0},"example":119},"XRateLimitReset":{"description":"Aantal seconden totdat het huidige limietvenster opnieuw begint.","schema":{"type":"integer","minimum":0},"example":60}},"parameters":{"XApiNextPage":{"name":"X-API-NEXT-PAGE","in":"header","required":false,"description":"Gevraagde pagina; de eerste pagina is 1. Ook beschikbaar als querystring `page`.","schema":{"type":"integer","minimum":1,"default":1},"example":1},"XApiPageLimit":{"name":"X-API-PAGE-LIMIT","in":"header","required":false,"description":"Maximaal aantal rijen per pagina (standaard 20, maximaal 200). Ook beschikbaar als querystring `limit`.","schema":{"type":"integer","minimum":1,"maximum":200,"default":20},"example":50},"XApiFilterFrom":{"name":"X-API-FILTER-FROM","in":"header","required":false,"description":"Alleen dossiers gewijzigd op of na dit moment, als `yyyy-MM-dd HH:mm:ss` in Nederlandse tijd. Ook beschikbaar als querystring `from`.","schema":{"type":"string"},"example":"2026-09-01 00:00:00"},"XApiFilterTo":{"name":"X-API-FILTER-TO","in":"header","required":false,"description":"Alleen dossiers gewijzigd op of vóór dit moment, als `yyyy-MM-dd HH:mm:ss` in Nederlandse tijd. Ook beschikbaar als querystring `to`.","schema":{"type":"string"},"example":"2026-09-30 23:59:59"},"XApiFilterOgm":{"name":"X-API-FILTER-OGM","in":"header","required":false,"description":"Filter op betalingskenmerk, geschreven als `ddd/dddd/ddddd` of als twaalf cijfers. Ook beschikbaar als querystring `ogm`.","schema":{"type":"string","maxLength":40},"example":"262/1273/93157"},"DossierReference":{"name":"dossier","in":"path","required":true,"description":"Uw eigen klantreferentie of het Credifin-dossiernummer.","schema":{"type":"string","maxLength":255},"example":"ORDER-73145"},"DebtorAddressId":{"name":"debtorAddress","in":"path","required":true,"description":"UUID van het adres uit de adressenlijst.","schema":{"type":"string","format":"uuid"},"example":"9f4d2b1c-0e7a-4c6b-8d5e-3f2a1b0c9d8e"},"EntityContactId":{"name":"entityContact","in":"path","required":true,"description":"UUID van het contact, of de eigen `uuid` die u bij aanmaken meegaf.","schema":{"type":"string","maxLength":255},"example":"2c8f1a3b-4d5e-4f60-9a7b-8c9d0e1f2a3b"},"MetaName":{"name":"name","in":"path","required":true,"description":"Naam van het metaveld.","schema":{"type":"string","maxLength":255},"example":"ordernummer"},"StageId":{"name":"stage","in":"path","required":true,"description":"UUID van de fase.","schema":{"type":"string","format":"uuid"},"example":"6a7b8c9d-0e1f-4a2b-b3c4-d5e6f7a8b9c0"},"CreditNoteId":{"name":"creditNote","in":"path","required":true,"description":"UUID van de creditnota.","schema":{"type":"string","format":"uuid"},"example":"7d0ca6f2-1a6c-4e3b-9b8d-2f0e5c4a1b23"},"PaymentId":{"name":"payment","in":"path","required":true,"description":"UUID van de betaling.","schema":{"type":"string","format":"uuid"},"example":"a9c3d4e5-6f70-4a81-b2c3-d4e5f6a7b8c9"},"CostId":{"name":"cost","in":"path","required":true,"description":"UUID van de kostenpost.","schema":{"type":"string","format":"uuid"},"example":"5b6c7d8e-9f01-4a23-b456-c789d0e1f2a3"},"CostTypeId":{"name":"costType","in":"path","required":true,"description":"Code van het kostentype.","schema":{"type":"string","enum":["INTEREST","COLLECTION_FEE","COURT_COST","RPV","CLIENT_COST","OTHER"]},"example":"RPV"},"AttachmentId":{"name":"attachment","in":"path","required":true,"description":"UUID van de bijlage uit de bijlagenlijst of uit de uploadresponse.","schema":{"type":"string","format":"uuid"},"example":"d44cb8a4-8e34-4822-a172-cf4cb7b9d622"},"DebtorId":{"name":"debtor","in":"path","required":true,"description":"Opaque debiteur-UUID uit een eerdere legacy-response.","schema":{"type":"string","format":"uuid"},"example":"4d9de86e-5d39-4fef-85a5-055426333625"},"DossierId":{"name":"dossier","in":"path","required":true,"description":"Opaque dossier-UUID uit een eerdere legacy-response.","schema":{"type":"string","format":"uuid"},"example":"c3069230-ff95-4c95-aa73-9c57945ae038"},"InvoiceId":{"name":"invoice","in":"path","required":true,"description":"Opaque factuur-UUID uit een eerdere legacy-response.","schema":{"type":"string","format":"uuid"},"example":"251ab794-7c85-443a-aeb9-44603080dd1d"},"LegacyIdempotencyKey":{"name":"Idempotency-Key","in":"header","required":false,"description":"Aanbevolen unieke sleutel per mutatie. Dezelfde sleutel met dezelfde body mag veilig opnieuw worden verstuurd. Optioneel om bestaande legacy-clients niet te breken.","schema":{"type":"string","minLength":8,"maxLength":200},"example":"legacy-order-73145-debtor"},"IdempotencyKey":{"name":"Idempotency-Key","in":"header","required":true,"description":"Unieke sleutel per logische aanvraag. Bewaar en hergebruik deze sleutel bij time-outs en netwerkretries.","schema":{"type":"string","minLength":8,"maxLength":200},"example":"order-73145-dossier-v1"}},"responses":{"DocumentStorageUnreachable":{"description":"De documentopslag is tijdelijk niet bereikbaar; probeer het later opnieuw.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyErrorEnvelope"},"example":{"error":{"code":"DOCUMENT_STORAGE_UNREACHABLE","message":"De documentopslag is tijdelijk niet bereikbaar.","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":true}}}}},"BadRequest":{"description":"De aanvraag is syntactisch ongeldig.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyErrorEnvelope"},"example":{"error":{"code":"INVALID_REQUEST","message":"De JSON-body kon niet worden verwerkt.","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}}},"Unauthorized":{"description":"De `Api-Key` ontbreekt of is ongeldig.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyErrorEnvelope"},"example":{"error":{"code":"UNAUTHORIZED","message":"Een geldige Api-Key is vereist.","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}}},"Forbidden":{"description":"De API-key heeft geen toegang tot deze klant of resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyErrorEnvelope"},"example":{"error":{"code":"FORBIDDEN","message":"Deze API-key mag deze resource niet benaderen.","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}}},"NotFound":{"description":"De resource bestaat niet binnen de scope van deze API-key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyErrorEnvelope"},"example":{"error":{"code":"NOT_FOUND","message":"De gevraagde resource is niet gevonden.","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}}},"Conflict":{"description":"Conflict, bijvoorbeeld een dubbele referentie of hergebruikte idempotency-key met een andere body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyErrorEnvelope"},"example":{"error":{"code":"IDEMPOTENCY_KEY_REUSED","message":"Deze Idempotency-Key is eerder met een andere body gebruikt.","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}}},"PayloadTooLarge":{"description":"De aanvraag of base64-bijlage is groter dan toegestaan.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyErrorEnvelope"},"example":{"error":{"code":"PAYLOAD_TOO_LARGE","message":"De bijlage overschrijdt de toegestane grootte.","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}}},"UnsupportedMediaType":{"description":"Content-Type of bestandstype wordt niet ondersteund.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyErrorEnvelope"},"example":{"error":{"code":"UNSUPPORTED_MEDIA_TYPE","message":"Dit media- of bestandstype wordt niet ondersteund.","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}}},"UnprocessableEntity":{"description":"De JSON is geldig, maar één of meer velden voldoen niet aan het contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyErrorEnvelope"},"example":{"error":{"code":"VALIDATION_FAILED","message":"De aanvraag bevat ongeldige velden.","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}}},"RateLimited":{"description":"Te veel aanvragen. Wacht de aangegeven periode en probeer opnieuw.","headers":{"Retry-After":{"description":"Aantal seconden voordat een retry wordt geadviseerd.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyErrorEnvelope"},"example":{"error":{"code":"RATE_LIMITED","message":"Probeer de aanvraag later opnieuw.","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":true}}}}},"InternalServerError":{"description":"Onverwachte fout. Gebruik dezelfde idempotency-key bij een veilige retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyErrorEnvelope"},"example":{"error":{"code":"INTERNAL_ERROR","message":"De aanvraag kon niet worden afgerond.","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":true}}}}},"ServiceUnavailable":{"description":"De optionele functie is nog niet voor productie vrijgegeven.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyErrorEnvelope"},"example":{"error":{"code":"ATTACHMENTS_TEMPORARILY_UNAVAILABLE","message":"Bijlagen via de API zijn nog niet vrijgegeven.","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}}},"V1BadRequest":{"description":"De JSON-body kon niet worden verwerkt.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/V1ProblemDetails"},"example":{"type":"https://api.credifin.nl/problems/invalid-request","title":"Ongeldige aanvraag","status":400,"detail":"De JSON-body kon niet worden verwerkt.","code":"INVALID_REQUEST","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}},"V1Unauthorized":{"description":"Een geldige Api-Key is vereist.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/V1ProblemDetails"},"example":{"type":"https://api.credifin.nl/problems/unauthorized","title":"Niet geauthenticeerd","status":401,"detail":"Een geldige Api-Key is vereist.","code":"UNAUTHORIZED","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}},"V1Forbidden":{"description":"Deze API-key mag deze resource niet benaderen.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/V1ProblemDetails"},"example":{"type":"https://api.credifin.nl/problems/forbidden","title":"Geen toegang","status":403,"detail":"Deze API-key mag deze resource niet benaderen.","code":"FORBIDDEN","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}},"V1Conflict":{"description":"Deze Idempotency-Key is eerder met een andere body gebruikt.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/V1ProblemDetails"},"example":{"type":"https://api.credifin.nl/problems/idempotency-key-reused","title":"Conflict","status":409,"detail":"Deze Idempotency-Key is eerder met een andere body gebruikt.","code":"IDEMPOTENCY_KEY_REUSED","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}},"V1PayloadTooLarge":{"description":"De aanvraag of bijlage overschrijdt de toegestane grootte.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/V1ProblemDetails"},"example":{"type":"https://api.credifin.nl/problems/payload-too-large","title":"Aanvraag te groot","status":413,"detail":"De aanvraag of bijlage overschrijdt de toegestane grootte.","code":"PAYLOAD_TOO_LARGE","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}},"V1UnsupportedMediaType":{"description":"Dit media- of bestandstype wordt niet ondersteund.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/V1ProblemDetails"},"example":{"type":"https://api.credifin.nl/problems/unsupported-media-type","title":"Niet-ondersteund mediatype","status":415,"detail":"Dit media- of bestandstype wordt niet ondersteund.","code":"UNSUPPORTED_MEDIA_TYPE","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}},"V1UnprocessableEntity":{"description":"De aanvraag bevat ongeldige velden.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/V1ProblemDetails"},"example":{"type":"https://api.credifin.nl/problems/validation-failed","title":"Validatiefout","status":422,"detail":"De aanvraag bevat ongeldige velden.","code":"VALIDATION_FAILED","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}},"V1RateLimited":{"description":"Probeer de aanvraag later opnieuw.","headers":{"Retry-After":{"description":"Aantal seconden voordat een retry wordt geadviseerd.","schema":{"type":"integer","minimum":1}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/V1ProblemDetails"},"example":{"type":"https://api.credifin.nl/problems/rate-limited","title":"Te veel aanvragen","status":429,"detail":"Probeer de aanvraag later opnieuw.","code":"RATE_LIMITED","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":true}}}},"V1InternalServerError":{"description":"De aanvraag kon niet worden afgerond.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/V1ProblemDetails"},"example":{"type":"https://api.credifin.nl/problems/internal-error","title":"Interne fout","status":500,"detail":"De aanvraag kon niet worden afgerond.","code":"INTERNAL_ERROR","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":true}}}},"V1ServiceUnavailable":{"description":"Bijlagen via de API zijn nog niet vrijgegeven.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/V1ProblemDetails"},"example":{"type":"https://api.credifin.nl/problems/attachments-temporarily-unavailable","title":"Functie niet beschikbaar","status":503,"detail":"Bijlagen via de API zijn nog niet vrijgegeven.","code":"ATTACHMENTS_TEMPORARILY_UNAVAILABLE","requestId":"req_01J6P4NAZG68Y9JVX0TB3JCB58","retryable":false}}}}},"schemas":{"LegacyCreditor":{"type":"object","description":"Een klant (opdrachtgever) waarvoor de sleutel werkt.","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van de klant."},"reference":{"type":["string","null"],"description":"Klantnummer bij Credifin; te gebruiken als `creditor` bij het aanleveren."},"name":{"type":"string"},"email":{"type":["string","null"],"description":"E-mailadres van de klant."},"phone":{"type":["string","null"],"description":"Telefoonnummer van de klant."},"address":{"type":"object","properties":{"street":{"type":["string","null"],"description":"Straat."},"houseNumber":{"type":["string","null"],"description":"Huisnummer."},"postalCode":{"type":["string","null"],"description":"Postcode."},"city":{"type":["string","null"],"description":"Plaats."},"country":{"type":"string","description":"ISO 3166-1 alpha-2."}}},"companyNumber":{"type":["string","null"],"description":"KVK- of ondernemingsnummer."},"vatNumber":{"type":["string","null"],"description":"Btw-nummer."},"language":{"type":"string","description":"Correspondentietaal (nl, en, de, fr)."},"agency":{"type":["object","null"],"description":"Het agentschap waar de klant onder valt.","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van het agentschap."},"name":{"type":"string"}}},"createdAt":{"type":"string","format":"date-time"}},"required":["uuid","reference","name","address","agency","createdAt"]},"LegacyDossierRow":{"type":"object","description":"Dossierregel uit de lijst; dezelfde velden als `LegacyDossier` plus de partij-identifiers.","allOf":[{"$ref":"#/components/schemas/LegacyDossier"},{"type":"object","properties":{"reference":{"type":["string","null"],"description":"Uw eigen klantreferentie."},"currency":{"type":"string","description":"ISO 4217 valutacode."},"creditorUuid":{"type":"string","format":"uuid","description":"UUID van uw opdrachtgever."},"creditorReference":{"type":["string","null"],"description":"Klantnummer van uw opdrachtgever bij Credifin."},"debtorUuid":{"type":"string","format":"uuid","description":"UUID van de debiteur; bruikbaar in `GET /api/debtor/{debtor}`."},"debtorReference":{"type":["string","null"],"description":"Uw referentie van de debiteur."},"meta":{"type":"array","items":{"$ref":"#/components/schemas/LegacyMetaItem"}}}}]},"LegacyMetaItem":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van het metaveld."},"name":{"type":"string"},"value":{"type":"string"}},"required":["uuid","name","value"]},"LegacyDossierMeta":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van het metaveld."},"name":{"type":"string"},"value":{"type":"string"},"dossier":{"type":["string","null"],"format":"uuid","description":"UUID van het dossier."}},"required":["uuid","name","value","dossier"]},"LegacyDossierVerification":{"type":"object","properties":{"reference":{"type":"string"},"exists":{"type":"boolean"},"dossiers":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van het dossier."},"ownerReference":{"type":"string","description":"Credifin-dossiernummer."},"reference":{"type":["string","null"],"description":"Uw eigen klantreferentie."},"status":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["uuid","ownerReference","status","updatedAt"]}}},"required":["reference","exists","dossiers"]},"LegacyCreditNote":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van de creditnota."},"dossier":{"type":"string","format":"uuid","description":"UUID van het dossier."},"invoice":{"type":["string","null"],"format":"uuid"},"hasAttachment":{"type":"boolean"},"reference":{"type":["string","null"],"description":"Creditnotanummer."},"date":{"type":["string","null"],"format":"date","description":"Datum van de creditnota."},"amount":{"type":"number","description":"Bedrag dat de hoofdsom verlaagt."},"description":{"type":["string","null"],"description":"Omschrijving."}},"required":["uuid","dossier","invoice","date","amount","hasAttachment"]},"LegacyPayment":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van de betaling."},"dossier":{"type":"string","format":"uuid","description":"UUID van het dossier."},"reference":{"type":["string","null"],"description":"Betalingskenmerk of matchsleutel."},"date":{"type":["string","null"],"format":"date","description":"Betaaldatum."},"valueDate":{"type":["string","null"],"format":"date","description":"Valutadatum."},"amount":{"type":"number","description":"Ontvangen bedrag."},"iban":{"type":["string","null"],"description":"Tegenrekening bij ontvangst op de derdengeldenrekening; anders null."},"receivedBy":{"type":["string","null"],"enum":["CLIENT","OWN_ACCOUNT",null],"description":"Waar het geld is ontvangen."},"status":{"type":"string","enum":["matched","unmatched","rejected"]},"source":{"type":"string","enum":["psp","bank","manual"]},"sender":{"type":["string","null"],"description":"Naam van de afzender."},"note":{"type":["string","null"],"description":"Mededeling."},"createdAt":{"type":"string","format":"date-time"}},"required":["uuid","dossier","date","amount","status","source"]},"LegacyCostType":{"type":"object","properties":{"uuid":{"type":"string","description":"Code van het kostentype."},"name":{"type":"string"}},"required":["uuid","name"]},"LegacyCost":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van de kostenpost."},"dossier":{"type":"string","format":"uuid","description":"UUID van het dossier."},"type":{"type":"string","description":"Code van het kostentype, zie `GET /api/dossier-cost/type`."},"typeName":{"type":"string"},"description":{"type":["string","null"],"description":"Omschrijving."},"date":{"type":["string","null"],"format":"date","description":"Datum van de kostenpost."},"periodFrom":{"type":["string","null"],"format":"date","description":"Begin van de periode, indien van toepassing."},"periodTo":{"type":["string","null"],"format":"date","description":"Einde van de periode, indien van toepassing."},"amount":{"type":"number","description":"Bedrag exclusief btw."},"amountVat":{"type":"number","description":"Btw-bedrag."},"vatPercent":{"type":"number"}},"required":["uuid","dossier","type","amount"]},"LegacyCourtCost":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van de gerechtskostenpost."},"dossier":{"type":"string","format":"uuid","description":"UUID van het dossier."},"type":{"type":["string","null"],"description":"Code van het gerechtskostentype."},"label":{"type":["string","null"],"description":"Naam van het gerechtskostentype."},"description":{"type":["string","null"],"description":"Omschrijving."},"date":{"type":["string","null"],"format":"date","description":"Datum."},"amount":{"type":"number","description":"Bedrag."},"amountVat":{"type":"number","description":"Btw-bedrag."},"paidByCreditor":{"type":"boolean","description":"Of u deze kosten zelf heeft voorgeschoten."},"thirdParty":{"type":["string","null"],"description":"Deurwaarder of andere derde partij."}},"required":["uuid","dossier","date","amount","paidByCreditor"]},"LegacyAttachment":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van de bijlage."},"dossier":{"type":["string","null"],"format":"uuid"},"invoice":{"type":["string","null"],"format":"uuid","description":"Gevuld als de bijlage bij een factuur hoort."},"attachmentName":{"type":["string","null"],"description":"Bestandsnaam (CollectOnline-veldnaam); null bij een historische notitie zonder bestand."},"filename":{"type":"string"},"contentType":{"type":["string","null"],"description":"MIME-type."},"size":{"type":["integer","null"],"description":"Grootte in bytes."},"note":{"type":["string","null"],"description":"Toelichting."},"type":{"type":["string","null"],"description":"Categorie."},"visibility":{"type":"string"},"date":{"type":"string","format":"date-time"}},"required":["uuid","attachmentName","filename","date"]},"LegacyPaymentPlan":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van de regeling."},"dossier":{"type":"string","format":"uuid","description":"UUID van het dossier."},"status":{"type":"string","enum":["proposed","active"]},"period":{"type":"string","description":"Termijnfrequentie, bijvoorbeeld `monthly`."},"total":{"type":"number","description":"Totaalbedrag van de regeling."},"installment":{"type":"number","description":"Termijnbedrag."},"startDate":{"type":["string","null"],"format":"date","description":"Eerste vervaldatum."},"createdAt":{"type":"string","format":"date-time"},"payments":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van de termijn."},"deadline_at":{"type":["string","null"],"format":"date","description":"Vervaldatum (CollectOnline-veldnaam)."},"dueDate":{"type":["string","null"],"format":"date","description":"Vervaldatum."},"amount":{"type":"number","description":"Termijnbedrag."},"paid":{"type":"boolean"},"paid_at":{"type":["string","null"],"format":"date","description":"Betaaldatum (CollectOnline-veldnaam)."},"paidAt":{"type":["string","null"],"format":"date","description":"Betaaldatum."}},"required":["uuid","deadline_at","amount","paid"]}}},"required":["uuid","dossier","status","period","total","installment","payments"]},"LegacyInterestRow":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"days":{"type":"integer"},"ratePercent":{"type":"number"},"base":{"type":"number","description":"Hoofdsom waarover in deze periode rente loopt."},"interest":{"type":"number","description":"Rente over deze periode."}},"required":["from","to","days","ratePercent","base","interest"]},"LegacyDossierInterest":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van het dossier."},"kind":{"type":"string","enum":["consumer","commercial"],"description":"Toegepaste rentesoort."},"interestKind":{"type":"string","description":"Rente-instelling op het dossier."},"interest":{"type":"number","description":"Totale rente tot `asOf`."},"base":{"type":"number","description":"Hoofdsom waarover de rente nog doorloopt."},"adjusted":{"type":"boolean","description":"True bij een handmatig gecorrigeerde vordering."},"asOf":{"type":["string","null"],"format":"date","description":"Peildatum."},"rows":{"type":"array","items":{"$ref":"#/components/schemas/LegacyInterestRow"}}},"required":["uuid","kind","interest","base","adjusted","rows"]},"LegacyInvoiceInterest":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van de factuur."},"dossier":{"type":"string","format":"uuid","description":"UUID van het dossier."},"kind":{"type":"string","enum":["consumer","commercial"]},"interest":{"type":"number","description":"Bruto berekende of vast ingestelde factuurrente, binnen de geldende dossierafspraken."},"from":{"type":["string","null"],"format":"date","description":"Startdatum van de renteberekening."},"asOf":{"type":["string","null"],"format":"date","description":"Peildatum."},"adjusted":{"type":"boolean"},"paymentsApplied":{"type":"boolean","const":false},"rows":{"type":"array","items":{"$ref":"#/components/schemas/LegacyInterestRow"}}},"required":["uuid","dossier","kind","interest","adjusted","paymentsApplied","rows"]},"LegacyDossierIndemnification":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van het dossier."},"indemnified":{"type":"boolean"},"note":{"type":["string","null"],"description":"Toelichting op de vrijwaring."}},"required":["uuid","indemnified"]},"LegacyDossierRpv":{"type":"object","properties":{"dossier":{"type":"string","description":"Het opgegeven dossier-ID."},"total":{"type":"number","description":"Totaal van de RPV-kosten."},"costs":{"type":"array","items":{"$ref":"#/components/schemas/LegacyCost"}}},"required":["dossier","total","costs"]},"LegacyDossierEntity":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"Technische identiteit van de partij."},"name":{"type":"string"},"type":{"type":"string","enum":["debtor","creditor","incasso"]},"reference":{"type":["string","null"],"description":"Eigen referentie van de partij."}},"required":["uuid","name","type","reference"]}},"LegacyDossierFinancial":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van het dossier."},"ownerReference":{"type":"string"},"currency":{"type":"string"},"balance":{"type":"number","description":"Zonder factuurregels of een vastgestelde hoofdsom toont de API het bekende dossiersaldo, net als het dossierscherm. Een lege aanlevering krijgt daardoor geen berekende incassokosten."},"principal":{"type":"number","description":"Hoofdsom (som van de facturen)."},"interest":{"type":"number","description":"Rente tot nu toe."},"penalty":{"type":"number","description":"Incassokosten (WIK), inclusief btw waar van toepassing."},"interestKind":{"type":"string","enum":["consumer","commercial"]},"interestBase":{"type":"number","description":"Hoofdsom waarover rente doorloopt."},"claimAdjusted":{"type":"boolean"},"totals":{"type":"object","properties":{"principal":{"type":"number","description":"Hoofdsom."},"interest":{"type":"number","description":"Rente."},"penalty":{"type":"number","description":"Incassokosten."},"costs":{"type":"number","description":"Kosten voor de debiteur."},"payments":{"type":"number","description":"Betalingen."},"creditnotes":{"type":"number","description":"Creditnota-totaal."},"balance":{"type":"number","description":"Saldo."}}},"invoices":{"type":"array","items":{"$ref":"#/components/schemas/LegacyInvoice"}},"creditnotes":{"type":"array","items":{"$ref":"#/components/schemas/LegacyCreditNote"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/LegacyPayment"}},"costs":{"type":"array","items":{"$ref":"#/components/schemas/LegacyCost"}},"courtcosts":{"type":"array","items":{"$ref":"#/components/schemas/LegacyCourtCost"}}},"required":["uuid","currency","balance","principal","interest","penalty","invoices","creditnotes","payments","costs","courtcosts"]},"LegacyStage":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID van de fase."},"name":{"type":"string"},"order":{"type":"integer"}},"required":["uuid","name","order"]},"LegacyInvoiceInterestUpdate":{"type":"object","required":["amount"],"properties":{"amount":{"type":"number","minimum":0,"maximum":21474836.47,"multipleOf":0.01}}},"LegacyInvoiceInterestSetResult":{"type":"object","required":["uuid","interest"],"properties":{"uuid":{"type":"string","format":"uuid"},"interest":{"type":"number"}}},"LegacyStatusHistoryRow":{"type":"object","required":["status","substatus","timestamp","comment"],"properties":{"status":{"type":"string","description":"Betaaltoezegging heet in deze historie payment promise; de actuele dossierstatus gebruikt promise to pay."},"substatus":{"type":["string","null"]},"timestamp":{"type":"string","example":"2026-09-16 11:27"},"comment":{"type":"null"}}},"LegacyPaymentCreate":{"type":"object","properties":{"dossier":{"type":"string","description":"Dossier-UUID (of uw gemigreerde CollectOnline-UUID)."},"amount":{"type":"number","exclusiveMinimum":0,"description":"Ontvangen bedrag in de valuta van het dossier."},"date":{"type":"string","format":"date","description":"Ontvangstdatum; standaard vandaag."},"reference":{"type":"string","maxLength":140,"description":"Uw betalingskenmerk, bijvoorbeeld het bankafschrift."},"note":{"type":"string","maxLength":500},"receivedBy":{"type":"string","enum":["CLIENT"],"description":"Alleen `CLIENT` is toegestaan."}},"required":["dossier","amount"]},"LegacyCreditNoteCreate":{"type":"object","properties":{"invoice":{"type":["string","null"]},"dossier":{"type":"string","description":"Dossier-UUID."},"amount":{"type":"number","exclusiveMinimum":0,"description":"Creditbedrag."},"date":{"type":"string","format":"date","description":"Datum van de creditnota; standaard vandaag."},"reference":{"type":"string","maxLength":140,"description":"Creditnotanummer."},"description":{"type":"string","maxLength":500}},"required":["dossier","amount"]},"LegacyCostCreate":{"type":"object","properties":{"dossier":{"type":"string","description":"Dossier-UUID."},"amount":{"type":"number","exclusiveMinimum":0,"description":"Bedrag van de kostenpost."},"description":{"type":"string","maxLength":200,"description":"Korte omschrijving; verplicht."},"date":{"type":"string","format":"date"},"type":{"type":"string","enum":["OTHER"],"description":"Alleen `OTHER` is toegestaan."}},"required":["dossier","amount","description"]},"LegacyMetaCreate":{"type":"object","properties":{"name":{"type":"string","maxLength":120,"pattern":"^[A-Za-z0-9][A-Za-z0-9 ._:-]*$"},"value":{"type":"string","maxLength":4000}},"required":["name","value"]},"LegacyMetaCreateWithDossier":{"type":"object","properties":{"dossier":{"type":"string","description":"Dossier-UUID."},"name":{"type":"string","maxLength":120,"pattern":"^[A-Za-z0-9][A-Za-z0-9 ._:-]*$"},"value":{"type":"string","maxLength":4000}},"required":["dossier","name","value"]},"LegacyDossierGroupSet":{"type":"object","properties":{"reference":{"type":"string","maxLength":120,"description":"Groepsreferentie."},"master":{"type":"string","description":"Dossier-UUID van het hoofddossier; standaard het eerste dossier."},"dossiers":{"type":"array","minItems":1,"maxItems":200,"items":{"type":"string"}}},"required":["reference","dossiers"]},"LegacyDossierGroup":{"type":"object","properties":{"reference":{"type":"string"},"dossiers":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"ownerReference":{"type":"string"},"groupReference":{"type":["string","null"]},"isGroupMaster":{"type":"boolean"}},"required":["uuid","ownerReference","isGroupMaster"]}}},"required":["reference","dossiers"]},"WebhookEnvelope":{"type":"object","description":"Elke webhookmelding heeft deze vorm. `data` volgt het schema van de bijbehorende API-resource (bijvoorbeeld `LegacyPayment` bij `payment.received`).","properties":{"id":{"type":"string","format":"uuid","description":"Uniek per gebeurtenis; gebruik dit voor ontdubbeling."},"type":{"type":"string","enum":["dossier.created","dossier.status.changed","dossier.paid","paymentplan.created","note.added","payment.received","invoice.created","creditnote.created","cost.created","courtcost.created","communication.sent","communication.received","phone.call","debtor.updated","debtor.contact.updated","creditor.created","webhook.test"]},"version":{"type":"integer","const":1},"occurredAt":{"type":"string","format":"date-time","description":"Moment waarop de gebeurtenis plaatsvond."},"createdAt":{"type":"string","format":"date-time","description":"Moment waarop Credifin de melding aanmaakte."},"delivery":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"attempt":{"type":"integer","minimum":1,"description":"Pogingnummer; bij een herkansing hoger dan 1."}},"required":["id","attempt"]},"creditor":{"type":["object","null"],"description":"De opdrachtgever waar de melding over gaat; null alleen bij een testmelding van een agent-webhook.","properties":{"uuid":{"type":"string","format":"uuid"},"reference":{"type":["string","null"],"description":"Klantnummer bij Credifin."},"name":{"type":["string","null"]}},"required":["uuid"]},"agency":{"type":["object","null"],"description":"Het agentschap waar de opdrachtgever onder valt; null als er geen agent is.","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":["string","null"]}},"required":["uuid"]},"dossier":{"type":["object","null"],"description":"Samenvatting van het dossier; null bij debiteurgebeurtenissen en testmeldingen.","properties":{"uuid":{"type":"string","format":"uuid"},"ownerReference":{"type":"string"},"reference":{"type":["string","null"]},"ogm":{"type":"string"},"currency":{"type":"string"},"status":{"type":"string"},"substatus":{"type":"string"},"dossierClosed":{"type":"boolean"},"balance":{"type":"number"},"createdAt":{"type":"string","format":"date-time"}}},"data":{"type":"object","description":"Gebeurtenisspecifieke gegevens."}},"required":["id","type","version","occurredAt","createdAt","delivery","creditor","agency","dossier","data"]},"ErrorField":{"type":"object","additionalProperties":false,"required":["field","code","message"],"properties":{"field":{"type":"string"},"code":{"type":"string","description":"Stabiele, machineleesbare foutcode.","example":"VALIDATION_FAILED"},"message":{"type":"string","description":"Menselijk leesbare toelichting; niet bedoeld als stabiele integratiewaarde."}}},"LegacyErrorEnvelope":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","requestId","retryable"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"fieldErrors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorField"}},"requestId":{"type":"string","description":"Correlatie-id voor support en logging."},"retryable":{"type":"boolean"}}}}},"V1ProblemDetails":{"type":"object","additionalProperties":false,"required":["type","title","status","detail","code","requestId","retryable"],"properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer","minimum":400,"maximum":599},"detail":{"type":"string"},"code":{"type":"string"},"instance":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorField"}},"requestId":{"type":"string","description":"Correlatie-id voor support en logging."},"retryable":{"type":"boolean"}}},"LegacyDebtorCreate":{"type":"object","required":["reference","country","language"],"properties":{"creditor":{"type":"string","minLength":1,"description":"Optioneel. Klant-uuid of klantnummer; een klantsleutel en een agentsleutel met één klant mogen het weglaten."},"reference":{"type":"string","minLength":1,"maxLength":200},"companyName":{"type":["string","null"],"maxLength":250},"companyNumber":{"type":["string","null"],"maxLength":100},"legalType":{"type":["string","null"],"maxLength":100},"firstName":{"type":["string","null"],"maxLength":150},"lastName":{"type":["string","null"],"maxLength":250},"title":{"type":["string","null"],"maxLength":50},"birthdate":{"type":["string","null"],"format":"date"},"ssn":{"type":["string","null"],"maxLength":100},"vatNumber":{"type":["string","null"],"maxLength":100},"email":{"type":["string","null"],"format":"email","maxLength":320},"telephone":{"type":["string","null"],"maxLength":50},"mobile":{"type":["string","null"],"maxLength":50},"fax":{"type":["string","null"],"maxLength":50},"website":{"type":["string","null"],"format":"uri","maxLength":500},"street":{"type":["string","null"],"maxLength":250},"houseNumber":{"type":["string","null"],"maxLength":50},"postalCode":{"type":["string","null"],"maxLength":30},"city":{"type":["string","null"],"maxLength":150},"country":{"$ref":"#/components/schemas/CountryCode"},"language":{"$ref":"#/components/schemas/LanguageCode"},"accountIban":{"type":["string","null"],"maxLength":34},"accountBic":{"type":["string","null"],"maxLength":11},"accountKbo":{"type":["string","null"],"maxLength":100}}},"LegacyDebtorUpdate":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"creditor":{"type":"string","minLength":1},"reference":{"type":"string","minLength":1,"maxLength":200},"companyName":{"type":["string","null"],"maxLength":250},"companyNumber":{"type":["string","null"],"maxLength":100},"legalType":{"type":["string","null"],"maxLength":100},"firstName":{"type":["string","null"],"maxLength":150},"lastName":{"type":["string","null"],"maxLength":250},"title":{"type":["string","null"],"maxLength":50},"birthdate":{"type":["string","null"],"format":"date"},"ssn":{"type":["string","null"],"maxLength":100},"vatNumber":{"type":["string","null"],"maxLength":100},"email":{"type":["string","null"],"format":"email","maxLength":320},"telephone":{"type":["string","null"],"maxLength":50},"mobile":{"type":["string","null"],"maxLength":50},"fax":{"type":["string","null"],"maxLength":50},"website":{"type":["string","null"],"format":"uri","maxLength":500},"street":{"type":["string","null"],"maxLength":250},"houseNumber":{"type":["string","null"],"maxLength":50},"postalCode":{"type":["string","null"],"maxLength":30},"city":{"type":["string","null"],"maxLength":150},"country":{"$ref":"#/components/schemas/CountryCode"},"language":{"$ref":"#/components/schemas/LanguageCode"},"accountIban":{"type":["string","null"],"maxLength":34},"accountBic":{"type":["string","null"],"maxLength":11},"accountKbo":{"type":["string","null"],"maxLength":100}}},"LegacyDebtor":{"type":"object","additionalProperties":true,"required":["uuid","reference","country","language"],"properties":{"uuid":{"type":"string","format":"uuid"},"reference":{"type":"string"},"companyName":{"type":["string","null"]},"companyNumber":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"telephone":{"type":["string","null"]},"mobile":{"type":["string","null"]},"street":{"type":["string","null"]},"houseNumber":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"$ref":"#/components/schemas/CountryCode"},"language":{"$ref":"#/components/schemas/LanguageCode"},"isCompany":{"type":"boolean"}}},"LegacyDebtorAddressCreate":{"type":"object","properties":{"street":{"type":["string","null"],"maxLength":250},"houseNumber":{"type":["string","null"],"maxLength":50},"postalCode":{"type":["string","null"],"maxLength":30},"city":{"type":["string","null"],"maxLength":150},"country":{"anyOf":[{"$ref":"#/components/schemas/CountryCode"},{"type":"null"}]},"default":{"type":"boolean","default":false},"active":{"type":"boolean","default":true}}},"LegacyDebtorAddress":{"unevaluatedProperties":false,"allOf":[{"$ref":"#/components/schemas/LegacyDebtorAddressCreate"},{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","format":"uuid"}}}]},"LegacyDebtorContactCreate":{"type":"object","properties":{"uuid":{"type":["string","null"],"format":"uuid","description":"Legacy-veld; bij create normaal weglaten."},"title":{"type":["string","null"],"maxLength":50},"firstName":{"type":["string","null"],"maxLength":150},"lastName":{"type":["string","null"],"maxLength":250},"function":{"type":["string","null"],"maxLength":150},"email":{"type":["string","null"],"format":"email","maxLength":320},"phone":{"type":["string","null"],"maxLength":50},"mobile":{"type":["string","null"],"maxLength":50},"fax":{"type":["string","null"],"maxLength":50},"default":{"type":"boolean","default":false},"active":{"type":"boolean","default":true}}},"LegacyDebtorContact":{"unevaluatedProperties":false,"allOf":[{"$ref":"#/components/schemas/LegacyDebtorContactCreate"},{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","format":"uuid"}}}]},"LegacyDossierCreate":{"type":"object","additionalProperties":false,"required":["debtor"],"properties":{"reference":{"type":"string","minLength":1,"maxLength":200,"description":"Optionele klantreferentie. Bij weglaten genereert Credifin een dossiernummer."},"creditor":{"type":"string","minLength":1,"description":"Optioneel. Klant-uuid of klantnummer; een klantsleutel en een agentsleutel met één klant mogen het weglaten."},"debtor":{"type":"string","format":"uuid"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}}},"LegacyDossierCreated":{"type":"object","additionalProperties":false,"required":["uuid","reference","currency","creditor","debtor"],"properties":{"uuid":{"type":"string","format":"uuid"},"reference":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"creditor":{"type":"string"},"debtor":{"type":"string","format":"uuid"}}},"LegacyDossier":{"type":"object","additionalProperties":true,"required":["uuid","ogm","ownerReference","creditor","debtor","isGroupMaster","dossierClosed","balance","status","substatus","updatedAt","workflow","meta"],"properties":{"uuid":{"type":"string","format":"uuid"},"ogm":{"type":"string"},"ownerReference":{"type":"string"},"creditor":{"type":"string"},"debtor":{"type":"string"},"groupReference":{"type":["string","null"]},"isGroupMaster":{"type":"boolean"},"dossierClosed":{"type":"boolean"},"balance":{"type":"number"},"status":{"type":"string"},"substatus":{"type":["string","null"]},"updatedAt":{"type":"string","format":"date-time"},"workflow":{"type":"string"},"meta":{"type":"array","items":{}}}},"LegacyDossierStatus":{"type":"object","additionalProperties":false,"required":["status","substatus"],"properties":{"status":{"type":"string"},"substatus":{"type":["string","null"]}}},"LegacyOpenAmount":{"type":"object","additionalProperties":false,"required":["balance","openAmount"],"properties":{"balance":{"type":"string","description":"Openstaand bedrag in de valuta van het dossier."},"openAmount":{"type":"number","description":"Compatibiliteitsalias van balance voor oudere consumers."}}},"LegacyInvoiceCreate":{"type":"object","required":["reference","date","dueDate","amount"],"anyOf":[{"required":["debtor"]},{"required":["dossier"]}],"properties":{"debtor":{"type":"string","format":"uuid"},"dossier":{"type":"string","format":"uuid"},"creditor":{"type":"string","description":"Mag worden weggelaten als de API-key aan precies één schuldeiser is gekoppeld."},"reference":{"type":"string","minLength":1,"maxLength":200},"date":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"amount":{"type":"number","exclusiveMinimum":0},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"invoiceType":{"type":["string","null"]},"description":{"type":["string","null"],"maxLength":1000,"description":"Omschrijving van de geleverde prestatie; wordt gebruikt om de overeenkomst achter de vordering vast te leggen."},"ogm":{"type":["string","null"],"maxLength":100},"firstReminderDate":{"type":["string","null"],"format":"date"},"firstReminderMethod":{"type":["string","null"],"enum":["email","letter",null]}}},"LegacyInvoice":{"type":"object","additionalProperties":true,"required":["uuid","dossier","reference","date","dueDate","amount","hasAttachment","meta"],"properties":{"uuid":{"type":"string","format":"uuid"},"dossier":{"type":"string","format":"uuid"},"reference":{"type":"string"},"description":{"type":["string","null"]},"ogm":{"type":["string","null"]},"date":{"type":"string","format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"amount":{"type":"number"},"hasAttachment":{"type":"boolean"},"firstReminderDate":{"type":["string","null"],"format":"date"},"firstReminderMethod":{"type":["string","null"]},"meta":{"type":"array","items":{}}}},"LegacyAttachmentCreate":{"type":"object","required":["filename","data"],"properties":{"filename":{"type":"string","minLength":1,"maxLength":255},"data":{"type":"string","contentEncoding":"base64","description":"Binaire bestandsinhoud als base64 zonder data-URL-prefix. Maximaal 10 MB; ondersteund: PDF, JPEG, PNG, TIFF, GIF, WEBP, HEIC, HTML, XML/UBL, EML, MSG, DOCX, XLSX, TXT en CSV."}}},"LegacyDossierAttachmentCreate":{"unevaluatedProperties":false,"allOf":[{"$ref":"#/components/schemas/LegacyAttachmentCreate"},{"type":"object","properties":{"note":{"type":["string","null"],"maxLength":2000},"type":{"type":["string","null"]},"visibility":{"type":["string","null"],"enum":["confidential","informative","internal","public",null]}}}]},"LegacyAttachmentResult":{"type":"object","required":["upload"],"properties":{"upload":{"type":"string","const":"success"}}},"LegacyDossierAttachmentResult":{"unevaluatedProperties":false,"allOf":[{"$ref":"#/components/schemas/LegacyAttachmentResult"},{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","format":"uuid"}}}]},"V1DossierCreate":{"type":"object","additionalProperties":false,"required":["debtor","invoices"],"properties":{"creditor":{"type":"string","maxLength":200,"description":"Klantnummer of uuid van de klant waarvoor u aanlevert. Verplicht bij een agentsleutel (zie `GET /api/creditor`); bij een klantsleutel weglaten of gelijk aan uw eigen klantnummer."},"reference":{"type":"string","minLength":1,"maxLength":200,"description":"Klantreferentie; bij weglaten genereert Credifin een dossiernummer."},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"debtor":{"$ref":"#/components/schemas/V1DebtorInput"},"invoices":{"type":"array","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/V1InvoiceInput"}},"attachments":{"type":"array","maxItems":25,"items":{"$ref":"#/components/schemas/V1AttachmentInput"},"description":"Bijlagen op dossierniveau, zoals polisblad, opzegbrief, bevestigingsmail (.eml/.msg) of een rekeningoverzicht. Standaard zichtbaar voor de opdrachtgever in het klantenportaal; niet automatisch voor de debiteur."},"meta":{"type":"array","maxItems":50,"items":{"$ref":"#/components/schemas/V1MetaInput"},"description":"Vrije dossiervelden van de opdrachtgever. Credifin gebruikt deze gegevens bij het beantwoorden van vragen van de debiteur. Later wijzigen of aanvullen kan per dossier via de meta-route."}}},"V1MetaInput":{"type":"object","additionalProperties":false,"required":["name","value"],"description":"Eén dossierveld. U kiest de naam zelf; gebruik een vaste naam per soort gegeven, bijvoorbeeld `ordernummer`, `contractnummer`, `polisnummer`, `kenteken`, `voertuig`, `polis_ingangsdatum`, `polis_einddatum`, `opzegdatum`, `opgezegd_door`, `opzegreden`, `premie_termijnbedrag`, `betaaltermijn` of `laatste_betaling`. Datums als JJJJ-MM-DD. Sommige namen zijn gereserveerd voor Credifin.","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9][A-Za-z0-9 ._:-]*$"},"value":{"type":"string","maxLength":4000}}},"V1DebtorInput":{"type":"object","additionalProperties":false,"required":["reference","language","address"],"properties":{"reference":{"type":"string","minLength":1,"maxLength":200},"companyName":{"type":["string","null"],"maxLength":250},"companyNumber":{"type":["string","null"],"maxLength":100},"firstName":{"type":["string","null"],"maxLength":150},"lastName":{"type":["string","null"],"maxLength":250},"email":{"type":["string","null"],"format":"email","maxLength":320},"phone":{"type":["string","null"],"maxLength":50},"language":{"$ref":"#/components/schemas/LanguageCode"},"address":{"$ref":"#/components/schemas/V1AddressInput"},"contact":{"$ref":"#/components/schemas/V1ContactInput"}},"anyOf":[{"required":["companyName"],"properties":{"companyName":{"type":"string","minLength":1,"maxLength":250,"pattern":"\\S"}}},{"required":["lastName"],"properties":{"lastName":{"type":"string","minLength":1,"maxLength":250,"pattern":"\\S"}}}]},"V1AddressInput":{"type":"object","additionalProperties":false,"required":["street","houseNumber","postalCode","city","country"],"properties":{"street":{"type":"string","minLength":1,"maxLength":250},"houseNumber":{"type":"string","minLength":1,"maxLength":50},"houseNumberAddition":{"type":["string","null"],"maxLength":30},"postalCode":{"type":"string","minLength":1,"maxLength":30},"city":{"type":"string","minLength":1,"maxLength":150},"country":{"$ref":"#/components/schemas/CountryCode"}}},"V1ContactInput":{"type":"object","additionalProperties":false,"properties":{"firstName":{"type":["string","null"],"maxLength":150},"lastName":{"type":["string","null"],"maxLength":250},"role":{"type":["string","null"],"maxLength":150},"email":{"type":["string","null"],"format":"email","maxLength":320},"phone":{"type":["string","null"],"maxLength":50}},"anyOf":[{"required":["email"],"properties":{"email":{"type":"string","format":"email","minLength":3,"maxLength":320}}},{"required":["phone"],"properties":{"phone":{"type":"string","minLength":1,"maxLength":50,"pattern":"\\S"}}}]},"V1InvoiceInput":{"type":"object","additionalProperties":false,"required":["reference","date","dueDate","amount"],"properties":{"reference":{"type":"string","minLength":1,"maxLength":200},"date":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"amount":{"type":"number","exclusiveMinimum":0},"description":{"type":["string","null"],"maxLength":1000},"attachments":{"type":"array","maxItems":10,"items":{"$ref":"#/components/schemas/V1AttachmentInput"}}}},"V1AttachmentInput":{"type":"object","additionalProperties":false,"required":["filename","data"],"properties":{"filename":{"type":"string","minLength":1,"maxLength":255},"contentType":{"type":["string","null"],"enum":["application/pdf","image/jpeg","image/png","image/tiff","text/plain","text/csv",null],"description":"Optioneel; indien opgegeven moet dit overeenkomen met de gedetecteerde bestandsinhoud."},"data":{"type":"string","contentEncoding":"base64","description":"Binaire bestandsinhoud als base64 zonder data-URL-prefix. Maximaal 10 MB."}}},"V1DossierCreated":{"type":"object","additionalProperties":false,"required":["dossierId","reference","debtorId","invoiceIds","createdAt"],"properties":{"dossierId":{"type":"string","format":"uuid"},"reference":{"type":"string"},"debtorId":{"type":"string","format":"uuid"},"invoiceIds":{"type":"array","items":{"type":"string","format":"uuid"}},"createdAt":{"type":"string","format":"date-time"}}},"V1DossierValidationResult":{"type":"object","additionalProperties":false,"required":["valid","stored","reference","debtorReference","currency","invoiceCount","attachmentCount","totalAmount","message"],"properties":{"valid":{"type":"boolean","const":true},"stored":{"type":"boolean","const":false,"description":"Bevestigt dat deze validatieroute niets heeft opgeslagen."},"reference":{"type":["string","null"],"description":"De genormaliseerde dossierreferentie, of `null` wanneer geen referentie is aangeleverd."},"debtorReference":{"type":"string","minLength":1,"maxLength":200},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"invoiceCount":{"type":"integer","minimum":1,"maximum":100},"attachmentCount":{"type":"integer","minimum":0,"maximum":25},"totalAmount":{"type":"number","multipleOf":0.01,"description":"Som van de gevalideerde factuurbedragen."},"message":{"type":"string"}}},"CountryCode":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 landcode; invoer wordt naar hoofdletters genormaliseerd.","example":"NL"},"LanguageCode":{"type":"string","pattern":"^[A-Za-z]{2}(-[A-Za-z]{2})?$","description":"Taalcode, bijvoorbeeld `nl`, `en` of `nl-BE`; invoer wordt canoniek genormaliseerd.","example":"nl"},"CurrencyCode":{"type":"string","pattern":"^[A-Za-z]{3}$","default":"EUR","description":"ISO 4217 valutacode; invoer wordt naar hoofdletters genormaliseerd.","example":"EUR"}}}}