POST /api/account/contacts

post/api/account/contacts

Beispielanfrage

POST https://api.jupiter-erp.com/api/account/contacts

Code

curl -X POST 'https://api.jupiter-erp.com/api/account/contacts' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'X-Account-Uuid: YOUR_ACCOUNT_UUID' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "parent_id": 0,
  "type": "organisation",
  "name": "string",
  "company_name": "string",
  "gender": "female",
  "title": "string"
}'

Request Body

Optional

ModellCreateContactRequest

Feld

Typ

Beschreibung

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.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elemente

Feld	Typ	Beschreibung
name	string	—
value	string (email)	—

fields

object[]

array

Elemente

Feld	Typ	Beschreibung
id*	integer	Id of the field
value	object	Value of the field

first_name

string

—

gender

string

female
male
diverse

group_ids

integer[]

array

Elemente

integer

internal_note

string

HTML

last_name

string

—

name*

string

—

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elemente

Feld	Typ	Beschreibung
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

vat_id

string

VAT ID

websites

object[]

array

Elemente

Feld	Typ	Beschreibung
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

Beispiel Request

{
  "parent_id": 0,
  "type": "organisation",
  "name": "string",
  "company_name": "string",
  "gender": "female",
  "title": "string"
}

Antworten

201Created

ModellContact

Feld

Typ

Beschreibung

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

Feld	Typ	Beschreibung
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

Elemente

Feld	Typ	Beschreibung
name	string	—
value	string (email)	—

fields

object[]

List of contact field values

array

Elemente

Feld	Typ	Beschreibung
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

Elemente

integer

groups

object[]

List of groups associated with the contact.

array

Elemente

Feld	Typ	Beschreibung
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

Feld

Typ

Beschreibung

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

Elemente

Feld	Typ	Beschreibung
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

Elemente

Feld	Typ	Beschreibung
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

Elemente

Feld	Typ	Beschreibung
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

Elemente

Feld	Typ	Beschreibung
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

Elemente

Feld	Typ	Beschreibung
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

Beispiel Response

{
  "id": 0,
  "parent_id": 0,
  "parent": {
    "id": 0,
    "parent_id": 0,
    "type": "organisation",
    "is_organisation": true,
    "name": "string",
    "company_name": "string"
  },
  "type": "organisation",
  "is_organisation": true,
  "name": "string",
  "status": "active"
}

Contacts

Fragen zur Integration?