Alle Zahlungen auflisten
GET /api/invoice-payments
<?xml version="1.0" encoding="UTF-8"?>
<invoice-payments type="array" page="1" per_page="100" total="2">
<invoice-payment>
...
</invoice-payment>
<invoice-payment>
...
</invoice-payment>
</invoice-payments>
Über Parameter kann gefiltert werden:
GET /api/invoice-payments?invoice_id=123
Listet alle Zahlungen zur Rechnung mit der ID 123 auf.
Folgende Parameter stehen zur Verfügung:
| Parameter | Beschreibung |
|---|---|
| invoice_id | ID der Rechnung |
| from | Nur Zahlungen ab diesem Datum (Format YYYY-MM-DD) |
| to | Nur Zahlungen bis diesem Datum (Format YYYY-MM-DD) |
| type | Zahlart (z.B. CASH, BANK_TRANSFER, PAYPAL, …). Mehrere Zahlarten können per Komma getrennt werden und werden ODER-Verknüpft. |
| user_id | Nur Zahlungen des angegebenen Nutzers |
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>
<user_id type="integer">1</user_id>
<date type="date">2009-11-04</date>
<amount type="float">12.34</amount>
<comment>per Überweisung</comment>
<transaction_purpose></transaction_purpose>
<type>BANK_TRANSFER</type>
</invoice-payment>
type kann folgende Werte haben
– INVOICE_CORRECTION (Korrekturrechnung)
– CREDIT_NOTE (Gutschrift)
– BANK_CARD (Bankkarte)
– BANK_TRANSFER (Überweisung)
– DEBIT (Lastschrift)
– CASH (Bar)
– CHECK (Scheck)
– 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“, „CHECK“, „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>
<type>BANK_TRANSFER</type>
</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>
<user_id type="integer">1</user_id>
<date type="date">2009-11-03</date>
<amount type="float">12.34</amount>
<comment>per Überweisung</comment>
<transaction_purpose></transaction_purpose>
<type>BANK_TRANSFER</type>
</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).
