Maak je klanten één keer aan via de API en stuur daarna elke dag je openstaande posten, één aanroep per post. De portal bepaalt zelf of een proces nieuw is, is gewijzigd of betaald is. Geef betalingen bij voorkeur ook los door, zodat de portal niet hoeft te raden wanneer een post is betaald.
Waarom synchroniseren
Met synchroniseren hoeft jouw systeem niet bij te houden wat er is veranderd. Je stuurt de actuele stand en de portal vergelijkt die met wat hij al kent. Dat maakt de koppeling aan jouw kant eenvoudig, ook als je weinig IT-capaciteit hebt. Hoe de vergelijking werkt, lees je in Collection Sync uitgelegd.
Zo doe je het
- Maak de klant aan met
POST /v3/debtors: naam, contactgegevens, adres en eventueel geblokkeerde kanalen. Doe dit één keer, bijvoorbeeld zodra de klant in je eigen systeem wordt aangemaakt. - Werk de klant bij met
PATCH /v3/debtors/{debtor_number}als er iets verandert. Je stuurt alleen wat er anders is. Wijzigingen gaan ook naar de lopende processen van die klant. - Stuur je openstaande posten met
POST /v3/collection_orders/sync: per post het klantnummer, het betaalkenmerk en de facturen die nu openstaan. Klantgegevens stuur je hier niet mee; die haalt de portal uit stap 1. - Lees het antwoord. Daarin staat wat de portal heeft gedaan (
created,updated,closed,unchanged) en welke gebeurtenissen zijn vastgelegd. Zie Collection Sync: gebeurtenissen en eventcodes. - Herhaal stap 3 voor elke post, bijvoorbeeld elke dag op een vast moment.
Hoe sluit je een proces?
Bij synchroniseren per post is er geen moment waarop de portal weet dat je lijst compleet is. Een post die je niet meer meestuurt, blijft dus lopen. Kies daarom een van deze manieren:
| Manier | Wanneer |
|---|---|
| Betaling los doorgeven met het betaal-endpoint | Aanbevolen. Je systeem weet wanneer er is betaald en geeft dat direct door. Zie Betalingen doorgeven via de API. |
| Bedrag 0 sturen met de synchronisatie | Je stuurt een betaalde post nog een tijdje mee met openstaand bedrag 0, bijvoorbeeld een week. Het proces komt op Betaald. |
| Complete lijst aanleveren (gepland) | Voor systemen die betaalde posten niet meer kunnen meesturen. Na je laatste synchronisatie stuur je één lijst met alle posten die nog openstaan. Wat ontbreekt, komt op Betaald of Geëindigd zonder betaling. Een lege lijst wordt geweigerd, zodat een mislukte export niet alles sluit. |
Advies: combineer synchroniseren met het betaal-endpoint. Een melding dat er is betaald is betrouwbaarder dan de aanname dat een post betaald is omdat hij ontbreekt.
Goed om te weten
- Bestaat de klant nog niet, dan wordt de synchronisatie geweigerd. Maak de klant eerst aan.
- Een klant aanmaken met
PATCHkan niet; daarvoor gebruik jePOST. Bestaat de klant al, dan geeftPOSTeen foutmelding en gebruik jePATCH. - De eerste flowstap van een nieuw proces wordt een uur na de synchronisatie ingepland. Een nieuwe stand binnen dat uur wordt eerst verwerkt.
- Elke synchronisatie kost 1 punt. Zie Aan de slag met de API.