Auftragsbestätigungspositionen

Alle Posi­tio­nen einer Auf­trags­be­stä­ti­gung auflisten

GET /api/confirmation-items?confirmation_id={confirmation_id}

Auf­trags­be­stä­ti­gungs­po­si­tio­nen kön­nen immer nur für eine bestimmte Auf­trags­be­stä­ti­gung zurück­ge­ge­ben wer­den.
Des­halb ist confirmation_id ein Pflichtparameter.

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

Ein­zelne Posi­tion aufrufen

GET /api/confirmation-items/{id}
<?xml version="1.0" encoding="UTF-8"?>
<confirmation-item>
    <id type="integer">1</id>
    <article_id type="integer">123</article_id>
    <confirmation_id type="integer">1</confirmation_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>
</confirmation-item>

Posi­tion erstellen

POST /api/confirmation-items

Auf­trags­be­stä­ti­gungs­po­si­tio­nen kön­nen nur für Auf­trags­be­stä­ti­gun­gen mit Sta­tus Ent­wurf (DRAFT) erstellt werden.

XML-Element Beschrei­bung Typ Default-Wert Pflicht­feld
confirmation_id ID der Auf­trags­be­stä­ti­gung INT ja (nicht aber bei der Auf­trags­be­stä­ti­gungs­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 Auf­trags­be­stä­ti­gungs­po­si­tion wird nach even­tu­ell bereits beste­hen­den Posi­tio­nen angefügt.

<confirmation-item>
    <confirmation_id>1</confirmation_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>
</confirmation-item>
<?xml version="1.0" encoding="UTF-8"?>
<confirmation-item>
    <id type="integer">1</id>
    <article_id />
    <confirmation_id type="integer">1</confirmation_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>
</confirmation-item>

Posi­tion bearbeiten

PUT /api/confirmation-items/{id}

Hier gel­ten die sel­ben Para­me­ter wie beim Anle­gen, aller­dings kann die ver­knüpfte Auf­trags­be­stä­ti­gung (confirmation_id) nicht mehr geän­dert werden.

Auf­trags­be­stä­ti­gungs­po­si­tio­nen kön­nen nur für Auf­trags­be­stä­ti­gun­gen mit Sta­tus Ent­wurf (DRAFT) bear­bei­tet werden.

<confirmation-item>
    <unit>Stunde</unit>
    <quantity>8.5</quantity>
</confirmation-item>

Posi­tion löschen

DELETE /api/confirmation-items/{id}

Beim Löschen von Auf­trags­be­stä­ti­gungs­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.
Auf­trags­be­stä­ti­gungs­po­si­tio­nen kön­nen nur für Auf­trags­be­stä­ti­gun­gen mit Sta­tus Ent­wurf (DRAFT) gelöscht werden.