List all estimate items

GET /api/offer-items?offer_id={offer_id}

Invoice items can only be returned for a particular estimate.
Therefore offer_id is a mandatory parameter.

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

Get a single item

GET /api/offer-items/{id}
<?xml version="1.0" encoding="UTF-8"?>
<offer-item>
    <id type="integer">1</id>
    <article_id type="integer">123</article_id>
    <offer_id type="integer">1</offer_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>VAT</tax_name>
    <tax_rate type="float">19.0</tax_rate>
    <title>Business cards</title>
    <description>Beautiful 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>
    <optional>0</optional>
</offer-item>

Create item

POST /api/offer-items

Estimate items can only be created for estimates with draft status (DRAFT).

XML element Description Type Default value Mandatory
offer_id ID of the estimate INT yes (nexcept for creation of an estimate)
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
optional Specifies whether this is an optional position (=1). The price will not be included in the total. INT

The item is added to evenutell already existing positions.

<offer-item>
    <offer_id>1</offer_id>
    <unit>Piece</unit>
    <quantity>5.2</quantity>
    <unit_price>10.0</unit_price>
    <tax_name>VAT</tax_name>
    <tax_rate>19.0</tax_rate>
    <title>Business cards</title>
    <description>Wonderful business cards</description>
    <optional>1</optional>
</offer-item>
<?xml version="1.0" encoding="UTF-8"?>
<offer-item>
    <id type="integer">1</id>
    <article_id />
    <offer_id type="integer">1</offer_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>VAT</tax_name>
    <tax_rate type="float">19.0</tax_rate>
    <title>Business cards</title>
    <description>Wonderful business cards</description>
    <total_gross type="float">61.88</total_gross>
    <total_net type="float">52.0</total_net>
    <optional>1</optional>
</offer-item>

Edit item

PUT /api/offer-items/{id}

Here the same parameters apply as for creating, however, the associated estimate (offer_id) can not be changed.
Estimate items can be edited only for estimates with draft status (DRAFT).

<offer-item>
    <unit>hour</unit>
    <quantity>8.5</quantity>
</offer-item>

Delete item

DELETE /api/offer-items/{id}

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