Zum Inhalt springen
DebtFlow

Zahlungen

Zahlungseingänge und Ratenpläne zu Forderungen.

Ratenpläne auflisten

GET/api/v1/installment-plans

Berechtigung: payments:read

Query-Parameter

  • debtIdstring
    max. 128 Zeichen
  • status"active" | "completed" | "canceled"
  • limitinteger
    Anzahl Einträge (1–100)
    1–100 · Standard: 25
  • cursorstring
    `nextCursor` der vorherigen Seite
    max. 500 Zeichen

Antwort 200

  • object"list"Pflicht
  • dataArray<InstallmentPlan>Pflicht
    • idstringPflicht
    • object"installment_plan"Pflicht
    • debtIdstringPflicht
    • status"active" | "completed" | "canceled"Pflicht
    • amountCentsintegerPflicht
      Vereinbarte Gesamtsumme
      -100000000000–100000000000
    • numberOfPaymentsintegerPflicht
      -9007199254740991–9007199254740991
    • installmentCentsintegerPflicht
      Monatsrate
      -100000000000–100000000000
    • startDatestring (date) | nullPflicht
      Datum (YYYY-MM-DD)
    • paymentsMadeintegerPflicht
      -9007199254740991–9007199254740991
    • paidCentsintegerPflicht
      Betrag in Cent
      -100000000000–100000000000
    • remainingCentsintegerPflicht
      Betrag in Cent
      -100000000000–100000000000
    • nextDueDatestring (date) | nullPflicht
      Datum (YYYY-MM-DD)
    • lastPaymentDatestring (date) | nullPflicht
      Datum (YYYY-MM-DD)
    • scheduleArray<object>Pflicht
      Fälligkeiten (monatlich)
      • numberintegerPflicht
        -9007199254740991–9007199254740991
      • dueDatestring (date)Pflicht
        Datum (YYYY-MM-DD)
      • amountCentsintegerPflicht
        Betrag in Cent
        -100000000000–100000000000
    • notesstringPflicht
    • createdAtstring (date-time)Pflicht
      Zeitpunkt (ISO 8601)
    • updatedAtstring (date-time)Pflicht
      Zeitpunkt (ISO 8601)
  • hasMorebooleanPflicht
  • nextCursorstring | nullPflicht

Mögliche Fehler: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/installment-plans' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Antwort 200
{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "installment_plan",
      "debtId": "string",
      "status": "active",
      "amountCents": 0,
      "numberOfPayments": 0,
      "installmentCents": 0,
      "startDate": "2026-11-01",
      "paymentsMade": 0,
      "paidCents": 0,
      "remainingCents": 0,
      "nextDueDate": "2026-11-01",
      "lastPaymentDate": "2026-11-01",
      "schedule": [
        {
          "number": 0,
          "dueDate": "2026-11-01",
          "amountCents": 0
        }
      ],
      "notes": "string",
      "createdAt": "2026-11-01T09:30:00.000Z",
      "updatedAt": "2026-11-01T09:30:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": "string"
}

Ratenplan anlegen

POST/api/v1/installment-plans

Monatliche Raten ab startDate; Rundungscents gehen in die ersten Raten. Ereignis installment_plan.created.

Berechtigung: payments:write

Header

  • Idempotency-Keystring
    Eindeutiger Schlüssel (8–255 Zeichen). Wiederholte Anfragen mit gleichem Schlüssel liefern 24 h lang dieselbe Antwort.
    max. 255 Zeichen

Body (JSON) · InstallmentPlanCreate

  • debtIdstringPflicht
    max. 128 Zeichen
  • amountCentsintegerPflicht
    Betrag in Cent
    0–100000000000
  • numberOfPaymentsintegerPflicht
    1–120
  • startDatestring (date)Pflicht
    Fälligkeit der ersten Rate
  • notesstring
    max. 2000 Zeichen

Antwort 201 · InstallmentPlan

  • idstringPflicht
  • object"installment_plan"Pflicht
  • debtIdstringPflicht
  • status"active" | "completed" | "canceled"Pflicht
  • amountCentsintegerPflicht
    Vereinbarte Gesamtsumme
    -100000000000–100000000000
  • numberOfPaymentsintegerPflicht
    -9007199254740991–9007199254740991
  • installmentCentsintegerPflicht
    Monatsrate
    -100000000000–100000000000
  • startDatestring (date) | nullPflicht
    Datum (YYYY-MM-DD)
  • paymentsMadeintegerPflicht
    -9007199254740991–9007199254740991
  • paidCentsintegerPflicht
    Betrag in Cent
    -100000000000–100000000000
  • remainingCentsintegerPflicht
    Betrag in Cent
    -100000000000–100000000000
  • nextDueDatestring (date) | nullPflicht
    Datum (YYYY-MM-DD)
  • lastPaymentDatestring (date) | nullPflicht
    Datum (YYYY-MM-DD)
  • scheduleArray<object>Pflicht
    Fälligkeiten (monatlich)
    • numberintegerPflicht
      -9007199254740991–9007199254740991
    • dueDatestring (date)Pflicht
      Datum (YYYY-MM-DD)
    • amountCentsintegerPflicht
      Betrag in Cent
      -100000000000–100000000000
  • notesstringPflicht
  • createdAtstring (date-time)Pflicht
    Zeitpunkt (ISO 8601)
  • updatedAtstring (date-time)Pflicht
    Zeitpunkt (ISO 8601)

Mögliche Fehler: 400, 401, 403, 404, 409, 422, 429, 500

curl -X POST 'https://www.debt-flow.io/api/v1/installment-plans' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "debtId": "string",
  "amountCents": 0,
  "numberOfPayments": 1,
  "startDate": "2026-11-01",
  "notes": "string"
}'
Antwort 201
{
  "id": "string",
  "object": "installment_plan",
  "debtId": "string",
  "status": "active",
  "amountCents": 0,
  "numberOfPayments": 0,
  "installmentCents": 0,
  "startDate": "2026-11-01",
  "paymentsMade": 0,
  "paidCents": 0,
  "remainingCents": 0,
  "nextDueDate": "2026-11-01",
  "lastPaymentDate": "2026-11-01",
  "schedule": [
    {
      "number": 0,
      "dueDate": "2026-11-01",
      "amountCents": 0
    }
  ],
  "notes": "string",
  "createdAt": "2026-11-01T09:30:00.000Z",
  "updatedAt": "2026-11-01T09:30:00.000Z"
}

Ratenplan abrufen

GET/api/v1/installment-plans/{id}

Mit Fälligkeitsplan (schedule), gezahlten und offenen Beträgen.

Berechtigung: payments:read

Pfadparameter

  • idstringPflicht
    ID der Ressource
    max. 128 Zeichen

Antwort 200 · InstallmentPlan

  • idstringPflicht
  • object"installment_plan"Pflicht
  • debtIdstringPflicht
  • status"active" | "completed" | "canceled"Pflicht
  • amountCentsintegerPflicht
    Vereinbarte Gesamtsumme
    -100000000000–100000000000
  • numberOfPaymentsintegerPflicht
    -9007199254740991–9007199254740991
  • installmentCentsintegerPflicht
    Monatsrate
    -100000000000–100000000000
  • startDatestring (date) | nullPflicht
    Datum (YYYY-MM-DD)
  • paymentsMadeintegerPflicht
    -9007199254740991–9007199254740991
  • paidCentsintegerPflicht
    Betrag in Cent
    -100000000000–100000000000
  • remainingCentsintegerPflicht
    Betrag in Cent
    -100000000000–100000000000
  • nextDueDatestring (date) | nullPflicht
    Datum (YYYY-MM-DD)
  • lastPaymentDatestring (date) | nullPflicht
    Datum (YYYY-MM-DD)
  • scheduleArray<object>Pflicht
    Fälligkeiten (monatlich)
    • numberintegerPflicht
      -9007199254740991–9007199254740991
    • dueDatestring (date)Pflicht
      Datum (YYYY-MM-DD)
    • amountCentsintegerPflicht
      Betrag in Cent
      -100000000000–100000000000
  • notesstringPflicht
  • createdAtstring (date-time)Pflicht
    Zeitpunkt (ISO 8601)
  • updatedAtstring (date-time)Pflicht
    Zeitpunkt (ISO 8601)

Mögliche Fehler: 400, 401, 403, 404, 429, 500

curl 'https://www.debt-flow.io/api/v1/installment-plans/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Antwort 200
{
  "id": "string",
  "object": "installment_plan",
  "debtId": "string",
  "status": "active",
  "amountCents": 0,
  "numberOfPayments": 0,
  "installmentCents": 0,
  "startDate": "2026-11-01",
  "paymentsMade": 0,
  "paidCents": 0,
  "remainingCents": 0,
  "nextDueDate": "2026-11-01",
  "lastPaymentDate": "2026-11-01",
  "schedule": [
    {
      "number": 0,
      "dueDate": "2026-11-01",
      "amountCents": 0
    }
  ],
  "notes": "string",
  "createdAt": "2026-11-01T09:30:00.000Z",
  "updatedAt": "2026-11-01T09:30:00.000Z"
}

Ratenplan ändern

PATCH/api/v1/installment-plans/{id}

Berechtigung: payments:write

Pfadparameter

  • idstringPflicht
    ID der Ressource
    max. 128 Zeichen

Body (JSON) · InstallmentPlanUpdate

  • amountCentsinteger
    Betrag in Cent
    0–100000000000
  • numberOfPaymentsinteger
    1–120
  • startDatestring (date)
    Datum (YYYY-MM-DD)
  • status"active" | "completed" | "canceled"
  • notesstring
    max. 2000 Zeichen

Antwort 200 · InstallmentPlan

  • idstringPflicht
  • object"installment_plan"Pflicht
  • debtIdstringPflicht
  • status"active" | "completed" | "canceled"Pflicht
  • amountCentsintegerPflicht
    Vereinbarte Gesamtsumme
    -100000000000–100000000000
  • numberOfPaymentsintegerPflicht
    -9007199254740991–9007199254740991
  • installmentCentsintegerPflicht
    Monatsrate
    -100000000000–100000000000
  • startDatestring (date) | nullPflicht
    Datum (YYYY-MM-DD)
  • paymentsMadeintegerPflicht
    -9007199254740991–9007199254740991
  • paidCentsintegerPflicht
    Betrag in Cent
    -100000000000–100000000000
  • remainingCentsintegerPflicht
    Betrag in Cent
    -100000000000–100000000000
  • nextDueDatestring (date) | nullPflicht
    Datum (YYYY-MM-DD)
  • lastPaymentDatestring (date) | nullPflicht
    Datum (YYYY-MM-DD)
  • scheduleArray<object>Pflicht
    Fälligkeiten (monatlich)
    • numberintegerPflicht
      -9007199254740991–9007199254740991
    • dueDatestring (date)Pflicht
      Datum (YYYY-MM-DD)
    • amountCentsintegerPflicht
      Betrag in Cent
      -100000000000–100000000000
  • notesstringPflicht
  • createdAtstring (date-time)Pflicht
    Zeitpunkt (ISO 8601)
  • updatedAtstring (date-time)Pflicht
    Zeitpunkt (ISO 8601)

Mögliche Fehler: 400, 401, 403, 404, 429, 500

curl -X PATCH 'https://www.debt-flow.io/api/v1/installment-plans/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "amountCents": 0,
  "numberOfPayments": 1,
  "startDate": "2026-11-01",
  "status": "active",
  "notes": "string"
}'
Antwort 200
{
  "id": "string",
  "object": "installment_plan",
  "debtId": "string",
  "status": "active",
  "amountCents": 0,
  "numberOfPayments": 0,
  "installmentCents": 0,
  "startDate": "2026-11-01",
  "paymentsMade": 0,
  "paidCents": 0,
  "remainingCents": 0,
  "nextDueDate": "2026-11-01",
  "lastPaymentDate": "2026-11-01",
  "schedule": [
    {
      "number": 0,
      "dueDate": "2026-11-01",
      "amountCents": 0
    }
  ],
  "notes": "string",
  "createdAt": "2026-11-01T09:30:00.000Z",
  "updatedAt": "2026-11-01T09:30:00.000Z"
}

Ratenplan löschen

DELETE/api/v1/installment-plans/{id}

Löscht auch die darauf verbuchten Raten.

Berechtigung: payments:write

Pfadparameter

  • idstringPflicht
    ID der Ressource
    max. 128 Zeichen

Antwort 204

Erfolg, keine Antwort

Mögliche Fehler: 400, 401, 403, 404, 429, 500

curl -X DELETE 'https://www.debt-flow.io/api/v1/installment-plans/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Raten eines Ratenplans

GET/api/v1/installment-plans/{id}/payments

Berechtigung: payments:read

Pfadparameter

  • idstringPflicht
    ID der Ressource
    max. 128 Zeichen

Antwort 200

  • object"list"Pflicht
  • dataArray<Payment>Pflicht
    • idstringPflicht
    • object"payment"Pflicht
    • type"single" | "installment"Pflicht
      Einzelzahlung oder Rate eines Ratenplans
    • debtIdstringPflicht
    • contactIdstring | nullPflicht
    • installmentPlanIdstring | nullPflicht
    • amountCentsintegerPflicht
      Betrag in Cent
      -100000000000–100000000000
    • datestring (date)Pflicht
      Datum (YYYY-MM-DD)
    • methodstringPflicht
    • referencestringPflicht
    • notesstringPflicht
    • verifiedbooleanPflicht
      Zahlungseingang geprüft (nur Einzelzahlungen)
    • createdAtstring (date-time)Pflicht
      Zeitpunkt (ISO 8601)

Mögliche Fehler: 400, 401, 403, 404, 429, 500

curl 'https://www.debt-flow.io/api/v1/installment-plans/ID/payments' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Antwort 200
{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "payment",
      "type": "single",
      "debtId": "string",
      "contactId": "string",
      "installmentPlanId": "string",
      "amountCents": 0,
      "date": "2026-11-01",
      "method": "string",
      "reference": "string",
      "notes": "string",
      "verified": false,
      "createdAt": "2026-11-01T09:30:00.000Z"
    }
  ]
}

Rate verbuchen

POST/api/v1/installment-plans/{id}/payments

Erhöht die Zahl geleisteter Raten; bei vollständiger Zahlung wird der Plan completed. Ereignis payment.received.

Berechtigung: payments:write

Pfadparameter

  • idstringPflicht
    ID der Ressource
    max. 128 Zeichen

Header

  • Idempotency-Keystring
    Eindeutiger Schlüssel (8–255 Zeichen). Wiederholte Anfragen mit gleichem Schlüssel liefern 24 h lang dieselbe Antwort.
    max. 255 Zeichen

Body (JSON) · InstallmentPaymentCreate

  • amountCentsintegerPflicht
    Betrag in Cent
    0–100000000000
  • datestring (date)Pflicht
    Datum (YYYY-MM-DD)
  • method"bank" | "cash" | "paypal" | "card" | "direct_debit" | "other"
    Standard: "bank"
  • notesstring
    max. 2000 Zeichen

Antwort 201 · Payment

  • idstringPflicht
  • object"payment"Pflicht
  • type"single" | "installment"Pflicht
    Einzelzahlung oder Rate eines Ratenplans
  • debtIdstringPflicht
  • contactIdstring | nullPflicht
  • installmentPlanIdstring | nullPflicht
  • amountCentsintegerPflicht
    Betrag in Cent
    -100000000000–100000000000
  • datestring (date)Pflicht
    Datum (YYYY-MM-DD)
  • methodstringPflicht
  • referencestringPflicht
  • notesstringPflicht
  • verifiedbooleanPflicht
    Zahlungseingang geprüft (nur Einzelzahlungen)
  • createdAtstring (date-time)Pflicht
    Zeitpunkt (ISO 8601)

Mögliche Fehler: 400, 401, 403, 404, 409, 422, 429, 500

curl -X POST 'https://www.debt-flow.io/api/v1/installment-plans/ID/payments' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "amountCents": 0,
  "date": "2026-11-01",
  "method": "bank",
  "notes": "string"
}'
Antwort 201
{
  "id": "string",
  "object": "payment",
  "type": "single",
  "debtId": "string",
  "contactId": "string",
  "installmentPlanId": "string",
  "amountCents": 0,
  "date": "2026-11-01",
  "method": "string",
  "reference": "string",
  "notes": "string",
  "verified": false,
  "createdAt": "2026-11-01T09:30:00.000Z"
}

Rate löschen

DELETE/api/v1/installment-plans/{id}/payments/{paymentId}

Berechtigung: payments:write

Pfadparameter

  • idstringPflicht
    max. 128 Zeichen
  • paymentIdstringPflicht
    max. 128 Zeichen

Antwort 204

Erfolg, keine Antwort

Mögliche Fehler: 400, 401, 403, 404, 429, 500

curl -X DELETE 'https://www.debt-flow.io/api/v1/installment-plans/ID/payments/PAYMENTID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Zahlungen auflisten

GET/api/v1/payments

Einzelzahlungen und Raten aus Ratenplänen (type), nach Zahlungsdatum absteigend.

Berechtigung: payments:read

Query-Parameter

  • debtIdstring
    max. 128 Zeichen
  • contactIdstring
    max. 128 Zeichen
  • type"single" | "installment" | "all"
    Standard: "all"
  • fromstring (date)
    Datum (YYYY-MM-DD)
  • tostring (date)
    Datum (YYYY-MM-DD)
  • limitinteger
    Anzahl Einträge (1–100)
    1–100 · Standard: 25
  • cursorstring
    `nextCursor` der vorherigen Seite
    max. 500 Zeichen

Antwort 200

  • object"list"Pflicht
  • dataArray<Payment>Pflicht
    • idstringPflicht
    • object"payment"Pflicht
    • type"single" | "installment"Pflicht
      Einzelzahlung oder Rate eines Ratenplans
    • debtIdstringPflicht
    • contactIdstring | nullPflicht
    • installmentPlanIdstring | nullPflicht
    • amountCentsintegerPflicht
      Betrag in Cent
      -100000000000–100000000000
    • datestring (date)Pflicht
      Datum (YYYY-MM-DD)
    • methodstringPflicht
    • referencestringPflicht
    • notesstringPflicht
    • verifiedbooleanPflicht
      Zahlungseingang geprüft (nur Einzelzahlungen)
    • createdAtstring (date-time)Pflicht
      Zeitpunkt (ISO 8601)
  • hasMorebooleanPflicht
  • nextCursorstring | nullPflicht

Mögliche Fehler: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/payments' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Antwort 200
{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "payment",
      "type": "single",
      "debtId": "string",
      "contactId": "string",
      "installmentPlanId": "string",
      "amountCents": 0,
      "date": "2026-11-01",
      "method": "string",
      "reference": "string",
      "notes": "string",
      "verified": false,
      "createdAt": "2026-11-01T09:30:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": "string"
}

Zahlung erfassen

POST/api/v1/payments

Zahlungseingang zu einer Forderung. Mit installmentPlanId als Rate verbucht. markDebtPaid schließt die Forderung. Ist in den Einstellungen „Zahlungsbestätigungen“ aktiv, erhält der Schuldner eine E-Mail. Ereignis payment.received.

Berechtigung: payments:write

Header

  • Idempotency-Keystring
    Eindeutiger Schlüssel (8–255 Zeichen). Wiederholte Anfragen mit gleichem Schlüssel liefern 24 h lang dieselbe Antwort.
    max. 255 Zeichen

Body (JSON) · PaymentCreate

  • debtIdstringPflicht
    max. 128 Zeichen
  • amountCentsintegerPflicht
    Betrag in Cent
    0–100000000000
  • datestring (date)Pflicht
    Zahlungsdatum, nicht in der Zukunft
  • method"bank" | "cash" | "paypal" | "card" | "direct_debit" | "other"
    Standard: "bank"
  • referencestring
    max. 140 Zeichen
  • notesstring
    max. 2000 Zeichen
  • installmentPlanIdstring
    Als Rate dieses Ratenplans verbuchen
    max. 128 Zeichen
  • verifiedboolean
    Zahlungseingang geprüft (nur Einzelzahlungen)
  • markDebtPaidboolean
    Forderung danach als bezahlt markieren

Antwort 201 · Payment

  • idstringPflicht
  • object"payment"Pflicht
  • type"single" | "installment"Pflicht
    Einzelzahlung oder Rate eines Ratenplans
  • debtIdstringPflicht
  • contactIdstring | nullPflicht
  • installmentPlanIdstring | nullPflicht
  • amountCentsintegerPflicht
    Betrag in Cent
    -100000000000–100000000000
  • datestring (date)Pflicht
    Datum (YYYY-MM-DD)
  • methodstringPflicht
  • referencestringPflicht
  • notesstringPflicht
  • verifiedbooleanPflicht
    Zahlungseingang geprüft (nur Einzelzahlungen)
  • createdAtstring (date-time)Pflicht
    Zeitpunkt (ISO 8601)

Mögliche Fehler: 400, 401, 403, 404, 409, 422, 429, 500

curl -X POST 'https://www.debt-flow.io/api/v1/payments' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "debtId": "string",
  "amountCents": 0,
  "date": "2026-11-01",
  "method": "bank",
  "reference": "string",
  "notes": "string",
  "installmentPlanId": "string",
  "verified": false,
  "markDebtPaid": false
}'
Antwort 201
{
  "id": "string",
  "object": "payment",
  "type": "single",
  "debtId": "string",
  "contactId": "string",
  "installmentPlanId": "string",
  "amountCents": 0,
  "date": "2026-11-01",
  "method": "string",
  "reference": "string",
  "notes": "string",
  "verified": false,
  "createdAt": "2026-11-01T09:30:00.000Z"
}

Einzelzahlung abrufen

GET/api/v1/payments/{id}

Raten eines Ratenplans: /installment-plans/{id}/payments.

Berechtigung: payments:read

Pfadparameter

  • idstringPflicht
    ID der Ressource
    max. 128 Zeichen

Antwort 200 · Payment

  • idstringPflicht
  • object"payment"Pflicht
  • type"single" | "installment"Pflicht
    Einzelzahlung oder Rate eines Ratenplans
  • debtIdstringPflicht
  • contactIdstring | nullPflicht
  • installmentPlanIdstring | nullPflicht
  • amountCentsintegerPflicht
    Betrag in Cent
    -100000000000–100000000000
  • datestring (date)Pflicht
    Datum (YYYY-MM-DD)
  • methodstringPflicht
  • referencestringPflicht
  • notesstringPflicht
  • verifiedbooleanPflicht
    Zahlungseingang geprüft (nur Einzelzahlungen)
  • createdAtstring (date-time)Pflicht
    Zeitpunkt (ISO 8601)

Mögliche Fehler: 400, 401, 403, 404, 429, 500

curl 'https://www.debt-flow.io/api/v1/payments/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Antwort 200
{
  "id": "string",
  "object": "payment",
  "type": "single",
  "debtId": "string",
  "contactId": "string",
  "installmentPlanId": "string",
  "amountCents": 0,
  "date": "2026-11-01",
  "method": "string",
  "reference": "string",
  "notes": "string",
  "verified": false,
  "createdAt": "2026-11-01T09:30:00.000Z"
}

Einzelzahlung ändern

PATCH/api/v1/payments/{id}

Berechtigung: payments:write

Pfadparameter

  • idstringPflicht
    ID der Ressource
    max. 128 Zeichen

Body (JSON) · PaymentUpdate

  • amountCentsinteger
    Betrag in Cent
    0–100000000000
  • datestring (date)
    Datum (YYYY-MM-DD)
  • method"bank" | "cash" | "paypal" | "card" | "direct_debit" | "other"
  • referencestring
    max. 140 Zeichen
  • notesstring
    max. 2000 Zeichen
  • verifiedboolean
    Zahlungseingang geprüft

Antwort 200 · Payment

  • idstringPflicht
  • object"payment"Pflicht
  • type"single" | "installment"Pflicht
    Einzelzahlung oder Rate eines Ratenplans
  • debtIdstringPflicht
  • contactIdstring | nullPflicht
  • installmentPlanIdstring | nullPflicht
  • amountCentsintegerPflicht
    Betrag in Cent
    -100000000000–100000000000
  • datestring (date)Pflicht
    Datum (YYYY-MM-DD)
  • methodstringPflicht
  • referencestringPflicht
  • notesstringPflicht
  • verifiedbooleanPflicht
    Zahlungseingang geprüft (nur Einzelzahlungen)
  • createdAtstring (date-time)Pflicht
    Zeitpunkt (ISO 8601)

Mögliche Fehler: 400, 401, 403, 404, 429, 500

curl -X PATCH 'https://www.debt-flow.io/api/v1/payments/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "amountCents": 0,
  "date": "2026-11-01",
  "method": "bank",
  "reference": "string",
  "notes": "string",
  "verified": false
}'
Antwort 200
{
  "id": "string",
  "object": "payment",
  "type": "single",
  "debtId": "string",
  "contactId": "string",
  "installmentPlanId": "string",
  "amountCents": 0,
  "date": "2026-11-01",
  "method": "string",
  "reference": "string",
  "notes": "string",
  "verified": false,
  "createdAt": "2026-11-01T09:30:00.000Z"
}

Einzelzahlung löschen

DELETE/api/v1/payments/{id}

Berechtigung: payments:write

Pfadparameter

  • idstringPflicht
    ID der Ressource
    max. 128 Zeichen

Antwort 204

Erfolg, keine Antwort

Mögliche Fehler: 400, 401, 403, 404, 429, 500

curl -X DELETE 'https://www.debt-flow.io/api/v1/payments/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"