Gutschriften-Positionen

Alle Posi­tio­nen einer Gut­schrift auflisten

GET /api/credit-note-items?credit_note_id={credit_note_id}

Gut­schrif­ten­po­si­tio­nen kön­nen immer nur für eine bestimmte Gut­schrift zurück­ge­ge­ben wer­den.
Des­halb ist credit_note_id ein Pflichtparameter.

<?xml version="1.0" encoding="UTF-8"?>
<credit-note-items type="array">
    <credit-note-item>
        ...
    <credit-note-item>
    <credit-note-item>
        ...
    <credit-note-item>
</credit-note-items>

Ein­zelne Posi­tion aufrufen

GET /api/credit-note-items/{id}
<?xml version="1.0" encoding="UTF-8"?>
<credit-note-item>
    <id type="integer">1</id>
    <article_id type="integer">123</article_id>
    <credit_note_id type="integer">1</credit_note_id>
    <position type="integer">1</position>
    <unit>Stück</unit>
    <quantity type="float">5.2</quantity>
    <unit_price type="float">10.0</unit_price>
    <tax_name>MwSt</tax_name>
    <tax_rate type="float">19.0</tax_rate>
    <title>Visitenkarten</title>
    <description>Wunderschöne 4c Visitenkarten</description>
    <total_gross type="float">61.88</total_gross>
    <total_net type="float">52.0</total_net>
</credit-note-item>

Posi­tion erstellen

POST /api/credit-note-items

Gut­schrif­ten­po­si­tio­nen kön­nen nur für Gut­schrif­ten mit Sta­tus Ent­wurf (DRAFT) erstellt werden.

XML-Element Beschrei­bung Typ Default-Wert Pflicht­feld
credit_note_id ID der Gut­schrift INT ja (nicht aber bei der Gut­schrif­te­n­er­stel­lung)
article_id ID des Arti­kels INT
unit Ein­heit ALNUM
quan­tity Menge FLOAT 0.0
unit_price Preis pro Einheit FLOAT 0.0
tax_name Steu­er­be­zeich­nung ALNUM Wert aus Ein­stel­lun­gen
tax_rate Steu­er­rate in Prozent FLOAT Wert aus Ein­stel­lun­gen
title Titel ALNUM
descrip­tion Beschrei­bung ALNUM

Die Gut­schrif­ten­po­si­tion wird nach eve­nu­tell bereits beste­hen­den Posi­tio­nen angefügt.

<credit-note-item>
    <credit_note_id>1</credit_note_id>
    <unit>Stück</unit>
    <quantity>5.2</quantity>
    <unit_price>10.0</unit_price>
    <tax_name>MwSt</tax_name>
    <tax_rate>19.0</tax_rate>
    <title>Visitenkarten</title>
    <description>Wunderschöne 4c Visitenkarten</description>
</credit-note-item>
<?xml version="1.0" encoding="UTF-8"?>
<credit-note-item>
    <id type="integer">1</id>
    <article_id />
    <credit_note_id type="integer">1</credit_note_id>
    <created>2007-12-13T12:12:00+01:00</created>
    <position type="integer">1</position>
    <unit>Stück</unit>
    <quantity type="float">5.2</quantity>
    <unit_price type="float">10.0</unit_price>
    <tax_name>MwSt</tax_name>
    <tax_rate type="float">19.0</tax_rate>
    <title>Visitenkarten</title>
    <description>Wunderschöne 4c Visitenkarten</description>
    <total_gross type="float">61.88</total_gross>
    <total_net type="float">52.0</total_net>
</credit-note-item>

Posi­tion bearbeiten

PUT /api/credit-note-items/{id}

Hier gel­ten die sel­ben Para­me­ter wie beim Anle­gen, aller­dings kann die ver­knüpfte Gut­schrift (credit_note_id) nicht mehr geän­dert wer­den.
Gut­schrif­ten­po­si­tio­nen kön­nen nur für Gut­schrif­ten mit Sta­tus Ent­wurf (DRAFT) bear­bei­tet werden.

<credit-note-item>
    <unit>Stunde</unit>
    <quantity>8.5</quantity>
</credit-note-item>

Posi­tion löschen

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

Beim Löschen von Gut­schrif­ten­po­si­tio­nen wird posi­tion für alle ver­blei­ben­den Posi­tio­nen neu ver­ge­ben (ohne die Sor­tie­rung zu ändern), um die evtl. ent­stan­dene Lücke wie­der zu fül­len.
Gut­schrif­ten­po­si­tio­nen kön­nen nur für Gut­schrif­ten mit Sta­tus Ent­wurf (DRAFT) gelöscht werden.