Delivery API

List deliveries

GET /kb_delivery
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:

  • id
  • total
  • total_net
  • total_gross
  • updated_at
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 773
Content-Type: application/json
[
  {
    "id": 1,
    "document_nr": "LS-00001",
    "title": null,
    "contact_id": 1,
    "contact_sub_id": null,
    "user_id": 1,
    "logopaper_id": 1,
    "language_id": 1,
    "bank_account_id": 1,
    "currency_id": 1,
    "header": "Sehr geehrte Damen und HerrenAnbei erhalten Sie:",
    "footer": "Bei Fragen stehen wir Ihnen gerne zur Verfügung.Freundliche Grüsse",
    "total_gross": "0.0000",
    "total_net": "0.0000",
    "total_taxes": "0.0000",
    "total": "0.0000",
    "mwst_type": 0,
    "mwst_is_net": true,
    "is_valid_from": "2015-09-18",
    "contact_address": "Muster AG\nMüllerstrasse 22\n8004 Zürich",
    "delivery_address_type": 0,
    "delivery_address": "Muster AG\nMüllerstrasse 22\n8004 Zürich",
    "kb_item_status_id": 10,
    "api_reference": null,
    "viewed_by_client_at": null,
    "updated_at": "2015-09-18 15:41:58",
    "taxs": [

    ]
  }
]

Show delivery

GET /kb_delivery/1
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 4168043e8c9d0a471196eea426dc234a
Content-Length: 1077
Content-Type: application/json
{
  "id": 1,
  "document_nr": "LS-00001",
  "title": null,
  "contact_id": 1,
  "contact_sub_id": null,
  "user_id": 1,
  "logopaper_id": 1,
  "language_id": 1,
  "bank_account_id": 1,
  "currency_id": 1,
  "header": "Sehr geehrte Damen und HerrenAnbei erhalten Sie:",
  "footer": "Bei Fragen stehen wir Ihnen gerne zur Verfügung.Freundliche Grüsse",
  "total_gross": "0.0000",
  "total_net": "0.0000",
  "total_taxes": "0.0000",
  "total": "0.0000",
  "mwst_type": 0,
  "mwst_is_net": true,
  "is_valid_from": "2015-09-18",
  "contact_address": "Muster AG\nMüllerstrasse 22\n8004 Zürich",
  "delivery_address_type": 0,
  "delivery_address": "Muster AG\nMüllerstrasse 22\n8004 Zürich",
  "kb_item_status_id": 10,
  "api_reference": null,
  "viewed_by_client_at": null,
  "updated_at": "2015-09-18 15:41:58",
  "taxs": [

  ],
  "positions": [
    {
      "id": 3,
      "type": "KbPositionCustom",
      "amount": "2.0000",
      "unit_id": 1,
      "account_id": null,
      "unit_name": "h",
      "tax_id": 4,
      "tax_value": "0.00",
      "text": "Pizzateig",
      "unit_price": "3.6500",
      "discount_in_percent": "10.0000",
      "position_total": "6.5700",
      "pos": "1",
      "internal_pos": 1,
      "parent_id": null,
      "is_optional": false
    }
  ]
}

Issue delivery

POST /kb_delivery/1/issue
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript-Callback
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 16
Content-Type: application/json
{
  "success": true
}