Naar hoofdinhoud

Openstaande facturen

GET https://scintillating-wolf-799.eu-west-1.convex.site/v1/dunning/worklist

Facturen die te laat zijn, met hun plek in de herinneringscyclus en het eerstvolgende moment dat er iets gebeurt. Gebruikt dezelfde rekenregels als het scherm in Memly, dus je ziet nooit een andere fase dan de beheerder.

Rechten: finance:read. Deze gegevens gaan over personen.

Dit endpoint geeft de facturen die te laat zijn, met hun plek in de herinneringscyclus. Het is bedoeld voor een dashboard waarin iemand ziet waar hij achteraan moet, niet voor een boekhoudkundig overzicht; voor dat laatste zijn de facturen met status overdue genoeg.

De berekening gebruikt dezelfde regels als het scherm in Memly. Een extern overzicht toont dus nooit een andere fase of een andere vervolgdatum dan de beheerder ziet, ook niet als de instellingen van de omgeving veranderen.

Naast items staat dunningSettings met het aantal pogingen en de tussenpozen. Zonder die context kun je nextActionAt niet plaatsen: of een vervolgdatum over drie of over veertien dagen ligt hangt af van hoe de omgeving is ingesteld.

De volgorde binnen een pagina is op urgentie, met de langst lopende dunning eerst. Wie handmatig achter betalingen aangaat, werkt daarmee van boven naar beneden.

Parameters

Naam Uitleg
limit Aantal items per pagina, 1 tot en met 500. Standaard 100. Een waarde daarbuiten geeft een fout in plaats van een stille correctie.
cursor De nextCursor uit het vorige antwoord. Blijf doorbladeren tot nextCursor null is, ook als een pagina niet vol zit.

Voorbeeld

curl "https://scintillating-wolf-799.eu-west-1.convex.site/v1/dunning/worklist" \
  -H "Authorization: Bearer <je sleutel>"

Antwoord

{
  "items": [
    {
      "id": "kn9…",
      "invoiceNumber": "B2026-000000377",
      "totalAmountCents": 4900,
      "currency": "EUR",
      "stage": "reminder_2",
      "dunningStartedAt": 1766188800000,
      "dunningAttempts": 2,
      "lastDunningAt": 1766793600000,
      "chargedBackAt": null,
      "nextActionAt": 1767398400000,
      "nextActionType": "reminder_3",
      "customerName": "Jamie de Vries",
      "customerEmail": "jamie@voorbeeld.nl",
      "productName": "Maandlidmaatschap",
      "orderId": "kh4…"
    }
  ],
  "nextCursor": null,
  "dunningSettings": {
    "retryDays": [
      3,
      7,
      14
    ],
    "maxAttempts": 3
  }
}

Velden

Veld Type Betekenis
id string Vaste verwijzing naar de factuur.
invoiceNumber string Het factuurnummer.
totalAmountCents getal Openstaand bedrag inclusief btw.
currency string Munteenheid.
stage string Waar deze factuur in de herinneringscyclus staat.
dunningStartedAt getal of null Wanneer de cyclus begon. Bepaalt de volgorde: langst lopend eerst.
dunningAttempts getal Aantal verstuurde herinneringen.
lastDunningAt getal of null Laatste herinnering.
chargedBackAt getal of null Wanneer de klant de incasso liet terugboeken.
nextActionAt getal Wanneer de volgende stap volgt.
nextActionType string Wat die stap is.
customerName string Naam van de klant.
customerEmail string of null E-mailadres van de klant.
productName string Waar de factuur over gaat.
orderId string De bestelling waar de factuur bij hoort.
dunningSettings object Staat naast items en niet erin. Bevat retryDays en maxAttempts, zodat je nextActionAt kunt plaatsen.

Veelgestelde vragen

Waarom staat er soms geen chargedBackAt?
Dat veld is alleen gevuld als de klant een incasso via de bank heeft laten terugboeken. Een gewone mislukte incasso zet het niet.
Is dit hetzelfde als facturen met status overdue?
Dezelfde facturen, meer context. Hier krijg je ook de fase, het aantal herinneringen en wanneer de volgende stap volgt.

Hierna nodig

Werkt je aanroep niet zoals verwacht, kijk dan bij de foutcodes en wat ze betekenen. Heb je nog geen sleutel, dan legt de kennisbank uit hoe je er een aanmaakt.