Zahlungen

Alle Zahlungen auflisten

GET /api/incoming-payments

<?xml version="1.0" encoding="UTF-8"?>
<incoming-payments type="array" page="1" per_page="100" total="2">
<incoming-payment>
…
</incoming-payment>
<incoming-payment>
…
</incoming-payment>
</incoming-payments>

Über Parameter kann gefiltert werden:

GET /api/incoming-payments?incoming_id=123

Listet alle Zahlungen zur Eingangsechnung mit der ID 123 auf.
Folgende Parameter stehen zur Verfügung:

Parameter	Beschreibung
incoming_id	ID der Eingangsrechnung
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/incoming-payments/{id}

<?xml version="1.0" encoding="UTF-8"?>
<incoming-payment>
<id type="integer">1</id>
<created type="datetime">2007-12-13T12:12:00+01:00</created>
<incoming_id type="integer">1</incoming_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>
</incoming-payment>

type kann folgende Werte haben

• 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/incoming-payments

XML-Element	Beschreibung	Typ	Default-Wert	Pflichtfeld
incoming_id	ID der Eingangsrechnung	INT		ja
date	Datum der Zahlungung	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_incoming_as_paid	Gibt an, ob die zugehörige Rechnung als bezahlt markiert werden soll (Status PAID).	BOOL	0 (false)

<incoming-payment>
<incoming_id>1</incoming_id>
<date>2009-11-03</date>
<amount>12.34</amount>
<comment>per Überweisung</comment>
<type>BANK_TRANSFER</type>
</incoming-payment>

<?xml version="1.0" encoding="UTF-8"?>
<incoming-payment>
<id type="integer">1</id>
<created type="datetime">2007-12-13T12:12:00+01:00</created>
<incoming_id type="integer">1</incoming_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>
</incoming-payment>

Zahlung löschen

DELETE /api/incoming-payments/{id}

Das Löschen einer Zahlung setzt den Status der Eingangsrechnung auf offen (OPEN), bzw. überfällig (OVERDUE).