API Docs
Request access

Document setting API

List kb_item_settings

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

  • text
  • id
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 1892
Content-Type: application/json
[
  {
    "id": 1,
    "text": "Angebot",
    "kb_item_class": "KbOffer",
    "enumeration_format": "AN-%nummer%",
    "use_automatic_enumeration": true,
    "use_yearly_enumeration": false,
    "next_nr": 1,
    "nr_min_length": 5,
    "default_time_period_in_days": 14,
    "default_logopaper_id": 1,
    "default_language_id": 1,
    "default_client_bank_account_new_id": 1,
    "default_currency_id": 1,
    "default_mwst_type": 0,
    "default_mwst_is_net": true,
    "default_nb_decimals_amount": 2,
    "default_nb_decimals_price": 2,
    "default_show_position_taxes": false,
    "default_title": "Angebot",
    "default_show_esr_on_same_page": false,
    "default_payment_type_id": null,
    "kb_terms_of_payment_template_id": 1,
    "default_show_total": true
  },
  {
    "id": 2,
    "text": "Auftrag",
    "kb_item_class": "KbOrder",
    "enumeration_format": "AU-%nummer%",
    "use_automatic_enumeration": true,
    "use_yearly_enumeration": false,
    "next_nr": 1,
    "nr_min_length": 5,
    "default_time_period_in_days": 14,
    "default_logopaper_id": 1,
    "default_language_id": 1,
    "default_client_bank_account_new_id": 1,
    "default_currency_id": 1,
    "default_mwst_type": 0,
    "default_mwst_is_net": true,
    "default_nb_decimals_amount": 2,
    "default_nb_decimals_price": 2,
    "default_show_position_taxes": false,
    "default_title": "Auftrag",
    "default_show_esr_on_same_page": false,
    "default_payment_type_id": null,
    "kb_terms_of_payment_template_id": 1,
    "default_show_total": true
  },
  {
    "id": 3,
    "text": "Rechnung",
    "kb_item_class": "KbInvoice",
    "enumeration_format": "RE-%nummer%",
    "use_automatic_enumeration": true,
    "use_yearly_enumeration": false,
    "next_nr": 1,
    "nr_min_length": 5,
    "default_time_period_in_days": 14,
    "default_logopaper_id": 1,
    "default_language_id": 1,
    "default_client_bank_account_new_id": 1,
    "default_currency_id": 1,
    "default_mwst_type": 0,
    "default_mwst_is_net": true,
    "default_nb_decimals_amount": 2,
    "default_nb_decimals_price": 2,
    "default_show_position_taxes": false,
    "default_title": "Rechnung",
    "default_show_esr_on_same_page": false,
    "default_payment_type_id": null,
    "kb_terms_of_payment_template_id": 1,
    "default_show_total": true
  }
]

Search kb_item_settings

POST /kb_item_setting/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "text",
    "value": "type_offer"
  }
]
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
  • text
Name Required Type Description
text optional string
kb_item_class optional string 
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 2
Content-Type: application/json
[

]

Show kb_item_setting

GET /kb_item_setting/1
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback 
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: e5014c1bf62ede75f5d2ce11e5252f12
Content-Length: 628
Content-Type: application/json
{
  "id": 1,
  "text": "Angebot",
  "kb_item_class": "KbOffer",
  "enumeration_format": "AN-%nummer%",
  "use_automatic_enumeration": true,
  "use_yearly_enumeration": false,
  "next_nr": 1,
  "nr_min_length": 5,
  "default_time_period_in_days": 14,
  "default_logopaper_id": 1,
  "default_language_id": 1,
  "default_client_bank_account_new_id": 1,
  "default_currency_id": 1,
  "default_mwst_type": 0,
  "default_mwst_is_net": true,
  "default_nb_decimals_amount": 2,
  "default_nb_decimals_price": 2,
  "default_show_position_taxes": false,
  "default_title": "Angebot",
  "default_show_esr_on_same_page": false,
  "default_payment_type_id": null,
  "kb_terms_of_payment_template_id": 1,
  "default_show_total": true
}