[API] Gutschriften: Zahlungen

Kostenlos testen

Alle Zahlungen auflisten

GET /api/credit-note-payments
<?xml version="1.0" encoding="UTF-8"?>
<credit-note-payments type="array" page="1" per_page="100" total="2">
    <credit-note-payment>
        ...
    <credit-note-payment>
    <credit-note-payment>
        ...
    <credit-note-payment>
</credit-note-payments>

Über Parameter kann gefiltert werden:

GET /api/credit-note-payments?credit_note_id=123

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

Parameter Beschreibung
credit_note_id ID der Gutschrift
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/credit-note-payments/{id}
<?xml version="1.0" encoding="UTF-8"?>
<credit-note-payment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <credit_note-id type="integer">1</credit_note-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>
    <type>BANK_TRANSFER</type>
</credit-note-payment>

type kann folgende Werte haben

  • CREDIT_NOTE (Gutschrift)
  • BANK_TRANSFER (Überweisung)
  • DEBIT (Lastschrift)
  • CASH (Bar)
  • PAYPAL (Paypal)
  • CREDIT_CARD (Kreditkarte)
  • MISC (Sonstiges)

Zahlung erstellen

POST /api/credit-note-payments

Zahlungen können nur für Gutschriften im Status offen (OPEN) gebucht werden.

XML-Element Beschreibung Typ Default-Wert Pflichtfeld
credit_note_id ID der Gutschrift INT ja
date Datum des Zahlungsausgangs DATE heute
amount Betrag der Zahlung FLOAT ja
comment Kommentar ALNUM
type Zahlart ALNUM ("CREDIT_NOTE", "BANK_TRANSFER", "DEBIT", "CASH", "PAYPAL", "CREDIT_CARD", "MISC")
mark_credit_note_as_paid Gibt an, ob die zugehörige Gutschrift als bezahlt markiert werden soll (Status PAID). BOOL 0 (false) 
<credit-note-payment>
    <credit_note-id>1</credit_note-id>
    <date>2009-11-03</date>
    <amount>12.34</amount>
    <comment>per Überweisung</comment>
</credit-note-payment>

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

Zahlung löschen

DELETE /api/credit-note-payments/{id}

Löscht eine Zahlung und setzt den Status der Gutschrift auf offen (OPEN).