Alle Positionen einer Gutschrift auflisten
GET /api/credit-note-items?credit_note_id={credit_note_id}
Gutschriftenpositionen können immer nur für eine bestimmte Gutschrift zurückgegeben werden.
Deshalb ist credit_note_id ein Pflichtparameter.
<?xml version="1.0" encoding="UTF-8"?>
<credit-note-items type="array" page="1" per_page="100" total="2">
<credit-note-item>
...
<credit-note-item>
<credit-note-item>
...
<credit-note-item>
</credit-note-items>
Einzelne Position 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">49.98</total_gross>
<total_net type="float">42.0</total_net>
<reduction>10</reduction>
<total_gross_unreduced type="float">61.88</total_gross_unreduced>
<total_net_unreduced type="float">52.0</total_net_unreduced>
</credit-note-item>
Position erstellen
POST /api/credit-note-items
Gutschriftenpositionen können nur für Gutschriften mit Status Entwurf (DRAFT) erstellt werden.
XML-Element |
Beschreibung |
Typ |
Default-Wert |
Pflichtfeld |
credit_note_id |
ID der Gutschrift |
INT |
|
ja (nicht aber bei der Gutschriftenerstellung) |
article_id |
ID des Artikels, setzt bei Neuanlage zusätzlich die Werte aus Artikel |
INT |
|
|
unit |
Einheit |
ALNUM |
|
|
quantity |
Menge |
FLOAT |
0.0 |
|
unit_price |
Preis pro Einheit |
FLOAT |
0.0 |
|
tax_name |
Steuerbezeichnung |
ALNUM |
Standard-Steuersatz |
|
tax_rate |
Steuerrate in Prozent |
FLOAT |
Standard-Steuersatz |
|
title |
Titel |
ALNUM |
|
|
description |
Beschreibung |
ALNUM |
|
|
reduction |
Rabatt (Absolut oder als Prozentwert: 10/10%) |
ALNUM |
|
|
Die Gutschriftenposition wird nach evenutell bereits bestehenden Positionen 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>
Position bearbeiten
PUT /api/credit-note-items/{id}
Hier gelten die selben Parameter wie beim Anlegen, allerdings kann die verknüpfte Gutschrift (credit_note_id) nicht mehr geändert werden.
Gutschriftenpositionen können nur für Gutschriften mit Status Entwurf (DRAFT) bearbeitet werden.
<credit-note-item>
<unit>Stunde</unit>
<quantity>8.5</quantity>
</credit-note-item>
Position löschen
DELETE /api/credit-note-items/{id}
Beim Löschen von Gutschriftenpositionen wird position für alle verbleibenden Positionen neu vergeben (ohne die Sortierung zu ändern), um die evtl. entstandene Lücke wieder zu füllen.
Gutschriftenpositionen können nur für Gutschriften mit Status Entwurf (DRAFT) gelöscht werden.