Mahnungspositionen

Alle Posi­tio­nen einer Mah­nung auflisten

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

Mah­nungs­po­si­tio­nen kön­nen immer nur für eine bestimmte Mah­nung zurück­ge­ge­ben wer­den.
Des­halb ist reminder_id ein Pflichtparameter.

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

Ein­zelne Posi­tion 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>

Posi­tion erstellen

POST /api/reminder-items

Mah­nungs­po­si­tion kön­nen nur für Mah­nun­gen mit Sta­tus Ent­wurf (DRAFT) erstellt werden.

Die Mah­nungs­po­si­tion wird nach eve­nu­tell bereits beste­hen­den Posi­tio­nen 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 />
    <invoice_id type="integer">1</invoice_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>

Posi­tion bearbeiten

PUT /api/reminder-items/{id}

Hier gel­ten die sel­ben Para­me­ter wie beim Anle­gen, aller­dings kann die ver­knüpfte Mah­nung (reminder_id) nicht mehr geän­dert werden.

Mah­nungs­spo­si­tio­nen kön­nen nur für Mah­nun­gen mit Sta­tus Ent­wurf (DRAFT) bear­bei­tet werden.

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

Posi­tion löschen

DELETE /api/invoice-items/{id}

Beim Löschen von Mah­nungs­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üllen.

Mah­nungs­po­si­tio­nen kön­nen nur für Mah­nun­gen mit Sta­tus Ent­wurf (DRAFT) gelöscht werden.