Is er bij jou betaald, geef dat dan door aan de portal. Gebruik bij voorkeur het betaal-endpoint: je geeft het bedrag door en de portal werkt het proces, de berichten en de betaallinks bij. Ken je het procesnummer niet, gebruik dan je klantnummer en factuurnummer.
Welke manier kies je?
| Situatie | Gebruik |
|---|---|
Je hebt het collection_order_id van het proces opgeslagen |
POST /v3/collection_orders/{id}/payments |
| Je kent het klantnummer en het betaalkenmerk | POST /v3/debtors/{debtor_number}/collection_orders/payments?payment_reference=… |
| Je kent het klantnummer en het factuurnummer | POST /v3/debtors/{debtor_number}/collection_orders/payments?invoice_number=… |
| Je synchroniseert je openstaande posten | De synchronisatie verlaagt het bedrag vanzelf. Zie Openstaande posten synchroniseren via de API |
| Het hele proces is betaald en je wilt geen bedrag doorgeven | Zet de status op paid met PATCH /v3/collection_orders/{id} |
Advies: gebruik het betaal-endpoint op klantnummer en factuurnummer. Die gegevens heeft elk systeem, en je hoeft geen procesnummers op te slaan. Het betaal-endpoint is eenvoudiger dan betalingen verwerken door factuurregels aan te passen met een PATCH.
Zo doe je het
- Kies de aanroep uit de tabel hierboven.
- Stuur in de body het bedrag in centen (
amount) en het soort regel (type):paymentvoor een betaling ofcreditvoor een creditnota. Zondertypewordt het een betaling. - Geef eventueel
roundmee: het restbedrag in centen dat je wilt afboeken. Blijft er na de betaling een bedrag tot die waarde over, dan boekt de portal dat af als betalingsverschil en komt het proces op Betaald. - Lees het antwoord: het aantal bijgewerkte processen en betaallinks.
Voorbeeld: er staat 25,40 euro open en de klant betaalt 25,00 euro. Met round op 100 (1 euro) boekt de portal de 40 cent af als regel van het type betalingsverschil. Het proces komt op Betaald en je kunt het verschil terugzien in je rapporten.
Goed om te weten
- Op klantnummer boekt de portal de betaling op elk lopend proces van die klant dat het betaalkenmerk of factuurnummer bevat. Staat hetzelfde factuurnummer in een factuurproces en een aanmaningsproces, dan worden ze allebei bijgewerkt.
- Processen die al op Betaald staan worden overgeslagen. Vindt de portal geen proces, dan krijg je toch een geslaagd antwoord met 0 bijgewerkte processen.
- Is het proces volledig betaald, dan sluit de portal het en sluit hij ook de openstaande berichten en betaallinks.