Alle Positionen einer Auftragsbestätigung auflisten

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

Auftragsbestätigungspositionen können immer nur für eine bestimmte Auftragsbestätigung zurückgegeben werden.
Deshalb ist confirmation_id ein Pflichtparameter.

<?xml version="1.0" encoding="UTF-8"?>
<confirmation-items type="array" page="1" per_page="100" total="2">
    <confirmation-item>
        ...
    <confirmation-item>
    <confirmation-item>
        ...
    <confirmation-item>
</confirmation-items>

Einzelne Position 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">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>
</confirmation-item>

Position erstellen

POST /api/confirmation-items

Auftragsbestätigungspositionen können nur für Auftragsbestätigungen mit Status Entwurf (DRAFT) erstellt werden.

XML-Element Beschreibung Typ Default-Wert Pflichtfeld
confirmation_id ID der Auftragsbestätigung INT ja (nicht aber bei der Auftragsbestätigungserstellung)
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 Auftragsbestätigungsposition wird nach eventuell bereits bestehenden Positionen 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>

Position bearbeiten

PUT /api/confirmation-items/{id}

Hier gelten die selben Parameter wie beim Anlegen, allerdings kann die verknüpfte Auftragsbestätigung (confirmation_id) nicht mehr geändert werden.
Auftragsbestätigungspositionen können nur für Auftragsbestätigungen mit Status Entwurf (DRAFT) bearbeitet werden.

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

Position löschen

DELETE /api/confirmation-items/{id}

Beim Löschen von Auftragsbestätigungspositionen wird position für alle verbleibenden Positionen neu vergeben (ohne die Sortierung zu ändern), um die evtl. entstandene Lücke wieder zu füllen.
Auftragsbestätigungspositionen können nur für Auftragsbestätigungen mit Status Entwurf (DRAFT) gelöscht werden.