Naar de inhoud gaan
RemindCash

Vorderingen

Lijst, lees, maak en update concept vorderingen, met het te ontvangen object en elk geaccepteerd veld.

Openbare API-status

De v1 API maakt gebruik van company-scoped toonder keys en vereist een actieve planning periode. Ontwerp en betaling rapportage eindpunten niet verzenden klantenberichten. Voorbeelden gebruiken plaatshouders .Plakken nooit een echte sleutel in gedeelde code.

Eindpunten

Methode Pad Toepassingsgebied
GET /v1/receivables receivables:read
GET /v1/receivables/{id} receivables:read
POST /v1/receivables receivables:write
PATCH /v1/receivables/{id} receivables:write

Betalingen en statuswijzigingen worden beschreven in Payment tracking.

Het te ontvangen voorwerp

Veld Type Omschrijving
id geheel getal Ontvangbaar ID binnen uw bedrijf.
customer_id geheel getal De klant van wie deze te ontvangen is.
amount_minor geheel getal Bedrag verschuldigd in kleine eenheden.
paid_minor geheel getal Totaal opgenomen als betaald, in kleine eenheden.
currency tekenreeks EUR, GBP, TRY of USD.
due_date tekenreeks Lokale vervaldatum, YYYY-MM-DD.
status tekenreeks Zie statussen.
external_reference tekenreeks of nul Uw eigen referentie, uniek binnen uw bedrijf.
description tekenreeks of nul Gratis sms, tot 2000 karakters.
version tekenreeks Vingerafdruk gebruikt voor veilige updates.

Lijstvorderingen

Resultaten worden besteld door id en gepagineerd (zie Pagination).

BASH
curl "https://api.remindcash.com/v1/receivables?per_page=25" \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"
JSON
{
    "data": [
        {
            "id": 1,
            "customer_id": 1,
            "amount_minor": 125000,
            "paid_minor": 0,
            "currency": "USD",
            "due_date": "2026-10-15",
            "status": "draft",
            "external_reference": "INV-1042",
            "description": "Website redesign",
            "version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1"
        }
    ],
    "meta": { "current_page": 1, "per_page": 25, "total": 1 },
    "request_id": "762e599f-c42c-4c49-84fb-9a2f56a3f923"
}

Te ontvangen bedragen ophalen

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"

Een onbekende ID of een die behoort tot een ander bedrijf . . geeft 404 not_found.

Maak een concept te ontvangen

POST /v1/receivables creëert een te ontvangen in draft status. Het vereist een Idempotency-Key header en geeft 201 Created terug.

Veld Vereist Regels
customer Een van customer of customer_id Object met display_name (verplicht, max 160) en ten minste één van email of phone_e164. Optionele preferred_locale (en, tr) en IANA timezone.
customer_id Een van customer of customer_id Een bestaande klant in uw bedrijf.
amount Ja. Positieve decimale tekenreeks, tot twee decimalen.
currency Ja. EUR, GBP, TRY of USD.
due_date Ja. YYYY-MM-DD.
external_reference Nee Max. 160 karakters. Een referentie die al in uw bedrijf wordt gebruikt, geeft 409 conflict terug.
description Nee Max 2000 karakters.

phone_e164 moet in E.164 formaat zijn, bijvoorbeeld +14155550100. Velden zoals status of tenant_id worden afgewezen.

BASH
curl https://api.remindcash.com/v1/receivables \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: create-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "customer": { "display_name": "Studio North", "email": "billing@studionorth.example" },
    "amount": "1250.00",
    "currency": "USD",
    "due_date": "2026-10-15",
    "external_reference": "INV-1042"
  }'

Nieuwe klanten die op deze manier zijn gemaakt, moeten hun contact nog steeds geverifieerd en toestemming opgenomen in de app voordat een herinnering kan worden verzonden.

Update van een te ontvangen ontwerp

PATCH /v1/receivables/{id} wijzigt een concept. Stuur expected_version (de version die je voor het laatst gelezen hebt) plus ten minste één veld om te wijzigen: customer_id, amount, currency, due_date, external_reference of description.

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --request PATCH \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: update-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "expected_version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1",
    "due_date": "2026-10-20"
  }'

Het antwoord bevat de bijgewerkte te ontvangen en de nieuwe version. De update geeft 409 conflict terug wanneer:

  • expected_version komt niet meer overeen (iemand heeft het eerst gewijzigd),
  • de schuldvordering is niet langer een concept;
  • het is een voorval van een terugkerende reeks,
  • een betaling bestaat en u probeert de klant, bedrag of valuta te veranderen.