Überspringen zum Inhalt
RemindCash

Quickstart

Erstellen Sie einen API-Schlüssel und erstellen und lesen Sie Ihren ersten Entwurf in wenigen Minuten.

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.

Dieses Handbuch erstellt einen Forderungsentwurf über die API und liest ihn zurück. Nichts wird an Ihren Kunden gesendet.

1. Erstellen Sie einen API-Schlüssel

Öffnen Sie in der App Settings → API-Schlüssel und erstellen Sie einen Schlüssel mit den Bereichen receivables:read und receivables:write.

  • Nur Unternehmen owners und Admins können Schlüssel verwalten.
  • Ihr Konto benötigt eine verifizierte E-Mail und Zwei-Faktor-Authentifizierung, und Sie bestätigen Ihr Passwort, bevor Sie die Schlüssel verwalten.
  • Der Schlüssel wird angezeigt once. Kopieren Sie es in einen geheimen Speicher; RemindCash behält nur einen Hash.
  • Die Schlüssel verfallen nach 30 Tagen. Siehe Authentication zur Rotation].

2. Halten Sie den Schlüssel aus Ihrem Code heraus

BASH
export REMINDCASH_API_KEY="<your-api-key>"

3. Forderungsentwurf erstellen

Jedes Schreiben benötigt einen Idempotency-Key-Header, so dass eine wiederholte Anforderung niemals ein Duplikat erstellen kann.

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",
    "description": "Website redesign"
  }'

Die Antwort lautet 201 Created:

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

4. Lesen Sie es zurück

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

5. Aktivierung in der App

Öffnen Sie die Forderung in der App, bestätigen Sie die Kontaktdaten und die Erlaubnis des Kunden, überprüfen Sie den Erinnerungsplan und aktivieren Sie ihn. Aktivierung ist nicht über die API verfügbar.

Weiter: Concepts].