Alle Zahlungen einer Rechnung auflisten
GET /api/invoice-payments?invoice_id={invoice_id}
Zahlungen können immer nur für eine bestimmte Rechnung zurückgegeben werden.
Deshalb ist invoice_id ein Pflichtparameter.
Response: 200 OK<?xml version="1.0" encoding="UTF-8"?> <invoice-payments type="array"> <invoice-payment> ... <invoice-payment> <invoice-payment> ... <invoice-payment> </invoice-payments>
Einzelne Zahlung aufrufen
GET /api/invoice-payments/{id}
Response: 200 OK<?xml version="1.0" encoding="UTF-8"?> <invoice-payment> <id type="integer">1</id> <created type="datetime">2007-12-13T12:12:00+01:00</created> <invoice_id type="integer">1</invoice_id> <date type="date">2009-11-04</date> <amount type="float">12.34</amount> <comment>per Überweisung</comment> </invoice-payment>
Zahlung erstellen
POST /api/invoice-payments
Bucht eine neue Zahlung.
Zahlungen können nur für Rechnungen im Status offen (OPEN) oder überfällig (OVERDUE) gebucht werden.
XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
|---|---|---|---|---|
invoice_id | ID der Rechnung | INT | ja | |
date | Datum des Zahlungseingangs | DATE | heute | |
amount | Betrag der Zahlung | FLOAT | ja | |
comment | Kommentar | ALNUM | ||
mark_invoice_as_payed | Gibt an, ob die zugehörige Rechnung als bezahlt markiert werden soll (Status PAYED). | BOOL | 0 (false) |
Request Body<invoice-payment> <invoice_id>1</invoice_id> <date>2009-11-03</date> <amount>12.34</amount> <comment>per Überweisung</comment> </invoice-payment>
Response: 201 Created<?xml version="1.0" encoding="UTF-8"?> <invoice-payment> <id type="integer">1</id> <created type="datetime">2007-12-13T12:12:00+01:00</created> <invoice_id type="integer">1</invoice_id> <date type="date">2009-11-03</date> <amount type="float">12.34</amount> <comment>per Überweisung</comment> </invoice-payment>
Zahlung löschen
DELETE /api/invoice-payments/{id}
Löscht eine Zahlung und setzt den Status der Rechnung auf offen (OPEN), bzw. überfällig (OVERDUE).
Response: 200 OK