List all credit note items

GET /api/credit-note-items?credit_note_id={credit_note_id}

Credit note items can only be returned for a particular credit note.
Therefore credit_note_id is a mandatory parameter.

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

Get a single item

GET /api/credit-note-items/{id}
<?xml version="1.0" encoding="UTF-8"?>
<credit-note-item>
    <id type="integer">1</id>
    <article_id type="integer">123</article_id>
    <credit_note_id type="integer">1</credit_note_id>
    <position type="integer">1</position>
    <unit>Piece</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>Business cards</title>
    <description>Wonderful 4c business cards</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>
    <total_net_unreduced type="float">52.0</total_net>
</credit-note-item>

Create item

POST /api/credit-note-items

Credit note items can only be created for invoices with draft status (DRAFT).

XML element Description Type Default value Mandatory
credit_note_id ID of the credit note INT yes (except for creation of a credit note)
article_id ID of the article, sets additionally the values from the article on creation INT
unit Unit ALNUM
quantity Quantity FLOAT 0.0
unit_price Price per unit FLOAT 0.0
tax_name Name of the tax ALNUM Default tax rate
tax_rate rate of taxation in percent FLOAT Default tax rate
title Title ALNUM
description Description ALNUM
reduction Reduction (absolute or percent: 10/10%) ALNUM

The line item is added to evenutell already existing positions.

<credit-note-item>
    <credit_note_id>1</credit_note_id>
    <unit>Piece</unit>
    <quantity>5.2</quantity>
    <unit_price>10.0</unit_price>
    <tax_name>MwSt</tax_name>
    <tax_rate>19.0</tax_rate>
    <title>Business cards</title>
    <description>Wonderful 4c business cards</description>
</credit-note-item>
<?xml version="1.0" encoding="UTF-8"?>
<credit-note-item>
    <id type="integer">1</id>
    <article_id />
    <credit_note_id type="integer">1</credit_note_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>Business cards</title>
    <description>Wonderful 4c business cards</description>
    <total_gross type="float">61.88</total_gross>
    <total_net type="float">52.0</total_net>
</credit-note-item>

Edit item

PUT /api/credit-note-items/{id}

Here the same parameters apply as for creating, however, the associated credit note (credit_note_id) can not be changed.
Credit note items can be edited only for credit notes with draft status (DRAFT).

<credit-note-item>
    <unit>hour</unit>
    <quantity>8.5</quantity>
</credit-note-item>

Delete item

DELETE /api/credit-note-items/{id}

When deleting an credit note item, position of the remaining positions is reassigned (without changing the sorting) to fill the resulting gap.
Credit note items can be deleted only for credit notes with draft status (DRAFT).