Articles

List all articles

GET /api/articles
<!--?xml version="1.0" encoding="UTF-8"?-->
<articles type="array" page="1" per_page="100" total="2">
</articles>
<article>
        ...
    </article>
<article>
        ...
    </article>

The list can be filtered with parameters:
GET /articles?title=layout
Shows all clients with the term “layout” in their name. It doesn’t matter if you use upper– or lowercase.
The following parameters can be used:
Parameter
Description
article_number
Article number
title
Title
description
Description
currency_code
ISO code of the currency
unit_id
ID of the chosen unit
tags
Comma separated list of tags
supplier_id
ID of the chosen supplier
Show a specific article
GET /api/articles/{id}
<!--?xml version="1.0" encoding="UTF-8"?-->
<article>
    <id type=""integer"">1</id>
    <created type=""datetime"">2007-12-13T12:12:00+01:00</created>
    <article_number>ART123
    <number type=""integer"">123</number>
    <number_pre>KD</number_pre>
    <number_length type=""integer"">0</number_length>
    <title>Webdesign</title>
    <description>This is the description. What else?</description>
    <sales_price type=""float"">123.45</sales_price>
    <sales_price2 type=""float"">110.45
    <sales_price3 type=""float"">99.99
    <sales_price4 type=""float"">
    <sales_price5 type=""float"">
    <currency_code>EUR</currency_code>
    <unit_id type=""integer"">123</unit_id>
    <tax_id type=""integer"">1</tax_id>
    <purchase_price type=""float""></purchase_price>
    <purchase_price_net_gross>NET</purchase_price_net_gross>
    <supplier_id type=""integer"">1</supplier_id>
</sales_price5></sales_price4></sales_price3></sales_price2></article_number></article>

Create article
POST /api/articles
XML element
Description
Type
Default value
Mandatory
number_pre
Prefix
ALNUM
Value from settings
number
Sequential number
INT
next free number
number_length
Minimum length of the customer number (to be filled with leading zeros)
INT
Value from settings
title
Title
ALNUM
Empty string
description
Description
ALNUM
Empty string
sales_price
Price
FLOAT
0.0
sales_price2
Price for clients which are members of pricegroup 2. The normal price is used if no price is defined.
FLOAT
sales_price3
Price for clients which are members of pricegroup 3. The normal price is used if no price is defined.
FLOAT
sales_price4
Price for clients which are members of pricegroup 4. The normal price is used if no price is defined.
FLOAT
sales_price5
Price for clients which are members of pricegroup 5. The normal price is used if no price is defined.
FLOAT
currency_code
Currency
ISO currency code
Default currency from settings
unit_id
ID of the chosen unit
INT
null
tax_id
ID of the chosen tax rate
INT
null
purchase_price
Purchase price
FLOAT
null
purchase_price_net_gross
Price basis of purchase price (gross or net prices)
ALNUM (“NET”, “GROSS”)
NET
supplier_id
ID of the chosen supplier
INT
null
type
Type (product/service)
ENUM (PRODUCT/SERVICE)
<article>
    <title>Webdesign</title>
    <sales_price>12.34</sales_price>
    <currency_code>USD</currency_code>
    <unit_id>123</unit_id>
</article>

<!--?xml version="1.0" encoding="UTF-8"?-->
<article>
    <id type=""integer"">1234</id>
    <created type=""datetime"">2007-12-13T12:12:00+01:00</created>
    <number type=""integer"">1235</number>
    <number_pre>ART</number_pre>
    <number_length type=""integer"">0</number_length>
    <title>Webdesign</title>
    <description></description>
    <sales_price type=""float"">12.34</sales_price>
    <currency_code>USD</currency_code>
    <unit_id type=""integer"">123</unit_id>
    <tax_id type=""integer"">1</tax_id>
</article>

Edit article
PUT /api/articles/{id}
<article>
    <description>Excessive Photoshop manipulations</description>
</article>

Delete article
DELETE /api/articles/{id}