Items API

List items

GET /article
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • intern_name
  • id

The following scopes are needed:

  • article_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 2097
Content-Type: application/json
[
  {
    "id": 1,
    "user_id": 1,
    "article_type_id": 2,
    "contact_id": null,
    "deliverer_code": null,
    "deliverer_name": null,
    "deliverer_description": null,
    "intern_code": "wh-2013",
    "intern_name": "Webhosting",
    "intern_description": null,
    "purchase_price": null,
    "sale_price": null,
    "purchase_total": null,
    "sale_total": null,
    "currency_id": null,
    "tax_income_id": null,
    "tax_id": null,
    "tax_expense_id": null,
    "unit_id": null,
    "is_stock": false,
    "stock_id": null,
    "stock_place_id": null,
    "stock_nr": 0,
    "stock_min_nr": 0,
    "stock_reserved_nr": 1,
    "stock_available_nr": 0,
    "stock_picked_nr": 0,
    "stock_disposed_nr": 0,
    "stock_ordered_nr": 0,
    "width": null,
    "height": null,
    "weight": null,
    "volume": null,
    "html_text": null,
    "remarks": null,
    "delivery_price": null,
    "article_group_id": null
  },
  {
    "id": 2,
    "user_id": 1,
    "article_type_id": 1,
    "contact_id": null,
    "deliverer_code": null,
    "deliverer_name": null,
    "deliverer_description": null,
    "intern_code": "x86",
    "intern_name": "Server x86",
    "intern_description": null,
    "purchase_price": null,
    "sale_price": null,
    "purchase_total": null,
    "sale_total": null,
    "currency_id": null,
    "tax_income_id": null,
    "tax_id": null,
    "tax_expense_id": null,
    "unit_id": null,
    "is_stock": true,
    "stock_id": null,
    "stock_place_id": null,
    "stock_nr": 100,
    "stock_min_nr": 20,
    "stock_reserved_nr": 0,
    "stock_available_nr": 100,
    "stock_picked_nr": 0,
    "stock_disposed_nr": 0,
    "stock_ordered_nr": 0,
    "width": null,
    "height": null,
    "weight": null,
    "volume": null,
    "html_text": null,
    "remarks": null,
    "delivery_price": null,
    "article_group_id": null
  },
  {
    "id": 3,
    "user_id": 1,
    "article_type_id": null,
    "contact_id": null,
    "deliverer_code": "",
    "deliverer_name": "",
    "deliverer_description": "",
    "intern_code": "ZK-1001",
    "intern_name": "",
    "intern_description": "",
    "purchase_price": null,
    "sale_price": null,
    "purchase_total": null,
    "sale_total": null,
    "currency_id": 1,
    "tax_income_id": null,
    "tax_id": null,
    "tax_expense_id": null,
    "unit_id": null,
    "is_stock": false,
    "stock_id": null,
    "stock_place_id": null,
    "stock_nr": 0,
    "stock_min_nr": 0,
    "stock_reserved_nr": 0,
    "stock_available_nr": 0,
    "stock_picked_nr": 0,
    "stock_disposed_nr": 0,
    "stock_ordered_nr": 0,
    "width": null,
    "height": null,
    "weight": null,
    "volume": null,
    "html_text": "",
    "remarks": "",
    "delivery_price": null,
    "article_group_id": null
  }
]

Search items

POST /article/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "intern_name",
    "value": "hosting"
  }
]
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • id
  • intern_name
Name Required Type Description
intern_name optional string

The following scopes are needed:

  • article_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 707
Content-Type: application/json
[
  {
    "id": 1,
    "user_id": 1,
    "article_type_id": 2,
    "contact_id": null,
    "deliverer_code": null,
    "deliverer_name": null,
    "deliverer_description": null,
    "intern_code": "wh-2013",
    "intern_name": "Webhosting",
    "intern_description": null,
    "purchase_price": null,
    "sale_price": null,
    "purchase_total": null,
    "sale_total": null,
    "currency_id": null,
    "tax_income_id": null,
    "tax_id": null,
    "tax_expense_id": null,
    "unit_id": null,
    "is_stock": false,
    "stock_id": null,
    "stock_place_id": null,
    "stock_nr": 0,
    "stock_min_nr": 0,
    "stock_reserved_nr": 1,
    "stock_available_nr": 0,
    "stock_picked_nr": 0,
    "stock_disposed_nr": 0,
    "stock_ordered_nr": 0,
    "width": null,
    "height": null,
    "weight": null,
    "volume": null,
    "html_text": null,
    "remarks": null,
    "delivery_price": null,
    "article_group_id": null
  }
]

Show item

GET /article/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • article_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 683
Content-Type: application/json
{
  "id": 3,
  "user_id": 1,
  "article_type_id": null,
  "contact_id": null,
  "deliverer_code": "",
  "deliverer_name": "",
  "deliverer_description": "",
  "intern_code": "ZK-1001",
  "intern_name": "",
  "intern_description": "",
  "purchase_price": null,
  "sale_price": null,
  "purchase_total": null,
  "sale_total": null,
  "currency_id": 1,
  "tax_income_id": null,
  "tax_id": null,
  "tax_expense_id": null,
  "unit_id": null,
  "is_stock": false,
  "stock_id": null,
  "stock_place_id": null,
  "stock_nr": 0,
  "stock_min_nr": 0,
  "stock_reserved_nr": 0,
  "stock_available_nr": 0,
  "stock_picked_nr": 0,
  "stock_disposed_nr": 0,
  "stock_ordered_nr": 0,
  "width": null,
  "height": null,
  "weight": null,
  "volume": null,
  "html_text": "",
  "remarks": "",
  "delivery_price": null,
  "article_group_id": null
}

Create item

POST /article
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "intern_code": "ZK-1001"
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
account_id optional Resource account
article_group_id optional Resource article_group
article_id optional Resource article
article_type_id optional Resource article_type
character_info optional string (700)
contact_id optional Resource contact
currency_id optional Resource currency
deliverer_code optional string (60)
deliverer_description optional string
deliverer_name optional string (255)
delivery_price optional decimal
expense_account_id optional Resource account
height optional integer
html_text optional string
intern_code optional string (60)
intern_description optional string
intern_name optional string (255)
is_using_set_price_calc optional boolean
marginFromPurchasePrice optional decimal
marginFromSalePrice optional decimal
purchase_price optional decimal
purchase_total optional decimal
remarks optional string
sale_price optional decimal
sale_total optional decimal
stock_id optional Resource stock
stock_min_nr optional decimal
stock_nr optional decimal
stock_place_id optional Resource stock_place
tax_expense_id optional Resource tax
tax_income_id optional Resource tax
unit_id optional Resource unit
user_id optional Resource user
volume optional integer
weight optional integer
width optional integer

The following scopes are needed:

  • article_edit
Status: 201 Created
X-Authenticated-User: apiextract_1
Content-Length: 695
Content-Type: application/json
{
  "id": 3,
  "user_id": 1,
  "article_type_id": null,
  "contact_id": null,
  "deliverer_code": "",
  "deliverer_name": "",
  "deliverer_description": "",
  "intern_code": "ZK-1001",
  "intern_name": "",
  "intern_description": "",
  "purchase_price": null,
  "sale_price": null,
  "purchase_total": null,
  "sale_total": null,
  "currency_id": 1,
  "tax_income_id": null,
  "tax_id": null,
  "tax_expense_id": null,
  "unit_id": null,
  "is_stock": false,
  "stock_id": null,
  "stock_place_id": null,
  "stock_nr": "0",
  "stock_min_nr": "0",
  "stock_reserved_nr": "0",
  "stock_available_nr": 0,
  "stock_picked_nr": "0",
  "stock_disposed_nr": "0",
  "stock_ordered_nr": "0",
  "width": null,
  "height": null,
  "weight": null,
  "volume": null,
  "html_text": "",
  "remarks": "",
  "delivery_price": null,
  "article_group_id": null
}

Overwrite item

PUT /article/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "intern_code": "ZK-1001"
}
Name Required Type Description
callback optional string
Name Required Type Description
account_id optional Resource account
article_group_id optional Resource article_group
article_id optional Resource article
character_info optional string (700)
contact_id optional Resource contact
currency_id optional Resource currency
deliverer_code optional string (60)
deliverer_description optional string
deliverer_name optional string (255)
delivery_price optional decimal
expense_account_id optional Resource account
height optional integer
html_text optional string
intern_code optional string (60)
intern_description optional string
intern_name optional string (255)
is_using_set_price_calc optional boolean
marginFromPurchasePrice optional decimal
marginFromSalePrice optional decimal
purchase_price optional decimal
purchase_total optional decimal
remarks optional string
sale_price optional decimal
sale_total optional decimal
stock_id optional Resource stock
stock_min_nr optional decimal
stock_nr optional decimal
stock_place_id optional Resource stock_place
tax_expense_id optional Resource tax
tax_income_id optional Resource tax
unit_id optional Resource unit
user_id optional Resource user
volume optional integer
weight optional integer
width optional integer

The following scopes are needed:

  • article_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 692
Content-Type: application/json
{
  "id": 3,
  "user_id": 1,
  "article_type_id": null,
  "contact_id": null,
  "deliverer_code": "",
  "deliverer_name": "",
  "deliverer_description": "",
  "intern_code": "ZK-1001",
  "intern_name": "",
  "intern_description": "",
  "purchase_price": null,
  "sale_price": null,
  "purchase_total": null,
  "sale_total": null,
  "currency_id": null,
  "tax_income_id": null,
  "tax_id": null,
  "tax_expense_id": null,
  "unit_id": null,
  "is_stock": false,
  "stock_id": null,
  "stock_place_id": null,
  "stock_nr": null,
  "stock_min_nr": null,
  "stock_reserved_nr": 0,
  "stock_available_nr": 0,
  "stock_picked_nr": 0,
  "stock_disposed_nr": 0,
  "stock_ordered_nr": 0,
  "width": null,
  "height": null,
  "weight": null,
  "volume": null,
  "html_text": "",
  "remarks": "",
  "delivery_price": null,
  "article_group_id": null
}

Edit item

POST /article/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "intern_code": "ZK-1002"
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
account_id optional Resource account
article_group_id optional Resource article_group
article_id optional Resource article
character_info optional string (700)
contact_id optional Resource contact
currency_id optional Resource currency
deliverer_code optional string (60)
deliverer_description optional string
deliverer_name optional string (255)
delivery_price optional decimal
expense_account_id optional Resource account
height optional integer
html_text optional string
intern_code optional string (60)
intern_description optional string
intern_name optional string (255)
is_using_set_price_calc optional boolean
marginFromPurchasePrice optional decimal
marginFromSalePrice optional decimal
purchase_price optional decimal
purchase_total optional decimal
remarks optional string
sale_price optional decimal
sale_total optional decimal
stock_id optional Resource stock
stock_min_nr optional decimal
stock_nr optional decimal
stock_place_id optional Resource stock_place
tax_expense_id optional Resource tax
tax_income_id optional Resource tax
unit_id optional Resource unit
user_id optional Resource user
volume optional integer
weight optional integer
width optional integer

The following scopes are needed:

  • article_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 692
Content-Type: application/json
{
  "id": 3,
  "user_id": 1,
  "article_type_id": null,
  "contact_id": null,
  "deliverer_code": "",
  "deliverer_name": "",
  "deliverer_description": "",
  "intern_code": "ZK-1002",
  "intern_name": "",
  "intern_description": "",
  "purchase_price": null,
  "sale_price": null,
  "purchase_total": null,
  "sale_total": null,
  "currency_id": null,
  "tax_income_id": null,
  "tax_id": null,
  "tax_expense_id": null,
  "unit_id": null,
  "is_stock": false,
  "stock_id": null,
  "stock_place_id": null,
  "stock_nr": null,
  "stock_min_nr": null,
  "stock_reserved_nr": 0,
  "stock_available_nr": 0,
  "stock_picked_nr": 0,
  "stock_disposed_nr": 0,
  "stock_ordered_nr": 0,
  "width": null,
  "height": null,
  "weight": null,
  "volume": null,
  "html_text": "",
  "remarks": "",
  "delivery_price": null,
  "article_group_id": null
}

Delete item

DELETE /article/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • article_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 16
Content-Type: application/json
{
  "success": true
}