Bills API

List bills

GET /kb_bill
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_bill_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 1410
Content-Type: application/json
[
  {
    "id": 1,
    "document_nr": "00001",
    "title": null,
    "contact_id": 1,
    "contact_sub_id": null,
    "user_id": 1,
    "pr_project_id": null,
    "logopaper_id": 1,
    "language_id": 1,
    "bank_account_id": 1,
    "currency_id": 1,
    "header": null,
    "footer": null,
    "total_gross": "19.7700",
    "total_net": "17.8000",
    "total_taxes": "0.0000",
    "total_paid_payments": "0.0000",
    "total_remaining_payments": "17.8000",
    "total": "17.8000",
    "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": 27,
    "api_reference": null,
    "viewed_by_client_at": null,
    "updated_at": "2015-09-18 15:41:13",
    "taxs": [
      {
        "percentage": 0,
        "value": "0.0000"
      }
    ]
  },
  {
    "id": 2,
    "document_nr": "00002",
    "title": "",
    "contact_id": 1,
    "contact_sub_id": null,
    "user_id": 1,
    "pr_project_id": null,
    "logopaper_id": 1,
    "language_id": 1,
    "bank_account_id": 1,
    "currency_id": 1,
    "header": "",
    "footer": "",
    "total_gross": "132.0000",
    "total_net": "132.0000",
    "total_taxes": "10.5600",
    "total_paid_payments": "0.0000",
    "total_remaining_payments": "142.5500",
    "total": "142.5500",
    "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": 27,
    "api_reference": "",
    "viewed_by_client_at": null,
    "updated_at": "2015-09-18 15:41:35",
    "taxs": [
      {
        "percentage": "8.00",
        "value": "10.5600"
      }
    ]
  }
]

Search bills

POST /kb_bill/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_bill_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 1410
Content-Type: application/json
[
  {
    "id": 1,
    "document_nr": "00001",
    "title": null,
    "contact_id": 1,
    "contact_sub_id": null,
    "user_id": 1,
    "pr_project_id": null,
    "logopaper_id": 1,
    "language_id": 1,
    "bank_account_id": 1,
    "currency_id": 1,
    "header": null,
    "footer": null,
    "total_gross": "19.7700",
    "total_net": "17.8000",
    "total_taxes": "0.0000",
    "total_paid_payments": "0.0000",
    "total_remaining_payments": "17.8000",
    "total": "17.8000",
    "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": 27,
    "api_reference": null,
    "viewed_by_client_at": null,
    "updated_at": "2015-09-18 15:41:13",
    "taxs": [
      {
        "percentage": 0,
        "value": "0.0000"
      }
    ]
  },
  {
    "id": 2,
    "document_nr": "00002",
    "title": "",
    "contact_id": 1,
    "contact_sub_id": null,
    "user_id": 1,
    "pr_project_id": null,
    "logopaper_id": 1,
    "language_id": 1,
    "bank_account_id": 1,
    "currency_id": 1,
    "header": "",
    "footer": "",
    "total_gross": "132.0000",
    "total_net": "132.0000",
    "total_taxes": "10.5600",
    "total_paid_payments": "0.0000",
    "total_remaining_payments": "142.5500",
    "total": "142.5500",
    "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": 27,
    "api_reference": "",
    "viewed_by_client_at": null,
    "updated_at": "2015-09-18 15:41:35",
    "taxs": [
      {
        "percentage": "8.00",
        "value": "10.5600"
      }
    ]
  }
]

Show bill

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

The following scopes are needed:

  • kb_bill_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: e4711ce970d6102845c5daaba03d89c1
Content-Length: 1346
Content-Type: application/json
{
  "id": 2,
  "document_nr": "00002",
  "title": "",
  "contact_id": 1,
  "contact_sub_id": null,
  "user_id": 1,
  "pr_project_id": null,
  "logopaper_id": 1,
  "language_id": 1,
  "bank_account_id": 1,
  "currency_id": 1,
  "header": "",
  "footer": "",
  "total_gross": "132.0000",
  "total_net": "132.0000",
  "total_taxes": "10.5600",
  "total_paid_payments": "0.0000",
  "total_remaining_payments": "142.5500",
  "total": "142.5500",
  "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": 27,
  "api_reference": "",
  "viewed_by_client_at": null,
  "updated_at": "2015-09-18 15:41:35",
  "taxs": [
    {
      "percentage": "8.00",
      "value": "10.5600"
    }
  ],
  "positions": [
    {
      "id": 5,
      "type": "KbPositionArticle",
      "amount": "1.0000",
      "unit_id": null,
      "account_id": 90,
      "unit_name": null,
      "tax_id": 6,
      "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": 10,
      "type": "KbPositionCustom",
      "amount": "1.0000",
      "unit_id": null,
      "account_id": 90,
      "unit_name": null,
      "tax_id": 6,
      "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
    }
  ]
}

Create bill

POST /kb_bill
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "contact_id": 1,
  "positions": [
    {
      "type": "KbPositionArticle",
      "unit_price": 120,
      "article_id": 1,
      "tax_id": 6,
      "amount": 1
    },
    {
      "type": "KbPositionCustom",
      "unit_price": 12,
      "amount": 1,
      "tax_id": 6
    }
  ]
}
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
footer optional string (4000)
header optional string (4000)
is_compact_view optional boolean
is_valid_from optional date (Format yyyy-mm-dd)
is_valid_to 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)
viewed_by_client_at optional datetime (Format yyyy-mm-dd hh:ii:ss)

The following scopes are needed:

  • kb_bill_edit
Status: 201 Created
X-Authenticated-User: apiextract_1
Etag: e4711ce970d6102845c5daaba03d89c1
Content-Length: 1299
Content-Type: application/json
{
  "id": 2,
  "document_nr": "00002",
  "title": "",
  "contact_id": 1,
  "contact_sub_id": null,
  "user_id": 1,
  "pr_project_id": null,
  "logopaper_id": 1,
  "language_id": 1,
  "bank_account_id": 1,
  "currency_id": 1,
  "header": "",
  "footer": "",
  "total_gross": "132",
  "total_net": "132",
  "total_taxes": "10.5600",
  "total_paid_payments": "0",
  "total_remaining_payments": "142.5500",
  "total": "142.55",
  "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": 27,
  "api_reference": "",
  "viewed_by_client_at": null,
  "updated_at": "2015-09-18 15:41:35",
  "taxs": [
    {
      "percentage": "8.00",
      "value": "10.5600"
    }
  ],
  "positions": [
    {
      "id": 5,
      "type": "KbPositionArticle",
      "amount": "1",
      "unit_id": null,
      "account_id": 90,
      "unit_name": null,
      "tax_id": 6,
      "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": 10,
      "type": "KbPositionCustom",
      "amount": "1",
      "unit_id": null,
      "account_id": 90,
      "unit_name": null,
      "tax_id": 6,
      "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
    }
  ]
}

Overwrite bill

PUT /kb_bill/2
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",
  "is_valid_to": "2015-10-17"
}
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)
is_valid_to 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
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)
viewed_by_client_at optional datetime (Format yyyy-mm-dd hh:ii:ss)

The following scopes are needed:

  • kb_bill_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 6b2e6f7456cafdacbeb1a1c6d97e2633
Content-Length: 1284
Content-Type: application/json
{
  "id": 2,
  "document_nr": "00002",
  "title": "",
  "contact_id": 2,
  "contact_sub_id": null,
  "user_id": 1,
  "pr_project_id": null,
  "logopaper_id": 1,
  "language_id": 1,
  "bank_account_id": 1,
  "currency_id": 1,
  "header": "",
  "footer": "",
  "total_gross": "132",
  "total_net": "132",
  "total_taxes": "10.5600",
  "total_paid_payments": "0.0000",
  "total_remaining_payments": "142.5500",
  "total": "142.55",
  "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": "",
  "kb_item_status_id": 27,
  "api_reference": "",
  "viewed_by_client_at": null,
  "updated_at": "2015-09-18 15:41:36",
  "taxs": [
    {
      "percentage": "8.00",
      "value": "10.5600"
    }
  ],
  "positions": [
    {
      "id": 5,
      "type": "KbPositionArticle",
      "amount": "1.0000",
      "unit_id": null,
      "account_id": 90,
      "unit_name": null,
      "tax_id": 6,
      "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": 10,
      "type": "KbPositionCustom",
      "amount": "1.0000",
      "unit_id": null,
      "account_id": 90,
      "unit_name": null,
      "tax_id": 6,
      "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
    }
  ]
}

Edit bill

POST /kb_bill/2
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
footer optional string (4000)
header optional string (4000)
is_compact_view optional boolean
is_valid_from optional date (Format yyyy-mm-dd)
is_valid_to 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
viewed_by_client_at optional datetime (Format yyyy-mm-dd hh:ii:ss)

The following scopes are needed:

  • kb_bill_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: e424e095412eb65250b1e716ccc681c0
Content-Length: 1284
Content-Type: application/json
{
  "id": 2,
  "document_nr": "00002",
  "title": "",
  "contact_id": 2,
  "contact_sub_id": null,
  "user_id": 1,
  "pr_project_id": null,
  "logopaper_id": 1,
  "language_id": 1,
  "bank_account_id": 1,
  "currency_id": 1,
  "header": "",
  "footer": "",
  "total_gross": "132",
  "total_net": "132",
  "total_taxes": "10.5600",
  "total_paid_payments": "0.0000",
  "total_remaining_payments": "142.5500",
  "total": "142.55",
  "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": "",
  "kb_item_status_id": 27,
  "api_reference": "",
  "viewed_by_client_at": null,
  "updated_at": "2015-09-18 15:41:37",
  "taxs": [
    {
      "percentage": "8.00",
      "value": "10.5600"
    }
  ],
  "positions": [
    {
      "id": 5,
      "type": "KbPositionArticle",
      "amount": "1.0000",
      "unit_id": null,
      "account_id": 90,
      "unit_name": null,
      "tax_id": 6,
      "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": 10,
      "type": "KbPositionCustom",
      "amount": "1.0000",
      "unit_id": null,
      "account_id": 90,
      "unit_name": null,
      "tax_id": 6,
      "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
    }
  ]
}

Delete bill

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

The following scopes are needed:

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

Issue bill

POST /kb_bill/1/issue
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript-Callback

The following scopes are needed:

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

Revert issue bill

POST /kb_bill/1/revert_issue
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript-Callback

The following scopes are needed:

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

Copy bill

POST /kb_bill/1/copy
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "contact_id": 1,
  "is_valid_from": "02-04-2015"
}
Name Required Type Description
callback optional string Javascript-Callback
Name Required Type Description
contact_id required Resource contact
client_contact_id optional Resource contact
client_contact_sub_id optional Resource contact
client_project_id optional Resource pr_project
contact_sub_id optional Resource contact
is_valid_from optional date (Format yyyy-mm-dd)
is_valid_to optional date (Format yyyy-mm-dd)
pr_project_id optional Resource pr_project
reference optional string (255)
title optional string (80)

The following scopes are needed:

  • kb_bill_show
Status: 201 Created
X-Authenticated-User: apiextract_1
Etag: 1f768fe1f87af3f73444c381ef5e3b85
Content-Length: 2248
Content-Type: application/json
{
  "id": 3,
  "document_nr": "00003",
  "title": "",
  "contact_id": 1,
  "contact_sub_id": null,
  "user_id": 1,
  "pr_project_id": null,
  "logopaper_id": 1,
  "language_id": 1,
  "bank_account_id": 1,
  "currency_id": 1,
  "header": null,
  "footer": null,
  "total_gross": "19.77",
  "total_net": "17.8",
  "total_taxes": "0.0000",
  "total_paid_payments": "0",
  "total_remaining_payments": "17.8000",
  "total": "17.8",
  "mwst_type": 0,
  "mwst_is_net": true,
  "show_position_taxes": false,
  "is_valid_from": "2015-04-02",
  "is_valid_to": "2015-05-01",
  "contact_address": "Muster AG\nMüllerstrasse 22\n8004 Zürich",
  "kb_item_status_id": 27,
  "api_reference": null,
  "viewed_by_client_at": null,
  "updated_at": "2015-09-18 15:41:39",
  "taxs": [
    {
      "percentage": "0.00",
      "value": "0.0000"
    }
  ],
  "positions": [
    {
      "id": 11,
      "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.57",
      "pos": "1",
      "internal_pos": 1,
      "parent_id": null,
      "is_optional": false
    },
    {
      "id": 12,
      "type": "KbPositionCustom",
      "amount": "4.0000",
      "unit_id": 1,
      "account_id": null,
      "unit_name": "h",
      "tax_id": 4,
      "tax_value": "0.00",
      "text": "Pelati",
      "unit_price": "2.3000",
      "discount_in_percent": null,
      "position_total": "9.2",
      "pos": "2",
      "internal_pos": 2,
      "parent_id": null,
      "is_optional": false
    },
    {
      "id": 6,
      "type": "KbPositionArticle",
      "amount": "1.0000",
      "unit_id": 1,
      "account_id": null,
      "unit_name": "h",
      "tax_id": 4,
      "tax_value": "0.00",
      "text": "Mozzarella",
      "unit_price": "4.0000",
      "discount_in_percent": null,
      "position_total": "4",
      "pos": "3",
      "internal_pos": 3,
      "parent_id": null,
      "is_optional": false,
      "article_id": 1
    },
    {
      "id": 5,
      "type": "KbPositionText",
      "text": "Geschnitten geliefert",
      "show_pos_nr": true,
      "pos": "4",
      "internal_pos": 4,
      "parent_id": null,
      "is_optional": false
    },
    {
      "id": 5,
      "type": "KbPositionPagebreak",
      "internal_pos": 5,
      "parent_id": null,
      "is_optional": false
    },
    {
      "id": 5,
      "type": "KbPositionSubtotal",
      "text": "Subtotal",
      "value": "19.77",
      "internal_pos": 6,
      "parent_id": null,
      "is_optional": false
    },
    {
      "id": 5,
      "type": "KbPositionSubposition",
      "text": "Unterposition",
      "pos": "5",
      "internal_pos": 7,
      "show_pos_nr": true,
      "parent_id": null,
      "is_optional": false,
      "total_sum": "0",
      "show_pos_prices": true
    },
    {
      "id": 5,
      "type": "KbPositionDiscount",
      "text": "Rabatt 10%",
      "is_percentual": true,
      "value": "10.0000",
      "discount_total": "1.977"
    }
  ]
}

List comments

GET /kb_bill/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: 5294
Content-Type: application/json
[
  {
    "id": 4,
    "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": 8,
    "text": "Sample comment 1",
    "user_id": 1,
    "user_email": null,
    "user_name": "Hans Muster",
    "date": "2015-09-18 15:41:39",
    "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_bill/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: 5294
Content-Type: application/json
[
  {
    "id": 4,
    "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": 8,
    "text": "Sample comment 1",
    "user_id": 1,
    "user_email": null,
    "user_name": "Hans Muster",
    "date": "2015-09-18 15:41:39",
    "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_bill/1/comment/4
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": 4,
  "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_bill/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: 2647
Content-Type: application/json
{
  "id": 8,
  "text": "Sample comment 1",
  "user_id": 1,
  "user_email": null,
  "user_name": "Hans Muster",
  "date": "2015-09-18 15:41:39",
  "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"
}

List payments

GET /kb_bill/1/payment
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

The following scopes are needed:

  • kb_invoice_show
  • kb_bill_show
  • kb_credit_voucher_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 316
Content-Type: application/json
[
  {
    "id": 4,
    "date": "2014-08-01",
    "value": "-10.0000",
    "bank_account_id": null,
    "title": "lib.model.kb_client_account_entry.Zahlung ausgestellt",
    "payment_service_id": null,
    "is_client_account_redemption": false,
    "is_cash_discount": false,
    "kb_invoice_id": null,
    "kb_credit_voucher_id": null,
    "kb_bill_id": 1,
    "kb_credit_voucher_text": ""
  }
]

Show payments

GET /kb_bill/1/payment/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • kb_invoice_show
  • kb_bill_show
  • kb_credit_voucher_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 20220ba0eac390fb38b4f6783d070d7f
Content-Length: 314
Content-Type: application/json
{
  "id": 4,
  "date": "2014-08-01",
  "value": "-10.0000",
  "bank_account_id": null,
  "title": "lib.model.kb_client_account_entry.Zahlung ausgestellt",
  "payment_service_id": null,
  "is_client_account_redemption": false,
  "is_cash_discount": false,
  "kb_invoice_id": null,
  "kb_credit_voucher_id": null,
  "kb_bill_id": 1,
  "kb_credit_voucher_text": ""
}

Create payments

POST /kb_bill/1/payment
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "date": "2014-08-01",
  "value": 10,
  "bank_account_id": null,
  "payment_service_id": null
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
value required decimal
bank_account_id optional Resource bank_account
date optional date (Format yyyy-mm-dd)
payment_service_id optional Resource payment_service

The following scopes are needed:

  • kb_invoice_show
  • kb_bill_show
  • kb_credit_voucher_show
Status: 201 Created
X-Authenticated-User: apiextract_1
Etag: 20220ba0eac390fb38b4f6783d070d7f
Content-Length: 309
Content-Type: application/json
{
  "id": 4,
  "date": "2014-08-01",
  "value": "-10",
  "bank_account_id": null,
  "title": "lib.model.kb_client_account_entry.Zahlung ausgestellt",
  "payment_service_id": null,
  "is_client_account_redemption": false,
  "is_cash_discount": false,
  "kb_invoice_id": null,
  "kb_credit_voucher_id": null,
  "kb_bill_id": 1,
  "kb_credit_voucher_text": ""
}

Delete payments

DELETE /kb_bill/1/payment/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

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