Maak je regelingen in je eigen systeem, bijvoorbeeld in je klantcontactcentrum of ERP, dan zet je ze via de API in de portal. Haal eerst de regelingsprofielen op, stel de termijnen samen en stuur de regeling naar het proces. De portal controleert of de regeling binnen het profiel past.
Zo doe je het
- Haal de profielen op met
GET /v3/settlement_profiles. Je krijgt per profiel de naam, of het de standaard is, en de grenzen: minimum en maximum aantal termijnen en het minimumbedrag per termijn. Toon de profielen bijvoorbeeld als keuzelijst in je eigen systeem. - Stel de termijnen samen: per termijn het volgnummer, het bedrag, wanneer het bericht wordt verstuurd en de vervaldatum.
- Maak de regeling aan met
POST /v3/collection_orders/{id}/settlement, met het gekozen profiel en de termijnen. Laat je het profiel weg, dan geldt het standaardprofiel. - Volg de regeling met
GET /v3/collection_orders/{id}/settlement: de status van de regeling en van elke termijn.
Waar de portal op controleert
- De termijnen tellen samen op tot het openstaande bedrag van het proces.
- Aantal termijnen en bedrag per termijn passen binnen het profiel.
- Data liggen niet in het verleden en termijnen overlappen niet.
- Het proces is actief. Loopt er al een regeling, dan wordt de aanvraag geweigerd.
Het profiel bepaalt ook wat er gebeurt als een termijn niet wordt betaald. Zie Regelingsprofielen uitgelegd.
Goed om te weten
- Een lopende regeling aanpassen via de API is gepland. Tot die tijd pas je een regeling aan in de portal. Zie Een regeling bewerken of annuleren.
- Een regeling die je via de API aanmaakt, zie je in de portal net als elke andere regeling.