GET /api/account/service-protocols/{id}

get/api/account/service-protocols/{id}

Example request

GET https://api.jupiter-erp.com/api/account/service-protocols/example-id

Code

curl -X GET 'https://api.jupiter-erp.com/api/account/service-protocols/example-id' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'X-Account-Uuid: YOUR_ACCOUNT_UUID' \
  -H 'Accept: application/json'

Parameters

Name	In	Required	Description
id	path	yes	—

Responses

200OK

ModelServiceProtocol

Field

Type

Description

account_user

object

Field

Type

Description

abilities

string[]

Ability strings for this account user. Included when listing or getting users (admin editing). Omitted in embedded contexts (e.g. documents, projects, service orders) to avoid leaking permission data.

array

Elements

string

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

display_email

string

—

display_name

string

—

display_phone

string

—

id*

integer

—

invited_email

string

Email address the user was invited with. Set for pending account users; null after acceptance or when not applicable.

role*

string

user
admin

status*

string

active
blocked
pending

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

user

object

Field	Type	Description
email*	string	—
id*	integer	—
image_url	string	—
name*	string	—

account_user_id

integer

—

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

date

string

Timestamp in W3C format, will be saved in UTC time +00:00

description

string

—

formatted_number*

string

—

id*

integer

—

media_files

object[]

array

Elements

Field

Type

Description

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

description

string

—

entity

object

Field	Type	Description
id	integer	—
name	string	—

entity_id

integer

—

entity_type

string

Account
Contact
PrintLayout
PrintBackground
ServiceProtocol
ServiceObject
ServiceOrder

file_bytes

number

—

file_ext

string

File extension (e.g., 'jpg', 'png', 'pdf'). Note: PDFs are converted to 'jpg' upon upload.

file_type

string

MIME type (e.g., 'image/jpeg', 'image/png', 'application/pdf'). Note: PDFs are converted to 'image/jpeg' upon upload.

id*

integer

—

is_public

boolean

—

key

string

—

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

url*

string

—

user

object

Field	Type	Description
image_url	string	—
name	string	—

user_id

integer

—

name*

string

—

number*

integer

—

service_object_ids

integer[]

array

Elements

integer

service_objects

object[]

array

Elements

Field

Type

Description

contact

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

avatar

object

Field	Type	Description
id	integer	—
url	string	—

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

fields

object[]

List of contact field values

array

Elements

Field	Type	Description
id*	integer	Field ID
key*	string	Field key
value*	object	Value of the field

first_name

string

—

gender

string

female
male
diverse

group_ids

integer[]

array

Elements

integer

groups

object[]

List of groups associated with the contact.

array

Elements

Field	Type	Description
id*	integer	Unique identifier for the group.
name*	string	Name of the group.

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

first_name

string

—

gender

string

female
male
diverse

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

status*

string

Contact lifecycle status. List endpoints default to active contacts when omitted.

string

active
archived

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

contact_id

integer

—

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

formatted_number*

string

Display number (account format), unique per account

id*

integer

—

installed_at

string (date)

—

internal_description

string

Internal description (panel only)

location

string

—

media_files

object[]

array

Elements

Field

Type

Description

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

description

string

—

entity

object

Field	Type	Description
id	integer	—
name	string	—

entity_id

integer

—

entity_type

string

Account
Contact
PrintLayout
PrintBackground
ServiceProtocol
ServiceObject
ServiceOrder

file_bytes

number

—

file_ext

string

File extension (e.g., 'jpg', 'png', 'pdf'). Note: PDFs are converted to 'jpg' upon upload.

file_type

string

MIME type (e.g., 'image/jpeg', 'image/png', 'application/pdf'). Note: PDFs are converted to 'image/jpeg' upon upload.

id*

integer

—

is_public

boolean

—

key

string

—

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

url*

string

—

user

object

Field	Type	Description
image_url	string	—
name	string	—

user_id

integer

—

name*

string

—

number*

integer

Sequential number per account (internal)

portal_description

string

Description visible in the contact portal

serial_number

string

—

status*

string

active
inactive

type*

string

Category (machine, building, device, vehicle, other)

string

machine
building
device
vehicle
other

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

service_order

object

Service order (Auftrag): document fields aligned with invoices except due/delivery dates, file, sent/paid/e-invoice; includes workflow status and service period.

Field

Type

Description

account_user

object

Field

Type

Description

abilities

string[]

array

Elements

string

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

display_email

string

—

display_name

string

—

display_phone

string

—

id*

integer

—

invited_email

string

Email address the user was invited with. Set for pending account users; null after acceptance or when not applicable.

role*

string

user
admin

status*

string

active
blocked
pending

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

user

object

Field	Type	Description
email*	string	—
id*	integer	—
image_url	string	—
name*	string	—

account_user_id

integer

Contact person on the order (Ansprechpartner), same role as on invoices and service contracts; propagated to documents created from this order.

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

adjustments

object[]

array

Elements

Field	Type	Description
description	string	—
rate	number	—
title*	string	—
type*	string	string surcharge discount
value	integer	—

amount_open

integer

—

appointments

object[]

Loaded on service order detail and list; scheduled Gantt tasks map to these rows

array

Elements

Scheduled dispatch / visit window for a service order (Gantt bar source)

Field

Type

Description

assignee

object

Field

Type

Description

abilities

string[]

array

Elements

string

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

display_email

string

—

display_name

string

—

display_phone

string

—

id*

integer

—

invited_email

string

Email address the user was invited with. Set for pending account users; null after acceptance or when not applicable.

role*

string

user
admin

status*

string

active
blocked
pending

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

user

object

Field	Type	Description
email*	string	—
id*	integer	—
image_url	string	—
name*	string	—

assignee_account_user_id

integer

—

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

ends_at*

string

Local datetime without timezone (Y-m-dTH:i:s)

id*

integer

—

service_order*

object

Parent order summary; always present when returned from the API.

Field	Type	Description
contact_name	string	Contact display name for scheduling views without loading full contact
formatted_number*	string	—
id*	integer	—
service_location	string	—
status*	string	string open planned in_progress done invoiced cancelled
subject	string	—

service_order_id*

integer

—

starts_at*

string

Local datetime without timezone (Y-m-dTH:i:s)

status*

string

planned
confirmed
completed
cancelled

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

assignee

object

Field

Type

Description

abilities

string[]

array

Elements

string

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

display_email

string

—

display_name

string

—

display_phone

string

—

id*

integer

—

invited_email

string

Email address the user was invited with. Set for pending account users; null after acceptance or when not applicable.

role*

string

user
admin

status*

string

active
blocked
pending

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

user

object

Field	Type	Description
email*	string	—
id*	integer	—
image_url	string	—
name*	string	—

assignee_account_user_id

integer

Field / dispatch assignee (Bearbeiter) for scheduling; may differ from the contact person; not copied to documents.

buyer_email

string

—

buyer_reference

string

—

cash_discount_days

integer

—

cash_discount_rate

number

—

city

string

City of the address.

contact

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

avatar

object

Field	Type	Description
id	integer	—
url	string	—

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

fields

object[]

List of contact field values

array

Elements

Field	Type	Description
id*	integer	Field ID
key*	string	Field key
value*	object	Value of the field

first_name

string

—

gender

string

female
male
diverse

group_ids

integer[]

array

Elements

integer

groups

object[]

List of groups associated with the contact.

array

Elements

Field	Type	Description
id*	integer	Unique identifier for the group.
name*	string	Name of the group.

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

first_name

string

—

gender

string

female
male
diverse

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

status*

string

Contact lifecycle status. List endpoints default to active contacts when omitted.

string

active
archived

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

contact_id

integer

—

cost_center

object

Field	Type	Description
booking_account_number	integer	—
code	string	—
created_at	string (date-time)	Creation timestamp in ISO 8601 format.
id*	integer	—
name*	string	—
updated_at	string (date-time)	Last update timestamp in ISO 8601 format.

cost_center_id

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

currency_code*

string

—

date*

string

—

delivery_terms

string

—

formatted_number*

string

—

id*

integer

—

media_files

object[]

array

Elements

Field

Type

Description

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

description

string

—

entity

object

Field	Type	Description
id	integer	—
name	string	—

entity_id

integer

—

entity_type

string

Account
Contact
PrintLayout
PrintBackground
ServiceProtocol
ServiceObject
ServiceOrder

file_bytes

number

—

file_ext

string

File extension (e.g., 'jpg', 'png', 'pdf'). Note: PDFs are converted to 'jpg' upon upload.

file_type

string

MIME type (e.g., 'image/jpeg', 'image/png', 'application/pdf'). Note: PDFs are converted to 'image/jpeg' upon upload.

id*

integer

—

is_public

boolean

—

key

string

—

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

url*

string

—

user

object

Field	Type	Description
image_url	string	—
name	string	—

user_id

integer

—

name_line_1

string

—

name_line_2

string

—

name_line_3

string

—

number*

integer

—

payment_method_code

string

—

payment_terms

string

—

positions

object[]

array

Elements

Field	Type	Description
chart_of_accounts	string	Chart of accounts snapshot (receipt positions) string deu-skr03 deu-skr04
description	string	—
discount_rate	number	—
discount_value	integer	—
is_optional	boolean	—
ledger_account_name	string	Ledger account name snapshot (receipt positions)
ledger_account_number	string	Ledger account number (receipt positions)
position*	string	—
price_unit	integer	—
product_sku	string	—
quantity	number	—
tax_rate	number	—
title*	string	—
unit_code	string	UN/CEFACT unit of measure code (Recommendation 20/21). Null allowed for optional positions. Code meanings: - C62: unit (piece) - HUR: hour - DAY: day - KGM: kilogram - GRM: gram - LTR: litre - CMT: centimetre - MTR: metre - MTK: square metre - MTQ: cubic metre - KMT: kilometre - TNE: tonne (metric) - PAC: package - PR: pair - BOX: box - RO: roll - SET: set - PCE: page - MIN: minute - SEC: second - MLT: millilitre - MMT: millimetre - P1: percent - ZZ: lump sum (generic / no unit) string C62 HUR DAY KGM GRM LTR CMT MTR MTK MTQ KMT TNE PAC PR BOX RO SET PCE MIN SEC MLT MMT P1 ZZ

positions_price_input_mode

string

Whether position unit prices were entered as net or gross (display preference; price_unit is always stored net).

string

net
gross

print_background_id

integer

—

print_layout_id

integer

—

print_options

object

Field	Type	Description
show_contact_number	boolean	Show contact number
show_folding_marks	boolean	Show folding marks
show_footer	boolean	Show footer
show_header	boolean	Show header
show_item_prices	boolean	Show item prices
show_item_quantities	boolean	Show item quantities
show_item_sku	boolean	Show item SKU
show_item_tax_rate	boolean	Show item tax rate
show_item_totals	boolean	Show item totals
show_logo	boolean	Show logo
show_logo_text	boolean	Show logo text
show_page_numbers	boolean	Show page numbers
show_signature_field	boolean	Show signature field
show_terms	boolean	Show terms
show_totals	boolean	Show totals

project

object

Field

Type

Description

account_user

object

Field

Type

Description

abilities

string[]

array

Elements

string

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

display_email

string

—

display_name

string

—

display_phone

string

—

id*

integer

—

invited_email

string

Email address the user was invited with. Set for pending account users; null after acceptance or when not applicable.

role*

string

user
admin

status*

string

active
blocked
pending

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

user

object

Field	Type	Description
email*	string	—
id*	integer	—
image_url	string	—
name*	string	—

account_user_id

integer

—

contact

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

avatar

object

Field	Type	Description
id	integer	—
url	string	—

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

fields

object[]

List of contact field values

array

Elements

Field	Type	Description
id*	integer	Field ID
key*	string	Field key
value*	object	Value of the field

first_name

string

—

gender

string

female
male
diverse

group_ids

integer[]

array

Elements

integer

groups

object[]

List of groups associated with the contact.

array

Elements

Field	Type	Description
id*	integer	Unique identifier for the group.
name*	string	Name of the group.

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

first_name

string

—

gender

string

female
male
diverse

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

status*

string

Contact lifecycle status. List endpoints default to active contacts when omitted.

string

active
archived

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

contact_id

integer

—

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

description

string

—

end_date

string

—

formatted_number*

string

Display number (account format), unique per account

hex_color

string

—

id*

integer

—

name*

string

—

number*

integer

Sequential project number per account (internal)

start_date

string

—

status

string

—

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

project_id

integer

—

reference

string

—

service_contract

object

Field

Type

Description

account_user_id

integer

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

adjustments

object[]

array

Elements

Field	Type	Description
description	string	—
rate	number	—
title*	string	—
type*	string	string surcharge discount
value	integer	—

automatic_generation*

boolean

When true, scheduled/manual processing may create documents for this contract.

buyer_email

string

—

buyer_reference

string

—

cash_discount_days

integer

—

cash_discount_rate

number

—

city

string

City of the address.

contact

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

avatar

object

Field	Type	Description
id	integer	—
url	string	—

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

fields

object[]

List of contact field values

array

Elements

Field	Type	Description
id*	integer	Field ID
key*	string	Field key
value*	object	Value of the field

first_name

string

—

gender

string

female
male
diverse

group_ids

integer[]

array

Elements

integer

groups

object[]

List of groups associated with the contact.

array

Elements

Field	Type	Description
id*	integer	Unique identifier for the group.
name*	string	Name of the group.

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

first_name

string

—

gender

string

female
male
diverse

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

status*

string

Contact lifecycle status. List endpoints default to active contacts when omitted.

string

active
archived

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

contact_id*

integer

—

cost_center

object

Field	Type	Description
booking_account_number	integer	—
code	string	—
created_at	string (date-time)	Creation timestamp in ISO 8601 format.
id*	integer	—
name*	string	—
updated_at	string (date-time)	Last update timestamp in ISO 8601 format.

cost_center_id

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

currency_code*

string

—

delivery_terms

string

—

email_bcc

string (email)[]

array

Elements

string (email)

email_cc

string (email)[]

array

Elements

string (email)

email_copy_to_self

boolean

—

email_message

string

—

email_subject

string

—

email_to

string (email)[]

array

Elements

string (email)

end_date

string (date)

End of last billing period (End-Datum). To pause, set to the last day to bill.

first_period_start*

string (date)

Start of first billing period (Datum erste Periode). When resuming after a pause, set to the desired restart date.

formatted_number*

string

Display number (account format), unique per account

id*

integer

—

interval_amount*

integer

Length of each billing period in interval_unit steps from the period start (e.g. 3 with unit month = quarterly from first_period_start).

interval_unit*

string

day
week
month
year

invoice_anchor*

string

When in billing period to create invoice (first day, middle, or last day). Used by billing job.

string

first
middle
last

invoice_mode*

string

How automatically created invoices are handled when recurring_document_type is invoice. Does not enable automation by itself; use automatic_generation.

string

automatic_draft
automatic_send_email

last_billing

allOf(1)

Latest invoice or service order for this contract (read-only; matches recurring_document_type)

Latest invoice or service order created for this contract's billing periods (matches recurring_document_type).

Field	Type	Description
document_type*	string	string invoice service_order
formatted_number*	string	—
id*	integer	—
service_contract_period_from	string (date)	—
service_contract_period_to	string (date)	—

last_created_period_start

string (date)

Start date of the last billing period for which a document was created (manual or automatic).

name_line_1

string

—

name_line_2

string

—

name_line_3

string

—

next_billing_period_from

string (date)

Computed; start of next billing period (read-only)

next_billing_period_to

string (date)

Computed; end of next billing period (read-only)

next_invoice_due_date

string (date)

Computed; anchor date when next invoice should be created (read-only)

next_order_due_date

string (date)

Computed when recurring_document_type is service_order; first day of the next billing period (read-only)

number*

integer

Sequential service contract number per account (internal)

payment_method_code

string

—

payment_term_days

integer

Zahlungsziel in Tagen für aus diesem Vertrag erstellte Rechnungen. Fehlt der Wert, wird die Konten-Standard-Einstellung verwendet.

payment_terms

string

—

positions

object[]

array

Elements

Field	Type	Description
chart_of_accounts	string	Chart of accounts snapshot (receipt positions) string deu-skr03 deu-skr04
description	string	—
discount_rate	number	—
discount_value	integer	—
is_optional	boolean	—
ledger_account_name	string	Ledger account name snapshot (receipt positions)
ledger_account_number	string	Ledger account number (receipt positions)
position*	string	—
price_unit	integer	—
product_sku	string	—
quantity	number	—
tax_rate	number	—
title*	string	—
unit_code	string	UN/CEFACT unit of measure code (Recommendation 20/21). Null allowed for optional positions. Code meanings: - C62: unit (piece) - HUR: hour - DAY: day - KGM: kilogram - GRM: gram - LTR: litre - CMT: centimetre - MTR: metre - MTK: square metre - MTQ: cubic metre - KMT: kilometre - TNE: tonne (metric) - PAC: package - PR: pair - BOX: box - RO: roll - SET: set - PCE: page - MIN: minute - SEC: second - MLT: millilitre - MMT: millimetre - P1: percent - ZZ: lump sum (generic / no unit) string C62 HUR DAY KGM GRM LTR CMT MTR MTK MTQ KMT TNE PAC PR BOX RO SET PCE MIN SEC MLT MMT P1 ZZ

positions_price_input_mode

string

Whether position unit prices were entered as net or gross (display preference; price_unit is always stored net).

string

net
gross

print_background_id

integer

—

print_layout_id

integer

—

print_options

object

Field	Type	Description
show_contact_number	boolean	Show contact number
show_folding_marks	boolean	Show folding marks
show_footer	boolean	Show footer
show_header	boolean	Show header
show_item_prices	boolean	Show item prices
show_item_quantities	boolean	Show item quantities
show_item_sku	boolean	Show item SKU
show_item_tax_rate	boolean	Show item tax rate
show_item_totals	boolean	Show item totals
show_logo	boolean	Show logo
show_logo_text	boolean	Show logo text
show_page_numbers	boolean	Show page numbers
show_signature_field	boolean	Show signature field
show_terms	boolean	Show terms
show_totals	boolean	Show totals

project

object

Field

Type

Description

account_user

object

Field

Type

Description

abilities

string[]

array

Elements

string

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

display_email

string

—

display_name

string

—

display_phone

string

—

id*

integer

—

invited_email

string

Email address the user was invited with. Set for pending account users; null after acceptance or when not applicable.

role*

string

user
admin

status*

string

active
blocked
pending

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

user

object

Field	Type	Description
email*	string	—
id*	integer	—
image_url	string	—
name*	string	—

account_user_id

integer

—

contact

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

avatar

object

Field	Type	Description
id	integer	—
url	string	—

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

fields

object[]

List of contact field values

array

Elements

Field	Type	Description
id*	integer	Field ID
key*	string	Field key
value*	object	Value of the field

first_name

string

—

gender

string

female
male
diverse

group_ids

integer[]

array

Elements

integer

groups

object[]

List of groups associated with the contact.

array

Elements

Field	Type	Description
id*	integer	Unique identifier for the group.
name*	string	Name of the group.

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

first_name

string

—

gender

string

female
male
diverse

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

status*

string

Contact lifecycle status. List endpoints default to active contacts when omitted.

string

active
archived

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

contact_id

integer

—

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

description

string

—

end_date

string

—

formatted_number*

string

Display number (account format), unique per account

hex_color

string

—

id*

integer

—

name*

string

—

number*

integer

Sequential project number per account (internal)

start_date

string

—

status

string

—

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

project_id

integer

—

recurring_document_type*

string

Generates either invoices or service orders from this contract, not both.

string

invoice
service_order

reference

string

—

service_object_ids

integer[]

Service object IDs copied to automatically created service orders.

array

Elements

integer

service_order_assignee

object

Field

Type

Description

abilities

string[]

array

Elements

string

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

display_email

string

—

display_name

string

—

display_phone

string

—

id*

integer

—

invited_email

string

Email address the user was invited with. Set for pending account users; null after acceptance or when not applicable.

role*

string

user
admin

status*

string

active
blocked
pending

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

user

object

Field	Type	Description
email*	string	—
id*	integer	—
image_url	string	—
name*	string	—

service_order_assignee_account_user_id

integer

Default field assignee (Bearbeiter) for service orders created from this contract (manual or automatic).

state

string

State or region of the address.

status*

string

active
inactive

subject

string

—

text_bottom

string

—

text_top

string

—

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_rule_code

string

—

zip

string

ZIP or postal code.

service_contract_id

integer

—

service_contract_period_from

string

Date in Y-m-d format

service_contract_period_to

string

Date in Y-m-d format

service_date_from

string

Date in Y-m-d format

service_date_to

string

Date in Y-m-d format

service_location

string

On-site service location (Einsatzort); multiline plain text, not part of the printed document address block

service_object_ids

integer[]

array

Elements

integer

service_objects

object[]

array

Elements

Field

Type

Description

contact

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

avatar

object

Field	Type	Description
id	integer	—
url	string	—

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

fields

object[]

List of contact field values

array

Elements

Field	Type	Description
id*	integer	Field ID
key*	string	Field key
value*	object	Value of the field

first_name

string

—

gender

string

female
male
diverse

group_ids

integer[]

array

Elements

integer

groups

object[]

List of groups associated with the contact.

array

Elements

Field	Type	Description
id*	integer	Unique identifier for the group.
name*	string	Name of the group.

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

first_name

string

—

gender

string

female
male
diverse

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

status*

string

Contact lifecycle status. List endpoints default to active contacts when omitted.

string

active
archived

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

contact_id

integer

—

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

formatted_number*

string

Display number (account format), unique per account

id*

integer

—

installed_at

string (date)

—

internal_description

string

Internal description (panel only)

location

string

—

media_files

object[]

array

Elements

Field

Type

Description

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

description

string

—

entity

object

Field	Type	Description
id	integer	—
name	string	—

entity_id

integer

—

entity_type

string

Account
Contact
PrintLayout
PrintBackground
ServiceProtocol
ServiceObject
ServiceOrder

file_bytes

number

—

file_ext

string

File extension (e.g., 'jpg', 'png', 'pdf'). Note: PDFs are converted to 'jpg' upon upload.

file_type

string

MIME type (e.g., 'image/jpeg', 'image/png', 'application/pdf'). Note: PDFs are converted to 'image/jpeg' upon upload.

id*

integer

—

is_public

boolean

—

key

string

—

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

url*

string

—

user

object

Field	Type	Description
image_url	string	—
name	string	—

user_id

integer

—

name*

string

—

number*

integer

Sequential number per account (internal)

portal_description

string

Description visible in the contact portal

serial_number

string

—

status*

string

active
inactive

type*

string

Category (machine, building, device, vehicle, other)

string

machine
building
device
vehicle
other

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

state

string

State or region of the address.

status*

string

open
planned
in_progress
done
invoiced
cancelled

subject

string

—

sum_gross*

integer

—

sum_net*

integer

—

sum_tax*

integer

—

taxes

object[]

array

Elements

Field	Type	Description
rate*	number	—
total*	integer	—

text_bottom

string

—

text_top

string

—

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_rule_code

string

—

zip

string

ZIP or postal code.

service_order_id

integer

—

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

Example response

{
  "id": 0,
  "number": 0,
  "formatted_number": "string",
  "date": "2025-01-14T13:51:15.000Z",
  "name": "string",
  "description": "string"
}

Service protocols

Questions about integration?