Orders API

List orders

GET /kb_order
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

The following scopes are needed:

  • kb_order_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 2922
Content-Type: application/json
[
  {
    "id": 1,
    "document_nr": "AU-00001",
    "title": null,
    "contact_id": 1,
    "contact_sub_id": null,
    "user_id": 1,
    "project_id": null,
    "logopaper_id": 1,
    "language_id": 1,
    "bank_account_id": 1,
    "currency_id": 1,
    "payment_type_id": 1,
    "header": "Sehr geehrte Damen und HerrenVielen Dank für Ihren Auftrag, welchen wir hiermit gerne bestätigen.",
    "footer": "Bei Fragen stehen wir Ihnen gerne zur Verfügung.Freundliche Grüsse",
    "total_gross": "19.7700",
    "total_net": "17.8000",
    "total_taxes": "0.0000",
    "total": "17.8000",
    "mwst_type": 0,
    "mwst_is_net": true,
    "show_position_taxes": false,
    "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": 5,
    "is_recurring": false,
    "api_reference": null,
    "viewed_by_client_at": null,
    "updated_at": "2015-09-18 15:41:13",
    "taxs": [
      {
        "percentage": 0,
        "value": "0.0000"
      }
    ],
    "network_link": ""
  },
  {
    "id": 2,
    "document_nr": "AU-00002",
    "title": null,
    "contact_id": 1,
    "contact_sub_id": null,
    "user_id": 1,
    "project_id": null,
    "logopaper_id": 1,
    "language_id": 1,
    "bank_account_id": 1,
    "currency_id": 1,
    "payment_type_id": 1,
    "header": "Sehr geehrte Damen und HerrenVielen Dank für Ihren Auftrag, welchen wir hiermit gerne bestätigen.",
    "footer": "Bei Fragen stehen wir Ihnen gerne zur Verfügung.Freundliche Grüsse",
    "total_gross": "4.0000",
    "total_net": "4.0000",
    "total_taxes": "0.0000",
    "total": "4.0000",
    "mwst_type": 0,
    "mwst_is_net": true,
    "show_position_taxes": false,
    "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": 5,
    "is_recurring": false,
    "api_reference": null,
    "viewed_by_client_at": null,
    "updated_at": "2015-09-18 15:41:53",
    "taxs": [
      {
        "percentage": "0.00",
        "value": "0.0000"
      }
    ],
    "network_link": ""
  },
  {
    "id": 3,
    "document_nr": "AU-00003",
    "title": "",
    "contact_id": 1,
    "contact_sub_id": null,
    "user_id": 1,
    "project_id": null,
    "logopaper_id": 1,
    "language_id": 1,
    "bank_account_id": 1,
    "currency_id": 1,
    "payment_type_id": 1,
    "header": "Sehr geehrte Damen und HerrenVielen Dank für Ihren Auftrag, welchen wir hiermit gerne bestätigen.",
    "footer": "Bei Fragen stehen wir Ihnen gerne zur Verfügung.Freundliche Grüsse",
    "total_gross": "132.0000",
    "total_net": "132.0000",
    "total_taxes": "10.5600",
    "total": "142.5500",
    "mwst_type": 0,
    "mwst_is_net": true,
    "show_position_taxes": false,
    "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": 5,
    "is_recurring": false,
    "api_reference": "",
    "viewed_by_client_at": null,
    "updated_at": "2015-09-18 15:41:55",
    "taxs": [
      {
        "percentage": "8.00",
        "value": "10.5600"
      }
    ],
    "network_link": ""
  }
]

Search orders

POST /kb_order/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "contact_id",
    "value": 1
  }
]
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_gross
  • total_net
  • updated_at
Name Required Type Description
id optional string
kb_item_status_id optional string
document_nr optional string
title optional string
contact_id optional string
contact_sub_id optional string
user_id optional string
currency_id optional string
total_gross optional string
total_net optional string
total optional string
is_valid_from optional string
is_valid_to optional string
is_valid_until optional string
updated_at optional string

The following scopes are needed:

  • kb_order_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 2922
Content-Type: application/json
[
  {
    "id": 1,
    "document_nr": "AU-00001",
    "title": null,
    "contact_id": 1,
    "contact_sub_id": null,
    "user_id": 1,
    "project_id": null,
    "logopaper_id": 1,
    "language_id": 1,
    "bank_account_id": 1,
    "currency_id": 1,
    "payment_type_id": 1,
    "header": "Sehr geehrte Damen und HerrenVielen Dank für Ihren Auftrag, welchen wir hiermit gerne bestätigen.",
    "footer": "Bei Fragen stehen wir Ihnen gerne zur Verfügung.Freundliche Grüsse",
    "total_gross": "19.7700",
    "total_net": "17.8000",
    "total_taxes": "0.0000",
    "total": "17.8000",
    "mwst_type": 0,
    "mwst_is_net": true,
    "show_position_taxes": false,
    "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": 5,
    "is_recurring": false,
    "api_reference": null,
    "viewed_by_client_at": null,
    "updated_at": "2015-09-18 15:41:13",
    "taxs": [
      {
        "percentage": 0,
        "value": "0.0000"
      }
    ],
    "network_link": ""
  },
  {
    "id": 2,
    "document_nr": "AU-00002",
    "title": null,
    "contact_id": 1,
    "contact_sub_id": null,
    "user_id": 1,
    "project_id": null,
    "logopaper_id": 1,
    "language_id": 1,
    "bank_account_id": 1,
    "currency_id": 1,
    "payment_type_id": 1,
    "header": "Sehr geehrte Damen und HerrenVielen Dank für Ihren Auftrag, welchen wir hiermit gerne bestätigen.",
    "footer": "Bei Fragen stehen wir Ihnen gerne zur Verfügung.Freundliche Grüsse",
    "total_gross": "4.0000",
    "total_net": "4.0000",
    "total_taxes": "0.0000",
    "total": "4.0000",
    "mwst_type": 0,
    "mwst_is_net": true,
    "show_position_taxes": false,
    "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": 5,
    "is_recurring": false,
    "api_reference": null,
    "viewed_by_client_at": null,
    "updated_at": "2015-09-18 15:41:53",
    "taxs": [
      {
        "percentage": "0.00",
        "value": "0.0000"
      }
    ],
    "network_link": ""
  },
  {
    "id": 3,
    "document_nr": "AU-00003",
    "title": "",
    "contact_id": 1,
    "contact_sub_id": null,
    "user_id": 1,
    "project_id": null,
    "logopaper_id": 1,
    "language_id": 1,
    "bank_account_id": 1,
    "currency_id": 1,
    "payment_type_id": 1,
    "header": "Sehr geehrte Damen und HerrenVielen Dank für Ihren Auftrag, welchen wir hiermit gerne bestätigen.",
    "footer": "Bei Fragen stehen wir Ihnen gerne zur Verfügung.Freundliche Grüsse",
    "total_gross": "132.0000",
    "total_net": "132.0000",
    "total_taxes": "10.5600",
    "total": "142.5500",
    "mwst_type": 0,
    "mwst_is_net": true,
    "show_position_taxes": false,
    "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": 5,
    "is_recurring": false,
    "api_reference": "",
    "viewed_by_client_at": null,
    "updated_at": "2015-09-18 15:41:55",
    "taxs": [
      {
        "percentage": "8.00",
        "value": "10.5600"
      }
    ],
    "network_link": ""
  }
]

Show order

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

The following scopes are needed:

  • kb_order_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 48282fade28cb11bf1570a260595323a
Content-Length: 1618
Content-Type: application/json
{
  "id": 3,
  "document_nr": "AU-00003",
  "title": "",
  "contact_id": 1,
  "contact_sub_id": null,
  "user_id": 1,
  "project_id": null,
  "logopaper_id": 1,
  "language_id": 1,
  "bank_account_id": 1,
  "currency_id": 1,
  "payment_type_id": 1,
  "header": "Sehr geehrte Damen und HerrenVielen Dank für Ihren Auftrag, welchen wir hiermit gerne bestätigen.",
  "footer": "Bei Fragen stehen wir Ihnen gerne zur Verfügung.Freundliche Grüsse",
  "total_gross": "132.0000",
  "total_net": "132.0000",
  "total_taxes": "10.5600",
  "total": "142.5500",
  "mwst_type": 0,
  "mwst_is_net": true,
  "show_position_taxes": false,
  "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": 5,
  "is_recurring": false,
  "api_reference": "",
  "viewed_by_client_at": null,
  "updated_at": "2015-09-18 15:41:55",
  "taxs": [
    {
      "percentage": "8.00",
      "value": "10.5600"
    }
  ],
  "positions": [
    {
      "id": 11,
      "type": "KbPositionArticle",
      "amount": "1.0000",
      "unit_id": null,
      "account_id": 79,
      "unit_name": null,
      "tax_id": 1,
      "tax_value": "8.00",
      "text": "Webhosting: wh-2013",
      "unit_price": "120.0000",
      "discount_in_percent": null,
      "position_total": "120.0000",
      "pos": "1",
      "internal_pos": 1,
      "parent_id": null,
      "is_optional": false,
      "article_id": 1
    },
    {
      "id": 17,
      "type": "KbPositionCustom",
      "amount": "1.0000",
      "unit_id": null,
      "account_id": 79,
      "unit_name": null,
      "tax_id": 1,
      "tax_value": "8.00",
      "text": "",
      "unit_price": "12.0000",
      "discount_in_percent": null,
      "position_total": "12.0000",
      "pos": "2",
      "internal_pos": 2,
      "parent_id": null,
      "is_optional": false
    }
  ],
  "network_link": ""
}

Create order

POST /kb_order
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "contact_id": 1,
  "positions": [
    {
      "type": "KbPositionArticle",
      "unit_price": 120,
      "article_id": 1,
      "tax_id": 1,
      "amount": 1
    },
    {
      "type": "KbPositionCustom",
      "unit_price": 12,
      "amount": 1,
      "tax_id": 1
    }
  ]
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
contact_id required Resource contact
user_id required Resource user
api_reference optional string (80) This field can only be read and edited by the api. It can be used to save references to other systems.
bank_account_id optional Resource bank_account
contact_address_id optional Resource contact_address
contact_address_manual optional string (500)
contact_sub_id optional Resource contact
currency_id optional Resource currency
delivery_address_id optional Resource contact_address
delivery_address_manual optional string (500)
delivery_address_type optional integer
footer optional string (4000)
header optional string (4000)
is_compact_view optional boolean
is_valid_from optional date (Format yyyy-mm-dd)
language_id optional Resource language
logopaper_id optional Resource logopaper
mwst_is_net optional boolean This value affects the total if the field mwst_type has been set to 0.
false = Taxes are included in the total
true = Taxes will be added to the total
mwst_type optional integer Possible values
0 = including taxes
1 = excluding taxes
2 = exempt from taxes
nb_decimals_amount optional integer
nb_decimals_price optional integer
payment_type_id optional Resource payment_type
pr_project_id optional Resource pr_project
show_position_taxes optional boolean
terms_of_payment_text optional string (2000)
title optional string (80)

The following scopes are needed:

  • kb_order_edit
Status: 201 Created
X-Authenticated-User: apiextract_1
Etag: 48282fade28cb11bf1570a260595323a
Content-Length: 1576
Content-Type: application/json
{
  "id": 3,
  "document_nr": "AU-00003",
  "title": "",
  "contact_id": 1,
  "contact_sub_id": null,
  "user_id": 1,
  "project_id": null,
  "logopaper_id": 1,
  "language_id": 1,
  "bank_account_id": 1,
  "currency_id": 1,
  "payment_type_id": 1,
  "header": "Sehr geehrte Damen und HerrenVielen Dank für Ihren Auftrag, welchen wir hiermit gerne bestätigen.",
  "footer": "Bei Fragen stehen wir Ihnen gerne zur Verfügung.Freundliche Grüsse",
  "total_gross": "132",
  "total_net": "132",
  "total_taxes": "10.5600",
  "total": "142.55",
  "mwst_type": 0,
  "mwst_is_net": true,
  "show_position_taxes": false,
  "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": 5,
  "is_recurring": false,
  "api_reference": "",
  "viewed_by_client_at": null,
  "updated_at": "2015-09-18 15:41:55",
  "taxs": [
    {
      "percentage": "8.00",
      "value": "10.5600"
    }
  ],
  "positions": [
    {
      "id": 11,
      "type": "KbPositionArticle",
      "amount": "1",
      "unit_id": null,
      "account_id": 79,
      "unit_name": null,
      "tax_id": 1,
      "tax_value": "8.00",
      "text": "Webhosting: wh-2013",
      "unit_price": "120",
      "discount_in_percent": null,
      "position_total": "120",
      "pos": "1",
      "internal_pos": 1,
      "parent_id": null,
      "is_optional": false,
      "article_id": 1
    },
    {
      "id": 17,
      "type": "KbPositionCustom",
      "amount": "1",
      "unit_id": null,
      "account_id": 79,
      "unit_name": null,
      "tax_id": 1,
      "tax_value": "8.00",
      "text": "",
      "unit_price": "12",
      "discount_in_percent": null,
      "position_total": "12",
      "pos": "2",
      "internal_pos": 2,
      "parent_id": null,
      "is_optional": false
    }
  ],
  "network_link": ""
}

Overwrite order

PUT /kb_order/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "contact_id": 2,
  "logopaper_id": "1",
  "language_id": "1",
  "bank_account_id": "1",
  "currency_id": "1",
  "mwst_type": "0",
  "nb_decimals_amount": "2",
  "nb_decimals_price": "2",
  "is_valid_from": "2015-09-18",
  "is_compact_view": "false",
  "show_position_taxes": false,
  "payment_type_id": "1"
}
Name Required Type Description
callback optional string
Name Required Type Description
bank_account_id required Resource bank_account
contact_id required Resource contact
currency_id required Resource currency
is_compact_view required boolean
is_valid_from required date (Format yyyy-mm-dd)
language_id required Resource language
logopaper_id required Resource logopaper
mwst_is_net required boolean This value affects the total if the field mwst_type has been set to 0.
false = Taxes are included in the total
true = Taxes will be added to the total
mwst_type required integer Possible values
0 = including taxes
1 = excluding taxes
2 = exempt from taxes
nb_decimals_amount required integer
nb_decimals_price required integer
payment_type_id required Resource payment_type
show_position_taxes required boolean
user_id required Resource user
api_reference optional string (80) This field can only be read and edited by the api. It can be used to save references to other systems.
contact_address_id optional Resource contact_address
contact_address_manual optional string (500)
contact_sub_id optional Resource contact
delivery_address_id optional Resource contact_address
delivery_address_manual optional string (500)
delivery_address_type optional integer
footer optional string (4000)
header optional string (4000)
pr_project_id optional Resource pr_project
terms_of_payment_text optional string (2000)
title optional string (80)

The following scopes are needed:

  • kb_order_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 04f473ecc76376ea9d9048f8917458e0
Content-Length: 1298
Content-Type: application/json
{
  "id": 3,
  "document_nr": "AU-00003",
  "title": "",
  "contact_id": 2,
  "contact_sub_id": null,
  "user_id": 1,
  "project_id": null,
  "logopaper_id": 1,
  "language_id": 1,
  "bank_account_id": 1,
  "currency_id": 1,
  "payment_type_id": 1,
  "header": "",
  "footer": "",
  "total_gross": "132",
  "total_net": "132",
  "total_taxes": "10.5600",
  "total": "142.55",
  "mwst_type": 0,
  "mwst_is_net": true,
  "show_position_taxes": false,
  "is_valid_from": "2015-09-18",
  "contact_address": "",
  "delivery_address_type": null,
  "delivery_address": "",
  "kb_item_status_id": 5,
  "is_recurring": false,
  "api_reference": "",
  "viewed_by_client_at": null,
  "updated_at": "2015-09-18 15:41:56",
  "taxs": [
    {
      "percentage": "8.00",
      "value": "10.5600"
    }
  ],
  "positions": [
    {
      "id": 11,
      "type": "KbPositionArticle",
      "amount": "1.0000",
      "unit_id": null,
      "account_id": 79,
      "unit_name": null,
      "tax_id": 1,
      "tax_value": "8.00",
      "text": "Webhosting: wh-2013",
      "unit_price": "120.0000",
      "discount_in_percent": null,
      "position_total": "120.0000",
      "pos": "1",
      "internal_pos": 1,
      "parent_id": null,
      "is_optional": false,
      "article_id": 1
    },
    {
      "id": 17,
      "type": "KbPositionCustom",
      "amount": "1.0000",
      "unit_id": null,
      "account_id": 79,
      "unit_name": null,
      "tax_id": 1,
      "tax_value": "8.00",
      "text": "",
      "unit_price": "12.0000",
      "discount_in_percent": null,
      "position_total": "12.0000",
      "pos": "2",
      "internal_pos": 2,
      "parent_id": null,
      "is_optional": false
    }
  ],
  "network_link": ""
}

Edit order

POST /kb_order/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "contact_id": 2
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
api_reference optional string (80) This field can only be read and edited by the api. It can be used to save references to other systems.
bank_account_id optional Resource bank_account
contact_address_id optional Resource contact_address
contact_address_manual optional string (500)
contact_id optional Resource contact
contact_sub_id optional Resource contact
currency_id optional Resource currency
delivery_address_id optional Resource contact_address
delivery_address_manual optional string (500)
delivery_address_type optional integer
footer optional string (4000)
header optional string (4000)
is_compact_view optional boolean
is_valid_from optional date (Format yyyy-mm-dd)
language_id optional Resource language
logopaper_id optional Resource logopaper
mwst_is_net optional boolean This value affects the total if the field mwst_type has been set to 0.
false = Taxes are included in the total
true = Taxes will be added to the total
mwst_type optional integer Possible values
0 = including taxes
1 = excluding taxes
2 = exempt from taxes
nb_decimals_amount optional integer
nb_decimals_price optional integer
payment_type_id optional Resource payment_type
pr_project_id optional Resource pr_project
show_position_taxes optional boolean
terms_of_payment_text optional string (2000)
title optional string (80)
user_id optional Resource user

The following scopes are needed:

  • kb_order_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 04f473ecc76376ea9d9048f8917458e0
Content-Length: 1298
Content-Type: application/json
{
  "id": 3,
  "document_nr": "AU-00003",
  "title": "",
  "contact_id": 2,
  "contact_sub_id": null,
  "user_id": 1,
  "project_id": null,
  "logopaper_id": 1,
  "language_id": 1,
  "bank_account_id": 1,
  "currency_id": 1,
  "payment_type_id": 1,
  "header": "",
  "footer": "",
  "total_gross": "132",
  "total_net": "132",
  "total_taxes": "10.5600",
  "total": "142.55",
  "mwst_type": 0,
  "mwst_is_net": true,
  "show_position_taxes": false,
  "is_valid_from": "2015-09-18",
  "contact_address": "",
  "delivery_address_type": null,
  "delivery_address": "",
  "kb_item_status_id": 5,
  "is_recurring": false,
  "api_reference": "",
  "viewed_by_client_at": null,
  "updated_at": "2015-09-18 15:41:56",
  "taxs": [
    {
      "percentage": "8.00",
      "value": "10.5600"
    }
  ],
  "positions": [
    {
      "id": 11,
      "type": "KbPositionArticle",
      "amount": "1.0000",
      "unit_id": null,
      "account_id": 79,
      "unit_name": null,
      "tax_id": 1,
      "tax_value": "8.00",
      "text": "Webhosting: wh-2013",
      "unit_price": "120.0000",
      "discount_in_percent": null,
      "position_total": "120.0000",
      "pos": "1",
      "internal_pos": 1,
      "parent_id": null,
      "is_optional": false,
      "article_id": 1
    },
    {
      "id": 17,
      "type": "KbPositionCustom",
      "amount": "1.0000",
      "unit_id": null,
      "account_id": 79,
      "unit_name": null,
      "tax_id": 1,
      "tax_value": "8.00",
      "text": "",
      "unit_price": "12.0000",
      "discount_in_percent": null,
      "position_total": "12.0000",
      "pos": "2",
      "internal_pos": 2,
      "parent_id": null,
      "is_optional": false
    }
  ],
  "network_link": ""
}

Delete order

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

The following scopes are needed:

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

Create delivery from order

The Payload (Content Body) may be left empty to create a delivery which includes all remaining open positions.

POST /kb_order/1/delivery
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "positions": [
    {
      "id": 3,
      "type": "KbPositionCustom",
      "amount": 1
    }
  ]
}
Name Required Type Description
callback optional string Javascript-Callback
Name Required Type Description
positions required undefined

The following scopes are needed:

  • kb_order_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 4168043e8c9d0a471196eea426dc234a
Content-Length: 1062
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",
  "total_net": "0",
  "total_taxes": "0.0000",
  "total": "0",
  "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
    }
  ]
}

Create invoice from order

The Payload (Content Body) may be left empty to create an invoice which includes all remaining open positions.

POST /kb_order/1/invoice
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "positions": [
    {
      "id": 3,
      "type": "KbPositionCustom",
      "amount": 1
    }
  ]
}
Name Required Type Description
callback optional string Javascript-Callback
Name Required Type Description
positions required undefined

The following scopes are needed:

  • kb_order_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: a1df9353f7828761431fc93f2589926f
Content-Length: 1258
Content-Type: application/json
{
  "id": 4,
  "document_nr": "RE-00004",
  "title": null,
  "contact_id": 1,
  "contact_sub_id": null,
  "user_id": 1,
  "project_id": null,
  "logopaper_id": 1,
  "language_id": 1,
  "bank_account_id": 1,
  "currency_id": 1,
  "payment_type_id": 1,
  "header": "Sehr geehrte Damen und HerrenWir erlauben uns, Ihnen wie folgt in Rechnung zu stellen:",
  "footer": "Bei Fragen stehen wir Ihnen gerne zur Verfügung.Freundliche Grüsse",
  "total_gross": "3.285",
  "total_net": "3.3",
  "total_taxes": "0.0000",
  "total_received_payments": "0",
  "total_credit_vouchers": "0",
  "total_remaining_payments": "3.3000",
  "total": "3.3",
  "mwst_type": 0,
  "mwst_is_net": true,
  "show_position_taxes": false,
  "is_valid_from": "2015-09-18",
  "is_valid_to": "2015-10-17",
  "contact_address": "Muster AG\nMüllerstrasse 22\n8004 Zürich",
  "kb_item_status_id": 7,
  "api_reference": null,
  "viewed_by_client_at": null,
  "updated_at": "2015-09-18 15:41:59",
  "esr_id": 4,
  "taxs": [
    {
      "percentage": "0.00",
      "value": "0.0000"
    }
  ],
  "positions": [
    {
      "id": 18,
      "type": "KbPositionCustom",
      "amount": "1",
      "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": "3.285",
      "pos": "1",
      "internal_pos": 1,
      "parent_id": null,
      "is_optional": false
    }
  ],
  "network_link": ""
}

Show order pdf

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

The following scopes are needed:

  • kb_order_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 13109
Content-Type: application/json
{
  "name": "au-00003.pdf",
  "size": 9750,
  "mime": "application/pdf",
  "content": "JVBERi0xLjcKJeLjz9MKNiAwIG9iago8PCAvVHlwZSAvUGFnZSAvUGFyZW50IDEgMCBSIC9MYXN0TW9kaWZpZWQgKEQ6MjAxNTA5MTgxNTQxNTYrMDInMDAnKSAvUmVzb3VyY2VzIDIgMCBSIC9NZWRpYUJveCBbMC4wMDAwMDAgMC4wMDAwMDAgNTk1LjI3NjAwMCA4NDEuODkwMDAwXSAvQ3JvcEJveCBbMC4wMDAwMDAgMC4wMDAwMDAgNTk1LjI3NjAwMCA4NDEuODkwMDAwXSAvQmxlZWRCb3ggWzAuMDAwMDAwIDAuMDAwMDAwIDU5NS4yNzYwMDAgODQxLjg5MDAwMF0gL1RyaW1Cb3ggWzAuMDAwMDAwIDAuMDAwMDAwIDU5NS4yNzYwMDAgODQxLjg5MDAwMF0gL0FydEJveCBbMC4wMDAwMDAgMC4wMDAwMDAgNTk1LjI3NjAwMCA4NDEuODkwMDAwXSAvQ29udGVudHMgNyAwIFIgL1JvdGF0ZSAwIC9Hcm91cCA8PCAvVHlwZSAvR3JvdXAgL1MgL1RyYW5zcGFyZW5jeSAvQ1MgL0RldmljZVJHQiA+PiAvQW5ub3RzIFsgNSAwIFIgXSAvUFogMSA+PgplbmRvYmoKNyAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggOTg3Pj4gc3RyZWFtCnic7VtNT9tAEL3nV+ylEhxYdvZ7e2uhgFArAU3VA3AoJISiAiVQRf33nU1CsrZDPhyHXVInsmJt1uPnmeeZNxuHUWUYvkiPMHKI2w05PcePFm77uHUaH5tkew8IcMr6L9K8Ip+aDVb2wIcXv+gbgr7Bm5GVBwL9acS/n3czH5e3je3m0Wcgu/fk+Nk4y9o+xndpxMNhN8/o6LzFnZP9+SFMOhcnACs4WdHsS1fGNTdSkeLOyT5pKDTCheacKGkpMxokJ7cNpQFnMa4y478aX6fBm3qmASmmzOl2CF4Bwu6O3dHDK/CjAUqhcBcsONJskdON95vnpHnop01lyuqggZZUMielK2ADdJyjnIGKDVIwTUGCEQk6UIKjihulig788ufxqd0lBz/uHmOjDBjIBTUGAFgiDgwZmMPWn8hjAwzZl5rzQvblsH34tuWnigzEeZMpGEyazFiTS6bjcZ9Mh5l8kZQ949syFqtHsUwo3z4a1Eow0D1kizvtqycTgbZB5TPDwHI3w3p5UFhBrbbJezDELDmj2sqFMQc2UHUJJjLiEC28BCxG5nSMysE1SsOocZyJYd0mOwd7QdaMEIwqj6kaeQmdPg/yBS2+Hoo4ak0NCrFUnDpnR9SEigTHitwXnbKlXW4VVVjohi63ZpwNvrcvru8fn37edQLfrzX9Al9IoEYagUlyoHdJ73oLO0IRkYZhoQKDklU6bB9KFyphqEZ1O6lQpRENgdnAQF+CFbIBzq24UFXK6ajUkFQLm4/rIszgkhqbMjOk0FSbyczgLDo3QjUoqAK5TDB8IjKFcKYUjEBPJhiMKo95VeThsoQU+IVT3rGZZYlgfLDGW2vRVWhR4Mhwa6Qd0Lqqhbn1qjtcOKp8IvhPJEmOFLUkWakkcdQ4ljAzQkmSZwaPTo3wHrOoSAqeXEiRaJSHPOVYBIokvVishyBhuCu0VLnfSYLx9RAkaSXx6taaymGLWEIY5ldZ0AYz81Za8YuqzyQm/sWLcMzmWVNeLDTV3yFzN9xprNgG5U1Yi2CFT7eD8iZy9a1UBOqaWGm+rmvYiuNWwXq/ML68jHUisTj3XVVPuSxd/CwrtdqfVuCjFj9tqJWQvAczD1AwbJuVWWZB5S21avlbEBCQrlu1pVs1YRi1nkc226oF43WrVrdqFVarulWrW7W6VcuXN2UpJt5xeZOcKlW3anFqov+hWk6oiePxmTUxa49R8E+g87y90bi3N/4v1qtyU0zk5mgA0XLVB+N5eXTfa3fbLXLxlzR3jnb3yNlGr9ejT5e/W1f0vts52ww4uwr64at6o/8AM8o1XwplbmRzdHJlYW0KZW5kb2JqCjEgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFsgNiAwIFIgXSAvQ291bnQgMSA+PgplbmRvYmoKMyAwIG9iago8PC9UeXBlIC9Gb250IC9TdWJ0eXBlIC9UeXBlMSAvQmFzZUZvbnQgL0hlbHZldGljYSAvTmFtZSAvRjEgL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcgPj4KZW5kb2JqCjQgMCBvYmoKPDwvVHlwZSAvRm9udCAvU3VidHlwZSAvVHlwZTEgL0Jhc2VGb250IC9IZWx2ZXRpY2EtQm9sZCAvTmFtZSAvRjIgL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcgPj4KZW5kb2JqCjggMCBvYmoKPDwvRmlsdGVyIC9GbGF0ZURlY29kZSAvVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovRm9ybVR5cGUgMQovQkJveCBbMC4wMCAwLjAwIDU5NS4yOCA4NDEuODldCi9SZXNvdXJjZXMgCjw8L1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQiAvSW1hZ2VDIC9JbWFnZUkgXQovRm9udCA8PC9GMSA5IDAgUgovRjIgMTAgMCBSCj4+L1hPYmplY3QgPDwvSTAgMTEgMCBSCi9JMSAxMiAwIFIKPj4+Pi9Hcm91cCA8PC9UeXBlL0dyb3VwL1MvVHJhbnNwYXJlbmN5Pj4KL0xlbmd0aCAzNzUgPj4Kc3RyZWFtCnicvZRNT8JAEIbv/oo5wmXYj+6XR0QQEhMIvQGHAsuHQpGlptFf75ZWREVRDp120umbzptnNt0lKBTxASkQ6Ph8gMHIP6Y+Wz7nV/UQak0KlCHZB4QzuA2vyKWNhaw+q1ug8l3Jro+3gFIkjEvGQBmFIuD+hskaam0KjQ30ckf21fE84BYIcsoVEycKNwfv682c1wrj1PtmaoFklASl/XhGcE4hnMKgcv+8S6yD2dKtqyMIO1lH74eZSyJUHKU23AQ5YXPpdgn0E2dtcoRYEowUSLUIhMphaPkEQvrloIKRnMBk3/UThFa0Wtm4fJ5AI1VKaJ7z9CeL1C5f/80hAkP8TN+L3zgERy10trW4QKm4DGROUY/ixzha22sofuhMKJuJKaTSKGJypna8iMbWHZDuonh3hLQ9HDiX7LIzqPwkKkPNRSZQZGxf7EG7m9Q6O4XxC4Q33UYThpU0TTGZPE1nuHHzYfUI+y9refr48HFpK7wBsdNRqAplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvVHlwZSAvRm9udCAvU3VidHlwZSAvVHlwZTEgL0Jhc2VGb250IC9IZWx2ZXRpY2EgL05hbWUgL0YxIC9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nID4+ZW5kb2JqCjEwIDAgb2JqCjw8L1R5cGUgL0ZvbnQgL1N1YnR5cGUgL1R5cGUxIC9CYXNlRm9udCAvSGVsdmV0aWNhLUJvbGQgL05hbWUgL0YyIC9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nID4+ZW5kb2JqCjExIDAgb2JqCjw8L1R5cGUgL1hPYmplY3QgL1N1YnR5cGUgL0ltYWdlIC9XaWR0aCAxNiAvSGVpZ2h0IDE2IC9Db2xvclNwYWNlIC9EZXZpY2VHcmF5IC9CaXRzUGVyQ29tcG9uZW50IDggL0ZpbHRlciAvRmxhdGVEZWNvZGUgL0RlY29kZVBhcm1zIDw8L1ByZWRpY3RvciAxNSAvQ29sb3JzIDEgL0JpdHNQZXJDb21wb25lbnQgOCAvQ29sdW1ucyAxNiA+Pi9MZW5ndGggNjkgPj5zdHJlYW0KGNNlj9sNADAIAm3ibKzJqPSZppb7k4BKxCBBicjYNOiAtmbqwqlADxh5FbIapoVVYOjDBYvYUjtrj/nrVu6r3wGlO79JCmVuZHN0cmVhbQplbmRvYmoKMTIgMCBvYmoKPDwvVHlwZSAvWE9iamVjdCAvU3VidHlwZSAvSW1hZ2UgL1dpZHRoIDE2IC9IZWlnaHQgMTYgL1NNYXNrIDExIDAgUgovQ29sb3JTcGFjZSBbL0luZGV4ZWQgL0RldmljZVJHQiAxNjQgMTMgMCBSCl0KL0JpdHNQZXJDb21wb25lbnQgOCAvRmlsdGVyIC9GbGF0ZURlY29kZSAvRGVjb2RlUGFybXMgPDwvUHJlZGljdG9yIDE1IC9Db2xvcnMgMSAvQml0c1BlckNvbXBvbmVudCA4IC9Db2x1bW5zIDE2ID4+L0xlbmd0aCAyNTcgPj5zdHJlYW0KGNNjYAACRiZmFlY2dg4GCOBk5OLm4eXjFxAUEobwRUTFxCUkpaRlZOXkQepFFBTFlZSVVVTV1DU0gXwtbUVxHSllXT19A0NDI2MGJhMxIN/UTN/cwtLK2saWgdlOUUnK3sHBwdHJ2cXVzZ3Bw1Pcy9vH18HBzz8gMCg4hCE0LDwiMirawSEmNi4+ITGJgS05JTUt3dHBISMzKzsnN4+BPb+gsKi4xMGhtKy8orKqmoGjpjYyqq7ewaGhsam5pbWNgUGovaOzC2iLQ3dPb18/0KXCchMmdjlPmlw2Zeq06TNAnpGfOWv2nLnz5i9Y2D8D6l/jRe6Ll+RVt4HYAJwfQLUKZW5kc3RyZWFtCmVuZG9iagoxMyAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggNTA2ID4+c3RyZWFtCnicAe8BEP4AAAAlTKQmTaUmTqc6YLU4X7QnUasoUqwoU64lS6NDZ7hujtRqjNlbgdVUfNJUe9FJcMg0X7opVrEpV7Jhgstsj9s9a9E0ZtBBcNNBcNQ0aNI3atJAbdI4ZMcqWbUqWrZjiNk0ZdA0ZtHy9vw1atM2a9Q2bNQ4bdUzZsorXLlEZ7htj9s0Z9Hz9vw3btU3b9Y4cNc4cdgwZMQsX71vjtU1a9M2bdU2cNc2cdg3ctk3c9o4dNo2b9MtYcBrjdk0adP///8ratcubtkwcdoxctsycts5ctouZMM7YbVcgtUyZtEoYNAiXM8kYdIxcds0dt03et44fN84fOBFf982bMw5YLVWfdMuYs8dVsweWM4jX9EoZdQ2ed46f+E+g+M/heVAhuVRjeQ6ctBRedAaUcocVcwgW88lYtM8gOJBh+VFjehHkOpIkepinekxbM0+Z8QdVModV80iXtAnZdQubdhAh+VGj+lMlu1Pm+9Vn/Bln+cyb9EvW7gvXsspZ9UvcNpEjOhLlu1Sn/FXpvV7u/VMid8zcdQvXMInW84kYNIqaNZOme9WpfR8wfpure80ddkqW8YmYNI3et8+hORTnO95ufRsq+41eNw1d9srXLgqX8IrZtE2cNpCfN5PiuNfmuhineZLiN4tYb81a8w5cc/kJPwwCmVuZHN0cmVhbQplbmRvYmoKMiAwIG9iago8PCAvUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VCIC9JbWFnZUMgL0ltYWdlSV0gL0ZvbnQgPDwgL0YxIDMgMCBSIC9GMiA0IDAgUiA+PiAvWE9iamVjdCA8PC9UUEwxIDggMCBSID4+ID4+CmVuZG9iago1IDAgb2JqCjw8L1R5cGUgL0Fubm90IC9TdWJ0eXBlIC9MaW5rIC9SZWN0IFswLjAwMDAwMCAxLjAwMDAwMCAxNi4xNzAwMDAgMi4xNTYwMDBdIC9Db250ZW50cyAo/v8AaAB0AHQAcAA6AC8ALwB3AHcAdwAuAHQAYwBwAGQAZgAuAG8AcgBnKSAvUCA2IDAgUiAvTk0gKDAwMDEtMDAwMCkgL00gKEQ6MjAxNTA5MTgxNTQxNTYrMDInMDAnKSAvRiA0IC9Cb3JkZXIgWzAgMCAwXSAvQSA8PC9TIC9VUkkgL1VSSSAoaHR0cDovL3d3dy50Y3BkZi5vcmcpPj4gL0ggL0k+PgplbmRvYmoKMTQgMCBvYmoKPDwgL1Byb2R1Y2VyICj+/wBUAEMAUABEAEYAIAA2AC4AMAAuADAANQA5ACAAXCgAaAB0AHQAcAA6AC8ALwB3AHcAdwAuAHQAYwBwAGQAZgAuAG8AcgBnAFwpKSAvQ3JlYXRpb25EYXRlIChEOjIwMTUwOTE4MTU0MTU2KzAyJzAwJykgL01vZERhdGUgKEQ6MjAxNTA5MTgxNTQxNTYrMDInMDAnKSAvVHJhcHBlZCAvRmFsc2UgPj4KZW5kb2JqCjE1IDAgb2JqCjw8IC9UeXBlIC9NZXRhZGF0YSAvU3VidHlwZSAvWE1MIC9MZW5ndGggNDIyNSA+PiBzdHJlYW0KPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4KPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNC4yLjEtYzA0MyA1Mi4zNzI3MjgsIDIwMDkvMDEvMTgtMTU6MDg6MDQiPgoJPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KCQk8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczpkYz0iaHR0cDovL3B1cmwub3JnL2RjL2VsZW1lbnRzLzEuMS8iPgoJCQk8ZGM6Zm9ybWF0PmFwcGxpY2F0aW9uL3BkZjwvZGM6Zm9ybWF0PgoJCQk8ZGM6dGl0bGU+CgkJCQk8cmRmOkFsdD4KCQkJCQk8cmRmOmxpIHhtbDpsYW5nPSJ4LWRlZmF1bHQiPjwvcmRmOmxpPgoJCQkJPC9yZGY6QWx0PgoJCQk8L2RjOnRpdGxlPgoJCQk8ZGM6Y3JlYXRvcj4KCQkJCTxyZGY6U2VxPgoJCQkJCTxyZGY6bGk+PC9yZGY6bGk+CgkJCQk8L3JkZjpTZXE+CgkJCTwvZGM6Y3JlYXRvcj4KCQkJPGRjOmRlc2NyaXB0aW9uPgoJCQkJPHJkZjpBbHQ+CgkJCQkJPHJkZjpsaSB4bWw6bGFuZz0ieC1kZWZhdWx0Ij48L3JkZjpsaT4KCQkJCTwvcmRmOkFsdD4KCQkJPC9kYzpkZXNjcmlwdGlvbj4KCQkJPGRjOnN1YmplY3Q+CgkJCQk8cmRmOkJhZz4KCQkJCQk8cmRmOmxpPjwvcmRmOmxpPgoJCQkJPC9yZGY6QmFnPgoJCQk8L2RjOnN1YmplY3Q+CgkJPC9yZGY6RGVzY3JpcHRpb24+CgkJPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIj4KCQkJPHhtcDpDcmVhdGVEYXRlPjIwMTUtMDktMThUMTU6NDE6NTYrMDI6MDA8L3htcDpDcmVhdGVEYXRlPgoJCQk8eG1wOkNyZWF0b3JUb29sPjwveG1wOkNyZWF0b3JUb29sPgoJCQk8eG1wOk1vZGlmeURhdGU+MjAxNS0wOS0xOFQxNTo0MTo1NiswMjowMDwveG1wOk1vZGlmeURhdGU+CgkJCTx4bXA6TWV0YWRhdGFEYXRlPjIwMTUtMDktMThUMTU6NDE6NTYrMDI6MDA8L3htcDpNZXRhZGF0YURhdGU+CgkJPC9yZGY6RGVzY3JpcHRpb24+CgkJPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6cGRmPSJodHRwOi8vbnMuYWRvYmUuY29tL3BkZi8xLjMvIj4KCQkJPHBkZjpLZXl3b3Jkcz48L3BkZjpLZXl3b3Jkcz4KCQkJPHBkZjpQcm9kdWNlcj5UQ1BERiA2LjAuMDU5IChodHRwOi8vd3d3LnRjcGRmLm9yZyk8L3BkZjpQcm9kdWNlcj4KCQk8L3JkZjpEZXNjcmlwdGlvbj4KCQk8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyI+CgkJCTx4bXBNTTpEb2N1bWVudElEPnV1aWQ6ZTY4YzExMzktZDY0OC1lY2U1LWUwZDgtYmYyZjYyMDhmZmI1PC94bXBNTTpEb2N1bWVudElEPgoJCQk8eG1wTU06SW5zdGFuY2VJRD51dWlkOmU2OGMxMTM5LWQ2NDgtZWNlNS1lMGQ4LWJmMmY2MjA4ZmZiNTwveG1wTU06SW5zdGFuY2VJRD4KCQk8L3JkZjpEZXNjcmlwdGlvbj4KCQk8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczpwZGZhRXh0ZW5zaW9uPSJodHRwOi8vd3d3LmFpaW0ub3JnL3BkZmEvbnMvZXh0ZW5zaW9uLyIgeG1sbnM6cGRmYVNjaGVtYT0iaHR0cDovL3d3dy5haWltLm9yZy9wZGZhL25zL3NjaGVtYSMiIHhtbG5zOnBkZmFQcm9wZXJ0eT0iaHR0cDovL3d3dy5haWltLm9yZy9wZGZhL25zL3Byb3BlcnR5IyI+CgkJCTxwZGZhRXh0ZW5zaW9uOnNjaGVtYXM+CgkJCQk8cmRmOkJhZz4KCQkJCQk8cmRmOmxpIHJkZjpwYXJzZVR5cGU9IlJlc291cmNlIj4KCQkJCQkJPHBkZmFTY2hlbWE6bmFtZXNwYWNlVVJJPmh0dHA6Ly9ucy5hZG9iZS5jb20vcGRmLzEuMy88L3BkZmFTY2hlbWE6bmFtZXNwYWNlVVJJPgoJCQkJCQk8cGRmYVNjaGVtYTpwcmVmaXg+cGRmPC9wZGZhU2NoZW1hOnByZWZpeD4KCQkJCQkJPHBkZmFTY2hlbWE6c2NoZW1hPkFkb2JlIFBERiBTY2hlbWE8L3BkZmFTY2hlbWE6c2NoZW1hPgoJCQkJCTwvcmRmOmxpPgoJCQkJCTxyZGY6bGkgcmRmOnBhcnNlVHlwZT0iUmVzb3VyY2UiPgoJCQkJCQk8cGRmYVNjaGVtYTpuYW1lc3BhY2VVUkk+aHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLzwvcGRmYVNjaGVtYTpuYW1lc3BhY2VVUkk+CgkJCQkJCTxwZGZhU2NoZW1hOnByZWZpeD54bXBNTTwvcGRmYVNjaGVtYTpwcmVmaXg+CgkJCQkJCTxwZGZhU2NoZW1hOnNjaGVtYT5YTVAgTWVkaWEgTWFuYWdlbWVudCBTY2hlbWE8L3BkZmFTY2hlbWE6c2NoZW1hPgoJCQkJCQk8cGRmYVNjaGVtYTpwcm9wZXJ0eT4KCQkJCQkJCTxyZGY6U2VxPgoJCQkJCQkJCTxyZGY6bGkgcmRmOnBhcnNlVHlwZT0iUmVzb3VyY2UiPgoJCQkJCQkJCQk8cGRmYVByb3BlcnR5OmNhdGVnb3J5PmludGVybmFsPC9wZGZhUHJvcGVydHk6Y2F0ZWdvcnk+CgkJCQkJCQkJCTxwZGZhUHJvcGVydHk6ZGVzY3JpcHRpb24+VVVJRCBiYXNlZCBpZGVudGlmaWVyIGZvciBzcGVjaWZpYyBpbmNhcm5hdGlvbiBvZiBhIGRvY3VtZW50PC9wZGZhUHJvcGVydHk6ZGVzY3JpcHRpb24+CgkJCQkJCQkJCTxwZGZhUHJvcGVydHk6bmFtZT5JbnN0YW5jZUlEPC9wZGZhUHJvcGVydHk6bmFtZT4KCQkJCQkJCQkJPHBkZmFQcm9wZXJ0eTp2YWx1ZVR5cGU+VVJJPC9wZGZhUHJvcGVydHk6dmFsdWVUeXBlPgoJCQkJCQkJCTwvcmRmOmxpPgoJCQkJCQkJPC9yZGY6U2VxPgoJCQkJCQk8L3BkZmFTY2hlbWE6cHJvcGVydHk+CgkJCQkJPC9yZGY6bGk+CgkJCQkJPHJkZjpsaSByZGY6cGFyc2VUeXBlPSJSZXNvdXJjZSI+CgkJCQkJCTxwZGZhU2NoZW1hOm5hbWVzcGFjZVVSST5odHRwOi8vd3d3LmFpaW0ub3JnL3BkZmEvbnMvaWQvPC9wZGZhU2NoZW1hOm5hbWVzcGFjZVVSST4KCQkJCQkJPHBkZmFTY2hlbWE6cHJlZml4PnBkZmFpZDwvcGRmYVNjaGVtYTpwcmVmaXg+CgkJCQkJCTxwZGZhU2NoZW1hOnNjaGVtYT5QREYvQSBJRCBTY2hlbWE8L3BkZmFTY2hlbWE6c2NoZW1hPgoJCQkJCQk8cGRmYVNjaGVtYTpwcm9wZXJ0eT4KCQkJCQkJCTxyZGY6U2VxPgoJCQkJCQkJCTxyZGY6bGkgcmRmOnBhcnNlVHlwZT0iUmVzb3VyY2UiPgoJCQkJCQkJCQk8cGRmYVByb3BlcnR5OmNhdGVnb3J5PmludGVybmFsPC9wZGZhUHJvcGVydHk6Y2F0ZWdvcnk+CgkJCQkJCQkJCTxwZGZhUHJvcGVydHk6ZGVzY3JpcHRpb24+UGFydCBvZiBQREYvQSBzdGFuZGFyZDwvcGRmYVByb3BlcnR5OmRlc2NyaXB0aW9uPgoJCQkJCQkJCQk8cGRmYVByb3BlcnR5Om5hbWU+cGFydDwvcGRmYVByb3BlcnR5Om5hbWU+CgkJCQkJCQkJCTxwZGZhUHJvcGVydHk6dmFsdWVUeXBlPkludGVnZXI8L3BkZmFQcm9wZXJ0eTp2YWx1ZVR5cGU+CgkJCQkJCQkJPC9yZGY6bGk+CgkJCQkJCQkJPHJkZjpsaSByZGY6cGFyc2VUeXBlPSJSZXNvdXJjZSI+CgkJCQkJCQkJCTxwZGZhUHJvcGVydHk6Y2F0ZWdvcnk+aW50ZXJuYWw8L3BkZmFQcm9wZXJ0eTpjYXRlZ29yeT4KCQkJCQkJCQkJPHBkZmFQcm9wZXJ0eTpkZXNjcmlwdGlvbj5BbWVuZG1lbnQgb2YgUERGL0Egc3RhbmRhcmQ8L3BkZmFQcm9wZXJ0eTpkZXNjcmlwdGlvbj4KCQkJCQkJCQkJPHBkZmFQcm9wZXJ0eTpuYW1lPmFtZDwvcGRmYVByb3BlcnR5Om5hbWU+CgkJCQkJCQkJCTxwZGZhUHJvcGVydHk6dmFsdWVUeXBlPlRleHQ8L3BkZmFQcm9wZXJ0eTp2YWx1ZVR5cGU+CgkJCQkJCQkJPC9yZGY6bGk+CgkJCQkJCQkJPHJkZjpsaSByZGY6cGFyc2VUeXBlPSJSZXNvdXJjZSI+CgkJCQkJCQkJCTxwZGZhUHJvcGVydHk6Y2F0ZWdvcnk+aW50ZXJuYWw8L3BkZmFQcm9wZXJ0eTpjYXRlZ29yeT4KCQkJCQkJCQkJPHBkZmFQcm9wZXJ0eTpkZXNjcmlwdGlvbj5Db25mb3JtYW5jZSBsZXZlbCBvZiBQREYvQSBzdGFuZGFyZDwvcGRmYVByb3BlcnR5OmRlc2NyaXB0aW9uPgoJCQkJCQkJCQk8cGRmYVByb3BlcnR5Om5hbWU+Y29uZm9ybWFuY2U8L3BkZmFQcm9wZXJ0eTpuYW1lPgoJCQkJCQkJCQk8cGRmYVByb3BlcnR5OnZhbHVlVHlwZT5UZXh0PC9wZGZhUHJvcGVydHk6dmFsdWVUeXBlPgoJCQkJCQkJCTwvcmRmOmxpPgoJCQkJCQkJPC9yZGY6U2VxPgoJCQkJCQk8L3BkZmFTY2hlbWE6cHJvcGVydHk+CgkJCQkJPC9yZGY6bGk+CgkJCQk8L3JkZjpCYWc+CgkJCTwvcGRmYUV4dGVuc2lvbjpzY2hlbWFzPgoJCTwvcmRmOkRlc2NyaXB0aW9uPgoJPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KPD94cGFja2V0IGVuZD0idyI/PgplbmRzdHJlYW0KZW5kb2JqCjE2IDAgb2JqCjw8IC9UeXBlIC9DYXRhbG9nIC9WZXJzaW9uIC8xLjcgL1BhZ2VzIDEgMCBSIC9OYW1lcyA8PCA+PiAvVmlld2VyUHJlZmVyZW5jZXMgPDwgL0RpcmVjdGlvbiAvTDJSID4+IC9QYWdlTGF5b3V0IC9TaW5nbGVQYWdlIC9QYWdlTW9kZSAvVXNlTm9uZSAvT3BlbkFjdGlvbiBbNiAwIFIgL0ZpdEggbnVsbF0gL01ldGFkYXRhIDE1IDAgUiA+PgplbmRvYmoKeHJlZgowIDE3CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMTU0MCAwMDAwMCBuIAowMDAwMDA0MTM3IDAwMDAwIG4gCjAwMDAwMDE1OTkgMDAwMDAgbiAKMDAwMDAwMTcwNSAwMDAwMCBuIAowMDAwMDA0MjYyIDAwMDAwIG4gCjAwMDAwMDAwMTUgMDAwMDAgbiAKMDAwMDAwMDQ4MyAwMDAwMCBuIAowMDAwMDAxODE2IDAwMDAwIG4gCjAwMDAwMDI1MDMgMDAwMDAgbiAKMDAwMDAwMjYwOCAwMDAwMCBuIAowMDAwMDAyNzE5IDAwMDAwIG4gCjAwMDAwMDMwMjcgMDAwMDAgbiAKMDAwMDAwMzU2MCAwMDAwMCBuIAowMDAwMDA0NTMzIDAwMDAwIG4gCjAwMDAwMDQ3MzUgMDAwMDAgbiAKMDAwMDAwOTA0MyAwMDAwMCBuIAp0cmFpbGVyCjw8IC9TaXplIDE3IC9Sb290IDE2IDAgUiAvSW5mbyAxNCAwIFIgL0lEIFsgPGU2OGMxMTM5ZDY0OGVjZTVlMGQ4YmYyZjYyMDhmZmI1PiA8ZTY4YzExMzlkNjQ4ZWNlNWUwZDhiZjJmNjIwOGZmYjU+IF0gPj4Kc3RhcnR4cmVmCjkyNTIKJSVFT0YK"
}

List comments

GET /kb_order/1/comment
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:

  • 0
  • 1
  • 2

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 5295
Content-Type: application/json
[
  {
    "id": 2,
    "text": "API-Kommentar",
    "user_id": 1,
    "user_email": null,
    "user_name": "Hans Muster",
    "date": "2015-09-18 15:41:13",
    "is_public": false,
    "image": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABRVJREFUWAmdV0tMXFUYvq+Z4WWwGhJjSq2S0IZNZaM7CYnGTZdCdIm8YSMkTZcMSZcuXBCepSxNYNGF0aTGBIgbaxd0YVWIxmqTYiBpS3gM87h3/L7D/a/n3pl7gZ7kzHl9//c/zn/OuWMaZyzZbNZBLRG+sLDwtuu67aZpvslxuVx+atv2Rn9//18c61iOk4qZtChrQjg7O9sGpV9i/qOamhrHsiwF8TzPOD4+LmHte/RvDA0N/SoywhHXnmqAEM3MzFyHl99AsZHL5eg1FZZJjD66plNbW0tDOL4+ODj4rcjGKed8ogEgsFC9+fn5VpBu0mN4WIBcCgpDvFjnuAgj08BwcHVgYGBLOEJgbXASQ20i0lXrIL9VV1cnytNR5ZTx59LIjQIiYVLG50rUEXZD0w4CcJrl6enpC/DqT3h/AZ55nNRgFV3IlYG1AH0OY1pGRkaeC1cFGBOx1k1OTipFUH4ROqmcYQ0pJzFrhNgkljKU5ZpwRXBqGGuAgOFMVIFaEq+gCN0KIxQGEagqK9xsTzUAmH0oKKINkYliMYRkWqFVxVQqta/NVe2GSHWEEC8tLb1aKBSYA68htEEOcF3H0yCOMS858Ozo6KhlbGzshXDpeOnHRoCEPEI9PT0v0H8EbyjjiaAo5FjvE0MslD6icnJE1oVCtSEv9BWxempq6nXHcTZQm7GnZ4oAks8C9h+07X19fc+ES+eXfmwEVlZW1Bq8eSudTjeXSqVAOYXplV6FEHMmlLuQu4TmMueFSzB6G2tAd3e3Cvfh4eFvxWLxb0TAgidqn4WAnrHKmC0x8NyGzBMMf+dcV1dXsHUc6yXWAIDKq6urzvj4eA6cD3jPo7i6QomAEPprLt8LlAd4D46QAw5xgom2SQYYu7u7ShAn4PbBwQFlHdRYMn/NQfYbkFmkQFtbWxI++R7ANrhzc3MpPCr3wHUb7wHDrb4JSF6llIhBJO7g2+A7ypKjCi6YSowAUdvb2+LBw0DqlA6uiw1CWltbRTZW4lQDJITw6j4uJBLFygBjE4M9/4lA2UL240oog+NATC4mEr6I7iPB3svn8/wYsXU8MG4mk3FgwM/YsvdFRsdU68d6o4PxmillSKwsiLnEfQ4gkbksF0QmAMV0zmQAZNU5xl3wC8439yHkvc/Ns18gxh/Hnn1/XTVnNUCBcbM58PZ/13Um9LlGTGQ6cZhoAB+S5eVlG4moSPHBmQcb86GCVOZ8DM+/Q1nYVAnWpCuspdKOjg6rs7PTRV/CqM4yEvBd5EGa7wIN0XjovYfwZ2DINcw/xflXR4YYGrG2tmavr697GqcSD0gIYuIAEFw0+BZ4A7faO7jar4D4Q0h8gjZNZWgDWV8JjwrfC0ZpBfUHbMcmxo9HR0f/JYYF/M7ExIQL7Ek2c5KhkhsLt9dVTPWgfozaAq8a8Bqia8j/AQpSfygX6ADm1Xn13w2DdwKixTv8D+DvwZGl3t7eTYwDnaYoX1xcfAXgr7D2eX19vYGMVhXEDL9HBSjMfrYh5ZhTRYygjI+x0Vr8QGHFy0rcHTj1BQzZp24VRvzruYy9/bGhoeEiHh2ScxuYoPyaUXuI/rkLjUChHHOG1YEOEzqe4Lr+YHh4+LFKQii/i1uMyhmuDCqLEvIJTmbO+VtFtgQVeehqxm16F3TtJv52fdrU1PT13t6egdCcU8XLwbHVRmNjI9+Kz3ixbO3s7NxEuHJImsR74eXUVZXyoJNfOFv/AcihymlkznQ3AAAAAElFTkSuQmCCMTc0OQ==",
    "image_path": "http://my.easysys.local/img/profile_picture/j2cbWl-yp3zT9oOh9jHTAA/Ds8buEV0HXZsvuBm3df8SQ.png?type=thumb"
  },
  {
    "id": 38,
    "text": "Sample comment 1",
    "user_id": 1,
    "user_email": null,
    "user_name": "Hans Muster",
    "date": "2015-09-18 15:41:59",
    "is_public": false,
    "image": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABRVJREFUWAmdV0tMXFUYvq+Z4WWwGhJjSq2S0IZNZaM7CYnGTZdCdIm8YSMkTZcMSZcuXBCepSxNYNGF0aTGBIgbaxd0YVWIxmqTYiBpS3gM87h3/L7D/a/n3pl7gZ7kzHl9//c/zn/OuWMaZyzZbNZBLRG+sLDwtuu67aZpvslxuVx+atv2Rn9//18c61iOk4qZtChrQjg7O9sGpV9i/qOamhrHsiwF8TzPOD4+LmHte/RvDA0N/SoywhHXnmqAEM3MzFyHl99AsZHL5eg1FZZJjD66plNbW0tDOL4+ODj4rcjGKed8ogEgsFC9+fn5VpBu0mN4WIBcCgpDvFjnuAgj08BwcHVgYGBLOEJgbXASQ20i0lXrIL9VV1cnytNR5ZTx59LIjQIiYVLG50rUEXZD0w4CcJrl6enpC/DqT3h/AZ55nNRgFV3IlYG1AH0OY1pGRkaeC1cFGBOx1k1OTipFUH4ROqmcYQ0pJzFrhNgkljKU5ZpwRXBqGGuAgOFMVIFaEq+gCN0KIxQGEagqK9xsTzUAmH0oKKINkYliMYRkWqFVxVQqta/NVe2GSHWEEC8tLb1aKBSYA68htEEOcF3H0yCOMS858Ozo6KhlbGzshXDpeOnHRoCEPEI9PT0v0H8EbyjjiaAo5FjvE0MslD6icnJE1oVCtSEv9BWxempq6nXHcTZQm7GnZ4oAks8C9h+07X19fc+ES+eXfmwEVlZW1Bq8eSudTjeXSqVAOYXplV6FEHMmlLuQu4TmMueFSzB6G2tAd3e3Cvfh4eFvxWLxb0TAgidqn4WAnrHKmC0x8NyGzBMMf+dcV1dXsHUc6yXWAIDKq6urzvj4eA6cD3jPo7i6QomAEPprLt8LlAd4D46QAw5xgom2SQYYu7u7ShAn4PbBwQFlHdRYMn/NQfYbkFmkQFtbWxI++R7ANrhzc3MpPCr3wHUb7wHDrb4JSF6llIhBJO7g2+A7ypKjCi6YSowAUdvb2+LBw0DqlA6uiw1CWltbRTZW4lQDJITw6j4uJBLFygBjE4M9/4lA2UL240oog+NATC4mEr6I7iPB3svn8/wYsXU8MG4mk3FgwM/YsvdFRsdU68d6o4PxmillSKwsiLnEfQ4gkbksF0QmAMV0zmQAZNU5xl3wC8439yHkvc/Ns18gxh/Hnn1/XTVnNUCBcbM58PZ/13Um9LlGTGQ6cZhoAB+S5eVlG4moSPHBmQcb86GCVOZ8DM+/Q1nYVAnWpCuspdKOjg6rs7PTRV/CqM4yEvBd5EGa7wIN0XjovYfwZ2DINcw/xflXR4YYGrG2tmavr697GqcSD0gIYuIAEFw0+BZ4A7faO7jar4D4Q0h8gjZNZWgDWV8JjwrfC0ZpBfUHbMcmxo9HR0f/JYYF/M7ExIQL7Ek2c5KhkhsLt9dVTPWgfozaAq8a8Bqia8j/AQpSfygX6ADm1Xn13w2DdwKixTv8D+DvwZGl3t7eTYwDnaYoX1xcfAXgr7D2eX19vYGMVhXEDL9HBSjMfrYh5ZhTRYygjI+x0Vr8QGHFy0rcHTj1BQzZp24VRvzruYy9/bGhoeEiHh2ScxuYoPyaUXuI/rkLjUChHHOG1YEOEzqe4Lr+YHh4+LFKQii/i1uMyhmuDCqLEvIJTmbO+VtFtgQVeehqxm16F3TtJv52fdrU1PT13t6egdCcU8XLwbHVRmNjI9+Kz3ixbO3s7NxEuHJImsR74eXUVZXyoJNfOFv/AcihymlkznQ3AAAAAElFTkSuQmCCMTc0OQ==",
    "image_path": "http://my.easysys.local/img/profile_picture/j2cbWl-yp3zT9oOh9jHTAA/Ds8buEV0HXZsvuBm3df8SQ.png?type=thumb"
  }
]

Search comments

POST /kb_order/1/comment/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "user_id",
    "value": 1
  }
]
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:

  • 0
  • 1
  • 2
Name Required Type Description
id optional string
user_id optional string
text optional string
date optional string
is_public optional string

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 5295
Content-Type: application/json
[
  {
    "id": 2,
    "text": "API-Kommentar",
    "user_id": 1,
    "user_email": null,
    "user_name": "Hans Muster",
    "date": "2015-09-18 15:41:13",
    "is_public": false,
    "image": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABRVJREFUWAmdV0tMXFUYvq+Z4WWwGhJjSq2S0IZNZaM7CYnGTZdCdIm8YSMkTZcMSZcuXBCepSxNYNGF0aTGBIgbaxd0YVWIxmqTYiBpS3gM87h3/L7D/a/n3pl7gZ7kzHl9//c/zn/OuWMaZyzZbNZBLRG+sLDwtuu67aZpvslxuVx+atv2Rn9//18c61iOk4qZtChrQjg7O9sGpV9i/qOamhrHsiwF8TzPOD4+LmHte/RvDA0N/SoywhHXnmqAEM3MzFyHl99AsZHL5eg1FZZJjD66plNbW0tDOL4+ODj4rcjGKed8ogEgsFC9+fn5VpBu0mN4WIBcCgpDvFjnuAgj08BwcHVgYGBLOEJgbXASQ20i0lXrIL9VV1cnytNR5ZTx59LIjQIiYVLG50rUEXZD0w4CcJrl6enpC/DqT3h/AZ55nNRgFV3IlYG1AH0OY1pGRkaeC1cFGBOx1k1OTipFUH4ROqmcYQ0pJzFrhNgkljKU5ZpwRXBqGGuAgOFMVIFaEq+gCN0KIxQGEagqK9xsTzUAmH0oKKINkYliMYRkWqFVxVQqta/NVe2GSHWEEC8tLb1aKBSYA68htEEOcF3H0yCOMS858Ozo6KhlbGzshXDpeOnHRoCEPEI9PT0v0H8EbyjjiaAo5FjvE0MslD6icnJE1oVCtSEv9BWxempq6nXHcTZQm7GnZ4oAks8C9h+07X19fc+ES+eXfmwEVlZW1Bq8eSudTjeXSqVAOYXplV6FEHMmlLuQu4TmMueFSzB6G2tAd3e3Cvfh4eFvxWLxb0TAgidqn4WAnrHKmC0x8NyGzBMMf+dcV1dXsHUc6yXWAIDKq6urzvj4eA6cD3jPo7i6QomAEPprLt8LlAd4D46QAw5xgom2SQYYu7u7ShAn4PbBwQFlHdRYMn/NQfYbkFmkQFtbWxI++R7ANrhzc3MpPCr3wHUb7wHDrb4JSF6llIhBJO7g2+A7ypKjCi6YSowAUdvb2+LBw0DqlA6uiw1CWltbRTZW4lQDJITw6j4uJBLFygBjE4M9/4lA2UL240oog+NATC4mEr6I7iPB3svn8/wYsXU8MG4mk3FgwM/YsvdFRsdU68d6o4PxmillSKwsiLnEfQ4gkbksF0QmAMV0zmQAZNU5xl3wC8439yHkvc/Ns18gxh/Hnn1/XTVnNUCBcbM58PZ/13Um9LlGTGQ6cZhoAB+S5eVlG4moSPHBmQcb86GCVOZ8DM+/Q1nYVAnWpCuspdKOjg6rs7PTRV/CqM4yEvBd5EGa7wIN0XjovYfwZ2DINcw/xflXR4YYGrG2tmavr697GqcSD0gIYuIAEFw0+BZ4A7faO7jar4D4Q0h8gjZNZWgDWV8JjwrfC0ZpBfUHbMcmxo9HR0f/JYYF/M7ExIQL7Ek2c5KhkhsLt9dVTPWgfozaAq8a8Bqia8j/AQpSfygX6ADm1Xn13w2DdwKixTv8D+DvwZGl3t7eTYwDnaYoX1xcfAXgr7D2eX19vYGMVhXEDL9HBSjMfrYh5ZhTRYygjI+x0Vr8QGHFy0rcHTj1BQzZp24VRvzruYy9/bGhoeEiHh2ScxuYoPyaUXuI/rkLjUChHHOG1YEOEzqe4Lr+YHh4+LFKQii/i1uMyhmuDCqLEvIJTmbO+VtFtgQVeehqxm16F3TtJv52fdrU1PT13t6egdCcU8XLwbHVRmNjI9+Kz3ixbO3s7NxEuHJImsR74eXUVZXyoJNfOFv/AcihymlkznQ3AAAAAElFTkSuQmCCMTc0OQ==",
    "image_path": "http://my.easysys.local/img/profile_picture/j2cbWl-yp3zT9oOh9jHTAA/Ds8buEV0HXZsvuBm3df8SQ.png?type=thumb"
  },
  {
    "id": 38,
    "text": "Sample comment 1",
    "user_id": 1,
    "user_email": null,
    "user_name": "Hans Muster",
    "date": "2015-09-18 15:41:59",
    "is_public": false,
    "image": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABRVJREFUWAmdV0tMXFUYvq+Z4WWwGhJjSq2S0IZNZaM7CYnGTZdCdIm8YSMkTZcMSZcuXBCepSxNYNGF0aTGBIgbaxd0YVWIxmqTYiBpS3gM87h3/L7D/a/n3pl7gZ7kzHl9//c/zn/OuWMaZyzZbNZBLRG+sLDwtuu67aZpvslxuVx+atv2Rn9//18c61iOk4qZtChrQjg7O9sGpV9i/qOamhrHsiwF8TzPOD4+LmHte/RvDA0N/SoywhHXnmqAEM3MzFyHl99AsZHL5eg1FZZJjD66plNbW0tDOL4+ODj4rcjGKed8ogEgsFC9+fn5VpBu0mN4WIBcCgpDvFjnuAgj08BwcHVgYGBLOEJgbXASQ20i0lXrIL9VV1cnytNR5ZTx59LIjQIiYVLG50rUEXZD0w4CcJrl6enpC/DqT3h/AZ55nNRgFV3IlYG1AH0OY1pGRkaeC1cFGBOx1k1OTipFUH4ROqmcYQ0pJzFrhNgkljKU5ZpwRXBqGGuAgOFMVIFaEq+gCN0KIxQGEagqK9xsTzUAmH0oKKINkYliMYRkWqFVxVQqta/NVe2GSHWEEC8tLb1aKBSYA68htEEOcF3H0yCOMS858Ozo6KhlbGzshXDpeOnHRoCEPEI9PT0v0H8EbyjjiaAo5FjvE0MslD6icnJE1oVCtSEv9BWxempq6nXHcTZQm7GnZ4oAks8C9h+07X19fc+ES+eXfmwEVlZW1Bq8eSudTjeXSqVAOYXplV6FEHMmlLuQu4TmMueFSzB6G2tAd3e3Cvfh4eFvxWLxb0TAgidqn4WAnrHKmC0x8NyGzBMMf+dcV1dXsHUc6yXWAIDKq6urzvj4eA6cD3jPo7i6QomAEPprLt8LlAd4D46QAw5xgom2SQYYu7u7ShAn4PbBwQFlHdRYMn/NQfYbkFmkQFtbWxI++R7ANrhzc3MpPCr3wHUb7wHDrb4JSF6llIhBJO7g2+A7ypKjCi6YSowAUdvb2+LBw0DqlA6uiw1CWltbRTZW4lQDJITw6j4uJBLFygBjE4M9/4lA2UL240oog+NATC4mEr6I7iPB3svn8/wYsXU8MG4mk3FgwM/YsvdFRsdU68d6o4PxmillSKwsiLnEfQ4gkbksF0QmAMV0zmQAZNU5xl3wC8439yHkvc/Ns18gxh/Hnn1/XTVnNUCBcbM58PZ/13Um9LlGTGQ6cZhoAB+S5eVlG4moSPHBmQcb86GCVOZ8DM+/Q1nYVAnWpCuspdKOjg6rs7PTRV/CqM4yEvBd5EGa7wIN0XjovYfwZ2DINcw/xflXR4YYGrG2tmavr697GqcSD0gIYuIAEFw0+BZ4A7faO7jar4D4Q0h8gjZNZWgDWV8JjwrfC0ZpBfUHbMcmxo9HR0f/JYYF/M7ExIQL7Ek2c5KhkhsLt9dVTPWgfozaAq8a8Bqia8j/AQpSfygX6ADm1Xn13w2DdwKixTv8D+DvwZGl3t7eTYwDnaYoX1xcfAXgr7D2eX19vYGMVhXEDL9HBSjMfrYh5ZhTRYygjI+x0Vr8QGHFy0rcHTj1BQzZp24VRvzruYy9/bGhoeEiHh2ScxuYoPyaUXuI/rkLjUChHHOG1YEOEzqe4Lr+YHh4+LFKQii/i1uMyhmuDCqLEvIJTmbO+VtFtgQVeehqxm16F3TtJv52fdrU1PT13t6egdCcU8XLwbHVRmNjI9+Kz3ixbO3s7NxEuHJImsR74eXUVZXyoJNfOFv/AcihymlkznQ3AAAAAElFTkSuQmCCMTc0OQ==",
    "image_path": "http://my.easysys.local/img/profile_picture/j2cbWl-yp3zT9oOh9jHTAA/Ds8buEV0HXZsvuBm3df8SQ.png?type=thumb"
  }
]

Show comment

GET /kb_order/1/comment/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 2644
Content-Type: application/json
{
  "id": 2,
  "text": "API-Kommentar",
  "user_id": 1,
  "user_email": null,
  "user_name": "Hans Muster",
  "date": "2015-09-18 15:41:13",
  "is_public": false,
  "image": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABRVJREFUWAmdV0tMXFUYvq+Z4WWwGhJjSq2S0IZNZaM7CYnGTZdCdIm8YSMkTZcMSZcuXBCepSxNYNGF0aTGBIgbaxd0YVWIxmqTYiBpS3gM87h3/L7D/a/n3pl7gZ7kzHl9//c/zn/OuWMaZyzZbNZBLRG+sLDwtuu67aZpvslxuVx+atv2Rn9//18c61iOk4qZtChrQjg7O9sGpV9i/qOamhrHsiwF8TzPOD4+LmHte/RvDA0N/SoywhHXnmqAEM3MzFyHl99AsZHL5eg1FZZJjD66plNbW0tDOL4+ODj4rcjGKed8ogEgsFC9+fn5VpBu0mN4WIBcCgpDvFjnuAgj08BwcHVgYGBLOEJgbXASQ20i0lXrIL9VV1cnytNR5ZTx59LIjQIiYVLG50rUEXZD0w4CcJrl6enpC/DqT3h/AZ55nNRgFV3IlYG1AH0OY1pGRkaeC1cFGBOx1k1OTipFUH4ROqmcYQ0pJzFrhNgkljKU5ZpwRXBqGGuAgOFMVIFaEq+gCN0KIxQGEagqK9xsTzUAmH0oKKINkYliMYRkWqFVxVQqta/NVe2GSHWEEC8tLb1aKBSYA68htEEOcF3H0yCOMS858Ozo6KhlbGzshXDpeOnHRoCEPEI9PT0v0H8EbyjjiaAo5FjvE0MslD6icnJE1oVCtSEv9BWxempq6nXHcTZQm7GnZ4oAks8C9h+07X19fc+ES+eXfmwEVlZW1Bq8eSudTjeXSqVAOYXplV6FEHMmlLuQu4TmMueFSzB6G2tAd3e3Cvfh4eFvxWLxb0TAgidqn4WAnrHKmC0x8NyGzBMMf+dcV1dXsHUc6yXWAIDKq6urzvj4eA6cD3jPo7i6QomAEPprLt8LlAd4D46QAw5xgom2SQYYu7u7ShAn4PbBwQFlHdRYMn/NQfYbkFmkQFtbWxI++R7ANrhzc3MpPCr3wHUb7wHDrb4JSF6llIhBJO7g2+A7ypKjCi6YSowAUdvb2+LBw0DqlA6uiw1CWltbRTZW4lQDJITw6j4uJBLFygBjE4M9/4lA2UL240oog+NATC4mEr6I7iPB3svn8/wYsXU8MG4mk3FgwM/YsvdFRsdU68d6o4PxmillSKwsiLnEfQ4gkbksF0QmAMV0zmQAZNU5xl3wC8439yHkvc/Ns18gxh/Hnn1/XTVnNUCBcbM58PZ/13Um9LlGTGQ6cZhoAB+S5eVlG4moSPHBmQcb86GCVOZ8DM+/Q1nYVAnWpCuspdKOjg6rs7PTRV/CqM4yEvBd5EGa7wIN0XjovYfwZ2DINcw/xflXR4YYGrG2tmavr697GqcSD0gIYuIAEFw0+BZ4A7faO7jar4D4Q0h8gjZNZWgDWV8JjwrfC0ZpBfUHbMcmxo9HR0f/JYYF/M7ExIQL7Ek2c5KhkhsLt9dVTPWgfozaAq8a8Bqia8j/AQpSfygX6ADm1Xn13w2DdwKixTv8D+DvwZGl3t7eTYwDnaYoX1xcfAXgr7D2eX19vYGMVhXEDL9HBSjMfrYh5ZhTRYygjI+x0Vr8QGHFy0rcHTj1BQzZp24VRvzruYy9/bGhoeEiHh2ScxuYoPyaUXuI/rkLjUChHHOG1YEOEzqe4Lr+YHh4+LFKQii/i1uMyhmuDCqLEvIJTmbO+VtFtgQVeehqxm16F3TtJv52fdrU1PT13t6egdCcU8XLwbHVRmNjI9+Kz3ixbO3s7NxEuHJImsR74eXUVZXyoJNfOFv/AcihymlkznQ3AAAAAElFTkSuQmCCMTc0OQ==",
  "image_path": "http://my.easysys.local/img/profile_picture/j2cbWl-yp3zT9oOh9jHTAA/Ds8buEV0HXZsvuBm3df8SQ.png?type=thumb"
}

Create comment

POST /kb_order/1/comment
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "text": "Sample comment 1",
  "user_id": 1,
  "is_public": false
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
text required string (4000)
user_id required Resource user
user_name required string (255)
is_public optional boolean
user_email optional string (255)

The following scopes are needed:

  • general
Status: 201 Created
X-Authenticated-User: apiextract_1
Content-Length: 2648
Content-Type: application/json
{
  "id": 38,
  "text": "Sample comment 1",
  "user_id": 1,
  "user_email": null,
  "user_name": "Hans Muster",
  "date": "2015-09-18 15:41:59",
  "is_public": false,
  "image": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABRVJREFUWAmdV0tMXFUYvq+Z4WWwGhJjSq2S0IZNZaM7CYnGTZdCdIm8YSMkTZcMSZcuXBCepSxNYNGF0aTGBIgbaxd0YVWIxmqTYiBpS3gM87h3/L7D/a/n3pl7gZ7kzHl9//c/zn/OuWMaZyzZbNZBLRG+sLDwtuu67aZpvslxuVx+atv2Rn9//18c61iOk4qZtChrQjg7O9sGpV9i/qOamhrHsiwF8TzPOD4+LmHte/RvDA0N/SoywhHXnmqAEM3MzFyHl99AsZHL5eg1FZZJjD66plNbW0tDOL4+ODj4rcjGKed8ogEgsFC9+fn5VpBu0mN4WIBcCgpDvFjnuAgj08BwcHVgYGBLOEJgbXASQ20i0lXrIL9VV1cnytNR5ZTx59LIjQIiYVLG50rUEXZD0w4CcJrl6enpC/DqT3h/AZ55nNRgFV3IlYG1AH0OY1pGRkaeC1cFGBOx1k1OTipFUH4ROqmcYQ0pJzFrhNgkljKU5ZpwRXBqGGuAgOFMVIFaEq+gCN0KIxQGEagqK9xsTzUAmH0oKKINkYliMYRkWqFVxVQqta/NVe2GSHWEEC8tLb1aKBSYA68htEEOcF3H0yCOMS858Ozo6KhlbGzshXDpeOnHRoCEPEI9PT0v0H8EbyjjiaAo5FjvE0MslD6icnJE1oVCtSEv9BWxempq6nXHcTZQm7GnZ4oAks8C9h+07X19fc+ES+eXfmwEVlZW1Bq8eSudTjeXSqVAOYXplV6FEHMmlLuQu4TmMueFSzB6G2tAd3e3Cvfh4eFvxWLxb0TAgidqn4WAnrHKmC0x8NyGzBMMf+dcV1dXsHUc6yXWAIDKq6urzvj4eA6cD3jPo7i6QomAEPprLt8LlAd4D46QAw5xgom2SQYYu7u7ShAn4PbBwQFlHdRYMn/NQfYbkFmkQFtbWxI++R7ANrhzc3MpPCr3wHUb7wHDrb4JSF6llIhBJO7g2+A7ypKjCi6YSowAUdvb2+LBw0DqlA6uiw1CWltbRTZW4lQDJITw6j4uJBLFygBjE4M9/4lA2UL240oog+NATC4mEr6I7iPB3svn8/wYsXU8MG4mk3FgwM/YsvdFRsdU68d6o4PxmillSKwsiLnEfQ4gkbksF0QmAMV0zmQAZNU5xl3wC8439yHkvc/Ns18gxh/Hnn1/XTVnNUCBcbM58PZ/13Um9LlGTGQ6cZhoAB+S5eVlG4moSPHBmQcb86GCVOZ8DM+/Q1nYVAnWpCuspdKOjg6rs7PTRV/CqM4yEvBd5EGa7wIN0XjovYfwZ2DINcw/xflXR4YYGrG2tmavr697GqcSD0gIYuIAEFw0+BZ4A7faO7jar4D4Q0h8gjZNZWgDWV8JjwrfC0ZpBfUHbMcmxo9HR0f/JYYF/M7ExIQL7Ek2c5KhkhsLt9dVTPWgfozaAq8a8Bqia8j/AQpSfygX6ADm1Xn13w2DdwKixTv8D+DvwZGl3t7eTYwDnaYoX1xcfAXgr7D2eX19vYGMVhXEDL9HBSjMfrYh5ZhTRYygjI+x0Vr8QGHFy0rcHTj1BQzZp24VRvzruYy9/bGhoeEiHh2ScxuYoPyaUXuI/rkLjUChHHOG1YEOEzqe4Lr+YHh4+LFKQii/i1uMyhmuDCqLEvIJTmbO+VtFtgQVeehqxm16F3TtJv52fdrU1PT13t6egdCcU8XLwbHVRmNjI9+Kz3ixbO3s7NxEuHJImsR74eXUVZXyoJNfOFv/AcihymlkznQ3AAAAAElFTkSuQmCCMTc0OQ==",
  "image_path": "http://my.easysys.local/img/profile_picture/j2cbWl-yp3zT9oOh9jHTAA/Ds8buEV0HXZsvuBm3df8SQ.png?type=thumb"
}

Show repetition

GET /kb_order/1/repetition
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript-Callback

The following scopes are needed:

  • kb_order_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 109
Content-Type: application/json
{
  "start": "2014-09-17",
  "end": "2014-10-20",
  "repetition": {
    "type": "monthly",
    "interval": 1,
    "schedule": "first_day"
  }
}

Create repetition

POST /kb_order/1/repetition
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "start": "2014-09-17",
  "end": "2014-10-20",
  "repetition": {
    "type": "monthly",
    "interval": 1,
    "schedule": "first_day"
  }
}
Name Required Type Description
callback optional string Javascript-Callback
Name Required Type Description
end required date (Format yyyy-mm-dd) Date until the repetition is supposed to run. If empty indefinite repetition is assumed.
repetition required undefined Valid values for type:

daily => fields interval
weekly => fields interval, weekdays (array of weekdays)
monthly => fields interval, schedule ('fixed_day', 'week_day', 'first_day', 'last_day')
yearly => fields interval
start required date (Format yyyy-mm-dd)

The following scopes are needed:

  • kb_order_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 109
Content-Type: application/json
{
  "start": "2014-09-17",
  "end": "2014-10-20",
  "repetition": {
    "type": "monthly",
    "interval": 1,
    "schedule": "first_day"
  }
}

Delete repetition

DELETE /kb_order/1/repetition
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript-Callback

The following scopes are needed:

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