Überspringen zum Inhalt
RemindCash

Forderungen

Liste, Lesen, Erstellen und Aktualisieren von Forderungsentwürfen mit dem forderungspflichtigen Objekt und jedem akzeptierten Feld.

Public API Status

Die v1-API verwendet unternehmensweit erfasste Trägerschlüssel und erfordert einen aktiven Planzeitraum. Endpunkte für Entwurfs- und Zahlungsberichte senden keine Kundennachrichten. Beispiele verwenden Platzhalter — fügen Sie niemals einen echten Schlüssel in einen freigegebenen Code ein.

Endpunkte

Methode Wegstrecke Anwendungsbereich
GET /v1/receivables receivables:read
GET /v1/receivables/{id} receivables:read
POST /v1/receivables receivables:write
PATCH /v1/receivables/{id} receivables:write

Zahlungen und Statusänderungen werden in Payment tracking] beschrieben.

Der Gegenstand der Forderung

Feld Typ Beschreibung
id Ganzzahl Erkennbare ID in Ihrem Unternehmen.
customer_id Ganzzahl Dem Kunden gehört diese Forderung.
amount_minor Ganzzahl Geschuldeter Betrag in kleineren Einheiten.
paid_minor Ganzzahl Als bezahlt erfasster Gesamtbetrag in kleineren Einheiten.
currency String EUR, GBP, TRY oder USD.
due_date String Lokale Fälligkeit, YYYY-MM-DD.
status String Siehe statuses].
external_reference String oder Null Ihre eigene Referenz, einzigartig in Ihrem Unternehmen.
description String oder Null Freier Text, bis zu 2.000 Zeichen.
version String Fingerabdruck für sichere Updates verwendet.

Liste der Forderungen

Die Ergebnisse werden von id geordnet und paginiert (siehe 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"
}

Abruf einer Forderung

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

Eine unbekannte ID - oder eine, die zu einer anderen Firma gehört - gibt 404 not_found zurück.

Erstellen Sie einen Entwurf der Forderung

POST /v1/receivables Eine Forderung in draft Status. Es erfordert eine [...]Idempotency-Key](/de/docs/pagination-and-idempotency#idempotenz) Header und Returns 201 Created.

Feld erforderlich Vorschriften
customer Eines von customer oder customer_id Objekt mit display_name (erforderlich, max. 160) und mindestens einem von email oder phone_e164. Optional preferred_locale (en, tr) und IANA timezone.
customer_id Eines von customer oder customer_id Ein bestehender Kunde in Ihrem Unternehmen.
amount Ja Positive Dezimalzeichenfolge, bis zu zwei Dezimalstellen.
currency Ja EUR, GBP, TRY oder USD.
due_date Ja YYYY-MM-DD.
external_reference Nein Eine bereits in Ihrem Unternehmen verwendete Referenz gibt 409 conflict zurück.
description Nein Maximal 2.000 Zeichen.

phone_e164 muss im E.164-Format vorliegen, z. B. +14155550100. Felder wie status oder tenant_id werden abgelehnt.

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"
  }'

Neue Kunden, die auf diese Weise erstellt wurden, benötigen immer noch eine verifizierte Kontaktaufnahme und eine in der App aufgezeichnete Berechtigung, bevor eine Erinnerung gesendet werden kann.

Aktualisieren Sie einen Entwurf der Forderung

PATCH /v1/receivables/{id} ändert einen Entwurf. Senden Sie expected_version (das version, das Sie zuletzt gelesen haben) und mindestens ein Feld, um es zu ändern: customer_id, amount, currency, due_date, external_reference oder 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"
  }'

Die Antwort enthält die aktualisierte Forderung und ihre neue version. Die Aktualisierung gibt 409 conflict zurück, wenn:

  • expected_version passt nicht mehr (jemand hat es zuerst geändert),
  • die Forderung ist kein Entwurf mehr,
  • es ist ein Vorkommen einer wiederkehrenden Serie],
  • eine Zahlung vorliegt und Sie versuchen, den Kunden, den Betrag oder die Währung zu ändern.