Create new customer
- 17 Jan 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Create new customer
- Updated on 17 Jan 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/customers/
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Body parameters
Customer to be created
object
Address
integer
Customer address id
Customer_language
integer Required
Customer language id
Customer_restricted_type
integer
Customer restricted type id This field determines protection level of data under GDPR
Customer_state
integer Required
Customer status id
Customer_type
integer Required
Customer type id
Invoicing_address
integer
Customer apartment id
coop_date
string (date)
Cooperative date
coop_member
boolean
If customer is a member of cooperative or not
coop_reimburse_date
string (date)
Cooperative date of reimbursement
coop_sum
integer
Sum of cooperative
customer_country
string
Customer country
customer_email
string
Customer email address GDPR protected field
customer_name
string Required
Name of customer GDPR protected field
customer_name_ext
string
Customer name extension GDPR protected field
customer_number
string Required
Customer number
customer_phone
string
Primary phone number GDPR protected field
edited_by_customer_timestamp
string (date-time)
Customer modified date and time
id
integer
Primary key
identification
string
Identification of customer
invoicing_country
string
Invoicing country
invoicing_name
string
Invoice name GDPR protected field
is_edited_by_customer
boolean
If editable by customer
no_sms
boolean
If true sms sending is disabled otherwise, it is enabled
note
string
Customer note or additional details
phone2
string
Secondary phone number GDPR protected field
two_sms_numbers
boolean
Two SMS numbers
vat_code
string
Personal/Business ID GDPR protected field
water_db_id
integer
Water database id
Responses
201
A created Customer
object
Address
integer
Customer address id
Customer_language
integer
Customer language id
Customer_restricted_type
integer
Customer restricted type id This field determines protection level of data under GDPR
Customer_state
integer
Customer status id
Customer_type
integer
Customer type id
Invoicing_address
integer
Customer apartment id
coop_date
string (date)
Cooperative date
coop_member
boolean
If customer is a member of cooperative or not
coop_reimburse_date
string (date)
Cooperative date of reimbursement
coop_sum
integer
Sum of cooperative
customer_country
string
Customer country
customer_email
string
Customer email address GDPR protected field
customer_name
string
Name of customer GDPR protected field
customer_name_ext
string
Customer name extension GDPR protected field
customer_number
string
Customer number
customer_phone
string
Primary phone number GDPR protected field
edited_by_customer_timestamp
string (date-time)
Customer modified date and time
id
integer
Primary key
identification
string
Identification of customer
invoicing_country
string
Invoicing country
invoicing_name
string
Invoice name GDPR protected field
is_edited_by_customer
boolean
If editable by customer
no_sms
boolean
If true sms sending is disabled otherwise, it is enabled
note
string
Customer note or additional details
phone2
string
Secondary phone number GDPR protected field
two_sms_numbers
boolean
Two SMS numbers
vat_code
string
Personal/Business ID GDPR protected field
water_db_id
integer
Water database id
400
There was an error in request. Usually field validation failed.
Fields which failed validation
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
