Alle Positionen einer Mahnung auflisten

GET /api/reminder-items?reminder_id={reminder_id}

Mahnungspositionen können immer nur für eine bestimmte Mahnung zurückgegeben werden.
Deshalb ist reminder_id ein Pflichtparameter.

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

Einzelne Position aufrufen

GET /api/reminder-items/{id}
<?xml version="1.0" encoding="UTF-8"?>
<reminder-item>
    <id type="integer">1</id>
    <article_id type="integer">123</article_id>
    <reminder_id type="integer">1</reminder_id>
    <position type="integer">1</position>
    <unit>Stück</unit>
    <quantity type="float">5.2</quantity>
    <unit_price type="float">10.0</unit_price>
    <title>Visitenkarten</title>
    <description>Wunderschöne 4c Visitenkarten</description>
    <total type="float">61.88</total>
</reminder-item>

Position erstellen

POST /api/reminder-items

Mahnungsposition können nur für Mahnungen mit Status Entwurf (DRAFT) erstellt werden.

XML-Element Beschreibung Typ Default-Wert Pflichtfeld
reminder_id ID der Mahnung INT ja (nicht aber bei der Mahnungserstellung)
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
title Titel ALNUM
description Beschreibung ALNUM

Die Mahnungsposition wird nach evenutell bereits bestehenden Positionen angefügt.

<reminder-item>
    <reminder_id>1</reminder_id>
    <unit>Stück</unit>
    <quantity>1</quantity>
    <unit_price>10.0</unit_price>
    <title>Mahngebühr</title>
    <description></description>
</reminder-item>
<?xml version="1.0" encoding="UTF-8"?>
<reminder-item>
    <id type="integer">1</id>
    <article_id />
    <reminder_id type="integer">1</reminder_id>
    <created>2007-12-13T12:12:00+01:00</created>
    <position type="integer">1</position>
    <unit>Stück</unit>
    <quantity type="float">1</quantity>
    <unit_price type="float">10.0</unit_price>
    <title>Mahngebühr</title>
    <description></description>
    <total type="float">10</total>
</reminder-item>

Position bearbeiten

PUT /api/reminder-items/{id}

Hier gelten die selben Parameter wie beim Anlegen, allerdings kann die verknüpfte Mahnung (reminder_id) nicht mehr geändert werden.
Mahnungsspositionen können nur für Mahnungen mit Status Entwurf (DRAFT) bearbeitet werden.

<reminder-item>
    <quantity>8.5</quantity>
</reminder-item>

Position löschen

DELETE /api/reminder-items/{id}

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