Skip to main content
Om de CODA- of CODB-bestanden van een klant te ontvangen, heeft Codaclean drie zaken nodig: de klant zelf, zijn bankrekeningen of sociale secretariaten, en een ondertekend mandaat voor elk ervan.
1

De klant aanmaken

Roep POST /customers/new aan met:
  • het enterpriseNumber (in de vorm 0123.456.789, zonder BE), de name en de accountingRef van de klant;
  • het address: street, zipCode, municipality, country (street2 is optioneel);
  • de contact: name, function, email en language (fr, nl of en). De vragen om mandaten te ondertekenen worden in die taal naar deze persoon gestuurd.
U kunt bankAccounts (alleen de IBAN) en payrollProviders (alleen de code) in dezelfde aanroep meegeven, of ze later toevoegen:
  • Bankrekeningen: stuur alleen de IBAN. Codaclean leidt daaruit de BIC en de naam van de bank af.
  • Sociale secretariaten: stuur de Codaclean-code van het sociaal secretariaat, niet zijn naam. U vindt die code via POST /payroll-providers.
Bestaat de klant al in het boekhoudkantoor, zoek hem dan op met POST /customers (bijvoorbeeld op enterpriseNumber) en voeg toe wat ontbreekt.Vereiste scope: customers:write
2

De mandaten aanvragen

Vraag één mandaat aan per bankrekening en één per sociaal secretariaat:Voor bankrekeningen bepaalt de bank het product. Codaclean vraagt een CODA-mandaat aan als de bank dat ondersteunt, en anders een CODAlight-toestemming via een connector.In beide gevallen ontvangt u CODA-bestanden.
Per IBAN, en per sociaal secretariaat, kan er maar één mandaat tegelijk in behandeling zijn. Een tweede aanvraag geeft 409 mandateAlreadyRequested terug.Verstuur elke aanvraag maar één keer en herhaal ze niet zolang het mandaat niet in POST /mandates verschijnt: tot dan wordt een dubbele aanvraag niet opgemerkt.Moet een mandaat vervangen worden, bijvoorbeeld omdat de gegevens van de klant gewijzigd zijn, dan kan de gebruiker dat in MyCodaclean doen.
Vereiste scope: mandates:write
3

De mandaten opvolgen

Mandaataanvragen worden asynchroon verwerkt. De aanroep bevestigt alleen dat Codaclean de aanvraag heeft ontvangen, en geeft geen ID van het mandaat terug.Om de mandaten op te volgen, roept u regelmatig POST /mandates aan, bijvoorbeeld met customerId en met updatedSince ingesteld op het tijdstip van uw vorige aanroep.Elk mandaat heeft een status die verandert naarmate de procedure vordert.Vereiste scope: mandates:read

​
Klant geregistreerd door een ander boekhoudkantoor

Een ondernemingsnummer kan maar tot één boekhoudkantoor behoren. Heeft een ander kantoor het al geregistreerd, dan geeft het aanmaken van de klant 403 belongsToAnotherTenant terug en kunt u de klant niet toevoegen. De boekhouder moet dan contact opnemen met de support van Codaclean om een overdrachtsprocedure op te starten. Daarvoor is het akkoord van de eindklant nodig.

​
Een connector kiezen

Sommige banken zijn bereikbaar via meerdere CODAlight-connectoren. In dat geval geeft de mandaataanvraag 422 connectorSelectionRequired terug, met een lijst candidates. Roep het endpoint opnieuw aan met de gekozen connectorId in de body. Codaclean onthoudt die keuze voor de bankrekening.

​
Statussen van mandaten

​
CODAlight-toestemmingen

Een CODAlight-toestemming wordt teruggegeven met product: "CODA". Ze is in de tijd beperkt: validUntil geeft het einde van de toestemming aan. Na die datum krijgt het mandaat de status renewalRequired, tot de klant de toestemming vernieuwt.

​
Goed om te weten

  • Mandaten die niet binnen 3 maanden ondertekend zijn, verlopen. De gebruiker kan ze opnieuw versturen vanuit MyCodaclean.
  • Codaclean stuurt eindklanten die een mandaat nog moeten ondertekenen of vernieuwen automatisch en regelmatig een herinnering.
  • De lijst van ondersteunde banken vraagt u op met POST /banks.
  • De lijst van beschikbare sociale secretariaten en hun codes vraagt u op met POST /payroll-providers.