Skip to main content
CODB-bestanden zijn loonbestanden die sociale secretariaten voor uw klanten aan Codaclean aanleveren. De werkwijze is dezelfde als voor CODA-bestanden. De bestanden komen ‘s ochtends binnen: het volstaat om deze cyclus twee keer per dag te doorlopen.
1

Nieuwe bestanden opvragen

Roep POST /codb-files aan met een JSON-body, minstens {}.Standaard bevat het antwoord alleen bestanden die u nog niet hebt bevestigd.De bestanden zijn gegroepeerd per klant en vervolgens per sociaal secretariaat en jaar.Nuttige filters: enterpriseNumber, payrollProvider, accountPeriod, statementDate, processingDate, statementNumber.Zet includePdf op true om ook de pdf-versie van elk bestand te ontvangen.Vereiste scope: files:read
2

Elk bestand downloaden

Elk bestand bevat een link urls.codb (en urls.pdf als u daarom hebt gevraagd).Het gaat om vooraf ondertekende URL’s: u downloadt ze met een gewone GET, zonder de API-headers.
Download-URL’s verlopen 30 minuten na de aanroep van de lijst. Is een URL verlopen, vraag de lijst dan opnieuw op om een nieuwe URL te krijgen.
3

Elke download bevestigen

Zodra u een bestand aan uw kant hebt opgeslagen, roept u DELETE /codb-files/{fileId} aan met de id van het bestand.Het bestand wordt niet verwijderd. Het wordt voor uw API-sleutel en de huidige gebruiker als gedownload gemarkeerd, en verschijnt niet meer in de volgende lijst.Bevestigt u hetzelfde bestand twee keer, dan krijgt u 409.

​
Een bestand opnieuw downloaden

Wilt u bestanden opvragen die al bevestigd zijn, stuur dan "redownload": true mee.

​
Goed om te weten

  • In CODB-antwoorden is statementDate de aanmaakdatum van het bestand en statementNumber het volgnummer ervan.
  • statementNumber is een string. Meestal bevat hij alleen cijfers, maar hij kan ook meerdere volgnummers combineren (bijvoorbeeld "0103-0203"): zet hem niet om in een getal.
  • accountPeriod is een geheel getal in de vorm JJJJMM (bijvoorbeeld 202609).
  • De lijst is niet gepagineerd. Bevestig de bestanden gaandeweg, zodat de antwoorden klein blijven.
  • Bevestigingen gelden per API-sleutel en per gebruiker.