Erinnerungen
Wie Erinnerungspläne funktionieren und wie man die Erinnerungsversuche für eine Forderung liest.
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.
Wie Erinnerungen geplant sind
Jede aktive Forderung folgt dem Erinnerungsplan des Unternehmens. Der Standard sendet 3 Tage vor, on und 3 Tage nach das Fälligkeitsdatum; Unternehmen können hinzufügen, entfernen oder Verschieben Sie Schritte in der App. Erinnerungen werden innerhalb der erlaubten Stunden des Unternehmens gesendet (standardmäßig 09:00-18:00 Ortszeit, Wochenenden frei) und bewegen Sie sich zur nächsten erlaubten Zeit, anstatt zweimal gesendet zu werden.
Erinnerungen hören auf, wenn eine Forderung bezahlt, pausiert, bestritten oder storniert wird und wenn der Kunde sich abmeldet.
Listenerinnerungsversuche
GET /v1/reminder-attempts gibt die Zustellversuche für eine Forderung zurück, die neueste zuerst. receivables:read Anwendungsbereich.
| Abfrageparameter | erforderlich | Beschreibung |
|---|---|---|
receivable_id |
Ja | Die Forderung nach Inspektion. |
per_page |
Nein | 1–100, Standard 25. |
curl "https://api.remindcash.com/v1/reminder-attempts?receivable_id=1" \
--header "Authorization: Bearer $REMINDCASH_API_KEY"{
"data": [],
"meta": { "current_page": 1, "per_page": 25, "total": 0 },
"request_id": "8cfc4494-5a40-4bd9-aa9b-5d5716840140"
}Das Versuchsobjekt
| Feld | Beschreibung |
|---|---|
id |
Versuchs-ID. |
attempt_no |
Versuchsnummer für diesen Erinnerungsschritt. |
stage_key |
Zu welchem Schritt des Zeitplans dieser Versuch gehört. |
channel |
Nachrichtenkanal, beispielsweise email. |
provider_state |
Interner Versandzustand: prepared, claimed, sending, accepted, rejected, unknown oder cancelled. |
delivery_status |
Normalisierter E-Mail-Status: queued, sending, accepted, delivered, bounced, failed, unknown oder cancelled. null, falls nicht verfügbar. |
submitted_at |
Wenn die Nachricht an den Provider (UTC) oder null übergeben wurde. |
resolved_at |
Wenn das Ergebnis endgültig wurde (UTC) oder null. |
Lieferstatus ehrlich lesen
acceptedbedeutet, dass der Anbieter die Nachricht akzeptiert hat - not, dass sie geliefert oder gelesen wurde.deliveredwird nur angezeigt, wenn der Anbieter die Lieferung meldet.unknownbedeutet, dass der Anbieter nicht eindeutig geantwortet hat (z. B. ein Timeout). RemindCash wiederholt not automatisch in diesem Fall, um das zweimalige Senden zu vermeiden; der Versuch bleibtunknown, bis er abgleicht.- Eine gelieferte Mahnung kennzeichnet niemals eine Forderung als bezahlt.