Skip to main content
POST
Creates a contract

Authorizations

Authorization
string
header
required

OAuth2 Bearer Authorization

Body

application/json

Creates a contract. Required permission: crm:contract:create

business
boolean
default:false
required

Is business customer

salutation
integer<int32>
required

Salutation

firstname
string
required

Firstname

Maximum string length: 70
surname
string
required

Surname

Maximum string length: 70
street
string
required

Street

Maximum string length: 255
house_number
string
required

House number

Maximum string length: 16
zip
string
required

ZIP

Maximum string length: 16
city
string
required

City

Maximum string length: 128
country_id
integer<int32>
required

Country id

billing_salutation
integer<int32>
required

Billing salutation

billing_firstname
string
required

Billing firstname

Maximum string length: 70
billing_surname
string
required

Billing surname

Maximum string length: 70
billing_street
string
required

Billing street

Maximum string length: 255
billing_house_number
string
required

Billing house number

Maximum string length: 16
billing_zip
string
required

Billing ZIP

Maximum string length: 16
billing_city
string
required

Billing city

Maximum string length: 128
billing_email
string
required

Billing email

Maximum string length: 128
billing_phone
string
required

Billing phone

Maximum string length: 128
ext_contract_id
string

External contract id

Maximum string length: 50
external_customer_id
string

External customer ID

Maximum string length: 15
customer_group_id
integer<int32>

Customer group id

company_name
string

Company name

Maximum string length: 255
company_name_addendum
string

Company name addendum

Maximum string length: 255
title
string

Title

Maximum string length: 50
date_of_birth
string<date>

Date of birth

Pattern: ^\d{4}-\d{2}-\d{2}$
phone_home
string

Home phone number

Maximum string length: 50
phone_home_area_code
string

Home phone area code

Maximum string length: 10
phone_mobile
string

Mobile phone number

Maximum string length: 50
phone_mobile_area_code
string

Mobile phone area code

Maximum string length: 10
phone_business
string

Business phone number

Maximum string length: 50
phone_business_area_code
string

Business phone area code

Maximum string length: 10
email_private
string

Private email

Maximum string length: 255
email_business
string

Business email

Maximum string length: 255
reference_field_1
string

Reference field 1

Maximum string length: 255
reference_field_2
string

Reference field 2

Maximum string length: 255
billing_company
string

Billing company

Maximum string length: 255
billing_title
string

Billing title

Maximum string length: 70
billing_country_id
integer<int32>

Billing country id

billing_fax
string

Billing fax

Maximum string length: 128
vehicle_manufacturer
string

Vehicle manufacturer

Maximum string length: 100
vehicle_model
string

Vehicle model

Maximum string length: 100
vehicle_license_plate
string

Vehicle license plate

Maximum string length: 50
vehicle_country_of_registration_id
integer<int32>

Vehicle country of registration

auth_username
string

App login username

Maximum string length: 255
auth_password
string

Auth password

Maximum string length: 128
advertising_agreement_mail
boolean
default:false

Advertising agreement mail

advertising_agreement_phone
boolean
default:false

Advertising agreement phone

advertising_agreement_email
boolean
default:false

Advertising agreement email

accept_current_agb
boolean
default:false

Accept current AGB

accept_current_privacy_policy
boolean
default:false

Accept current privacy policy

vat_identification_number
string

VAT identification number

Maximum string length: 50
tax_code
string

Tax code

Maximum string length: 50
simulation
boolean
default:false

Simulation mode

start_date
string<date>

Start date

Pattern: ^\d{4}-\d{2}-\d{2}$
attributes
string

JSON-encoded key-value pairs of attribute identifiers and values

Response

Contract created

contract
object
required

Contract

customer_id
integer<int32>

Customer ID

external_customer_id
string

External customer ID

mail_verification_needed
boolean
default:false

Mail verification needed

contract_confirmation_needed
boolean
default:false

Contract confirmation needed