Deutsch »
English
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.
<?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}
<?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>
<type>BANK_TRANSFER</type>
</invoice-payment>
type kann folgende Werte haben
- CREDIT_NOTE (Gutschrift)
- BANK_CARD (Bankkarte)
- BANK_TRANSFER (Überweisung)
- DEBIT (Lastschrift)
- CASH (Bar)
- PAYPAL (Paypal)
- CREDIT_CARD (Kreditkarte)
- COUPON (Gutschein)
- MISC (Sonstiges)
Zahlung erstellen
POST /api/invoice-payments
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 | ||
| type | Zahlart | ALNUM (“CREDIT_NOTE”, “BANK_CARD”, “BANK_TRANSFER”, “DEBIT”, “CASH”, “PAYPAL”, “CREDIT_CARD”, “COUPON”, “MISC”) | ||
| mark_invoice_as_paid | Gibt an, ob die zugehörige Rechnung als bezahlt markiert werden soll (Status PAID). | BOOL | 0 (false) |
<invoice-payment>
<invoice_id>1</invoice_id>
<date>2009-11-03</date>
<amount>12.34</amount>
<comment>per Überweisung</comment>
</invoice-payment>
<?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}
Das Löschen einer Zahlung setzt den Status der Rechnung auf offen (OPEN), bzw. überfällig (OVERDUE).