Wiederkehrende Forderungen
Wie wöchentliche und monatliche wiederkehrende Forderungen funktionieren und was die v1-API damit tun kann und was nicht.
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.
Noch nicht in der API. Recurring-Serie werden in der RemindCash-App erstellt und verwaltet. Die v1-API hat keine Endpunkte zum Erstellen, Bearbeiten oder Stoppen einer Serie.
Wie wiederkehrende Forderungen funktionieren
Eine wiederkehrende Forderung ist eine series, die sich wöchentlich oder monatlich wiederholt, entweder auf unbestimmte Zeit oder bis zu ihrer Beendigung. Jede Wiederholung ist eine separate occurrence mit:
- eigene stabile ID, Fälligkeitsdatum und Betrag Snapshot,
- eigene geplante Erinnerungen (aus dem Zeitplan Ihres Unternehmens) und bezahlter Status.
Wenn man ein Ereignis bezahlt, wird ein anderes Ereignis nie als bezahlt markiert, und ein bezahltes Ereignis wird nie wieder erinnert. Monatsdaten, die in einem kürzeren Monat nicht existieren, folgen einer konsistenten Regel des letzten Monatstages.
Wenn Sie eine Serie in der App bearbeiten, wählen Sie, ob die Änderung für this event only oder für future events gilt. Vergangene und bezahlte events werden nie neu geschrieben.
Was Sie durch die API tun können
- Ereignisse erscheinen in
GET /v1/receivableswie jede andere Forderung, mit ihren eigenenid,due_dateundstatus. - Sie können payments] gegen ein Ereignis aufzeichnen und es anhalten, wieder aufnehmen oder abbrechen.
PATCHgibt bei einem Ereignis409 conflictzurück – bearbeite stattdessen die Serie in der App.