Alle Positionen einer Abo-Rechnung auflisten

GET /api/recurring-items?recurring_id={recurring_id}

Abo-Rechnungspositionen können immer nur für eine bestimmte Abo-Rechnung zurückgegeben werden.
Deshalb ist recurring_id ein Pflichtparameter.

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

Einzelne Position aufrufen

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

Position erstellen

POST /api/recurring-items
XML-Element Beschreibung Typ Default-Wert Pflichtfeld
recurring_id ID der Abo-Rechnung INT ja (nicht aber bei der Abo-Rechnungserstellung)
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 Abo-Rechnungsposition wird nach evenutell bereits bestehenden Positionen angefügt.

<recurring-item>
    <recurring_id>1</recurring_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>
</recurring-item>

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

Position bearbeiten

PUT /api/recurring-items/{id}

Hier gelten die selben Parameter wie beim Anlegen, allerdings kann die verknüpfte Abo-Rechnung (recurring_id) nicht mehr geändert werden.

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

Position löschen

DELETE /api/recurring-items/{id}

Beim Löschen von Abo-Rechnungspositionen wird position für alle verbleibenden Positionen neu vergeben (ohne die Sortierung zu ändern), um die evtl. entstandene Lücke wieder zu füllen.