Zahlungen

Auf dieser Seite erfahren Sie, wie Sie Zahlungen über die API verwalten können.

API-Endpunkt

Der API-Endpunkt für Zahlungen lautet https://api.belegfuchs.de/v1/payments.

Zahlungsdaten

Feldname	Typ	Optional	Min.	Max.	Beschreibung
id	String/Int	---	---	---	Bei der id handelt es sich um den PRIMARY_KEY. Das id-Feld wird automatisch bei der Erstellung gesetzt und kann nicht bearbeitet werden. Der Datentyp der id ist ein numerischer String. In API-Antworten wird also ein String zurückgegeben, der aber immer numerisch ist.
amount	Decimal(10,2)	Nein	---	---	Der zu buchende Betrag.
referenceType	String	Nein	---	---	Die Referenztyp. Bei Zahlungen kann der Referenztyp entweder Invoice für eine Rechnung oder Receipt für einen Beleg sein.
referenceId	String/Int	Nein	---	---	Die id der Referenz. Bei Zahlungen für einen Beleg ist dies die Beleg-id. Bei Zahlungen für eine Rechnung ist dies die Rechnungs-id.
paid	String	Nein	---	---	Das Buchungsdatum im ISO 8601 Format. z.B 2023-12-31T00:00:00.000Z
created	String	---	---	---	Das Erstellungsdatum im ISO 8601 Format. z.B 2023-12-31T00:00:00.000Z. Dieser Wert ist ein reiner Rückgabewert.

Zahlungsaus- und Zahlungseingänge buchen

Um eine neue Zahlung zu buchen, müssen Sie einen POST-Request an den Endpunkt senden.

Beispiel Payload

{
    "amount": 100.00,
    "referenceType": "Invoice",
    "referenceId": "123",
    "paid": "2023-12-31T00:00:00.000Z"
}

Sie können auch mehrere Zahlungen für eine Referenz buchen, falls eine Rechnung beispielsweise in mehreren Teilbeträgen bezahlt wurde.

Antwort

Mögliche Antworten sind:

• 200 OK : Der Zahlungsausgang bzw. Zahlungseingang wurde erfolgreich gebucht.
• 404 Not Found : Die Referenz wurde nicht gefunden.
• 400 Bad Request : Es wurden nicht alle benötigten Daten übermittelt oder die Daten sind fehlerhaft.
• 401 Unauthorized : Der API-Key ist ungültig.

Zahlungen abrufen

Um alle Zahlungen abzurufen, müssen Sie einen GET-Request an den Endpunkt mit folgenden parametern senden:

https://api.belegfuchs.de/v1/payments?page=1

Parameter	Typ	Optional	Beschreibung
page	Int	Nein	Die aktuelle Seite.

Antwort

Mögliche Antworten sind:

• 200 OK : Die Zahlungen wurden erfolgreich abgerufen. Die Antwort enthält ein Array mit den Zahlungen.
• 401 Unauthorized : Der API-Key ist ungültig.