Überspringen zum Inhalt

Konzepte

Unternehmen und Schlüssel, Forderungsstatus, Beträge in kleineren Einheiten, lokale Fälligkeitsdaten und Versionen.

Unternehmen

Jeder API-Schlüssel gehört genau einem Unternehmen. Ein Schlüssel kann nur die Datensätze dieses Unternehmens sehen und ändern. Wenn Sie nach einer ID fragen, die zu einem anderen Unternehmen gehört, wird 404 not_found zurückgegeben, so dass die Datensätze anderer Unternehmen nicht entdeckt werden können.

Forderungen nach Status

Status Bedeutung
draft Erstellt, aber nicht aktiv. Es werden keine Erinnerungen geplant oder gesendet.
active Erinnerungen folgen dem Zeitplan des Unternehmens.
partially_paid Ein teil des betrags wurde als bezahlt verbucht; erinnerungen verwenden den verbleibenden betrag.
paid Voll bezahlt. Zukünftige Erinnerungen hören auf.
paused Die Ermahnungen sind bis zur Wiederaufnahme auf Eis gelegt.
disputed Der Kunde bestreitet den Betrag; es werden keine Mahnungen gesendet.
cancelled Ohne Zahlung geschlossen. Es werden keine Erinnerungen verschickt.

Beträge

Senden Sie Beträge als strings mit bis zu zwei Dezimalstellen, z. B. "1250.00". Ein Komma wird als Dezimaltrennzeichen akzeptiert ("1250,50"). Die Beträge müssen positiv sein.

Antworten geben ganze Zahlen minor Einheiten zurück: amount_minor: 125000 ist 1.250.00. Unterstützte Währungen sind EUR, GBP, TRY und USD. RemindCash konvertiert niemals zwischen Währungen.

Datum und Uhrzeit

  • due_date ist ein local Kalenderdatum im YYYY-MM-DD Format, kein Zeitstempel.
  • Momentanen wie recorded_at oder submitted_at sind ISO 8601 Zeitstempel in UTC.
  • Die Sendezeiten für Erinnerungen werden in der IANA-Zeitzone des Unternehmens (oder des Kunden) berechnet, einschließlich Änderungen bei Tageslicht.

Fassungen

Jede Forderungsantwort enthält einen version — einen 64-stelligen Fingerabdruck seines aktuellen Zustands. Geben Sie ihn als expected_version an, wenn Sie einen Draft aktualisieren.] mit 409 conflict abgelehnt, anstatt neuere Daten zu überschreiben.

Erinnerungen und Sicherheit

API-Aufrufe senden niemals Erinnerungen. Das Senden wird von der Erinnerungs-Engine nach Aktivierung in der App entschieden. Vor jedem Senden wird der Forderungsstatus, der bezahlte Betrag, die Kundenabmeldung, die Planungs- und Kanalbereitschaft erneut überprüft, also ein Forderungen, die als bezahlt oder pausiert gekennzeichnet sind, werden nicht erinnert.