PATCH /api/account/service-objects/{id}

patch/api/account/service-objects/{id}

Example request

PATCH https://api.jupiter-erp.com/api/account/service-objects/example-id

Code

curl -X PATCH 'https://api.jupiter-erp.com/api/account/service-objects/example-id' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'X-Account-Uuid: YOUR_ACCOUNT_UUID' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "number": 0,
  "formatted_number": "string",
  "name": "string",
  "type": "machine",
  "serial_number": "string",
  "location": "string"
}'

Parameters

Name	In	Required	Description
id	path	yes	—

Request body

Optional

ModelUpdateServiceObjectRequest

Field	Type	Description
contact_id	integer	—
formatted_number	string	—
installed_at	string (date)	—
internal_description	string	—
location	string	—
name	string	—
number	integer	—
portal_description	string	—
serial_number	string	—
status	string	string active inactive
type	string	string machine building device vehicle other

Example request

{
  "number": 0,
  "formatted_number": "string",
  "name": "string",
  "type": "machine",
  "serial_number": "string",
  "location": "string"
}

Responses

200OK

ModelServiceObject

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.

Example response

{
  "id": 0,
  "number": 0,
  "formatted_number": "string",
  "name": "string",
  "type": "machine",
  "serial_number": "string",
  "status": "active"
}

Service objects

Questions about integration?