GET /api/invoice-items?invoice_id={invoice_id}
Invoice items can only be returned for a particular invoice.
Therefore invoice_id is a mandatory parameter.
<?xml version="1.0" encoding="UTF-8"?> <invoice-items type="array" page="1" per_page="100" total="2"> <invoice-item> ... <invoice-item> <invoice-item> ... <invoice-item> </invoice-items>
GET /api/invoice-items/{id}
<?xml version="1.0" encoding="UTF-8"?> <invoice-item> <id type="integer">1</id> <article_id type="integer">123</article_id> <invoice_id type="integer">1</invoice_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>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_unreduced> <total_net_unreduced type="float">52.0</total_net_unreduced> </invoice-item>
POST /api/invoice-items
Invoice items can only be created for invoices with draft status (DRAFT).
XML element | Description | Type | Default value | Mandatory |
---|---|---|---|---|
invoice_id | ID of the invoice | INT | yes (except for creation of an invoice) | |
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 | FLOAT | Default tax rate | |
title | Title | ALNUM | ||
description | Description | ALNUM | ||
reduction | Reduction (absolute or percent: 10/10%) | ALNUM | type | Type (product/service) | ENUM (PRODUCT/SERVICE) |
The line item is added to eventual already existing positions.
<invoice-item> <invoice_id>1</invoice_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> </invoice-item>
<?xml version="1.0" encoding="UTF-8"?> <invoice-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>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">61.88</total_gross> <total_net type="float">52.0</total_net> </invoice-item>
PUT /api/invoice-items/{id}
Here the same parameters apply as for creating, however, the associated invoice (invoice_id) can not be changed.
Invoice items can be edited only for invoices with draft status (DRAFT).
<invoice-item> <unit>hour</unit> <quantity>8.5</quantity> </invoice-item>
DELETE /api/invoice-items/{id}
When deleting an invoice item, position of the remaining positions is reassigned (without changing the sorting) to fill the resulting gap.
Invoice items can be deleted only for invoices with draft status (DRAFT).