Update customer

patch

https://{xentralId}.xentral.biz/api/v2/customers/{id}

Update an existing customer.

Path Params

string

required

The customer's identifier.

Body Params

Request structure to update a customer

customerType

string | null

enum

Discriminator to create a company. If 'company' is used then 'name' is required. If 'person' is used then 'firstname' and 'lastname' are required.

Allowed:

firstname

string | null

Firstname of customer

lastname

string | null

Lastname of customer

name

string | null

Name of the company

title

string | null

Title prefix for customer name. It will be used for communication.

birthdate

date | null

Birhtdate of customer

number

string | null

Customer number. if this is not provided default number ranges will be applied automatically

deviatingCustomerNumber

string | null

Deviating Customer number.

salutation

string | null

enum

Decide kind of person if necessary. This value is e.g. responsible to apply automatic rules for salutation

Allowed:

salutationPhrase

string | null

You can specify a salutation how a customer/company should be addressed and override automatic rules.

department

string | null

Specify a department for customer

subDepartment

string | null

Specify a sub-department for customer

contactDetails

object

Contact information of a customer

accountManager

object | null

salesManager

object | null

isLead

boolean

Decides if customer is a lead

contactPerson

string | null

Name of contact person

groups

array of integers | null

Specify the list of groups the customer should belong to

groups

customFields

array of objects

List of custom field values

customFields

financials

object

Financial information of a customer

primaryBankAccount

object

documentDelivery

object

Additional settings for document delivery

language

string | null

Language ISO code for customer communication

mainProject

object

Main Project id

commission

float

Commission percentage for this customer

identifier

string | null

Custom identifier for the customer

logfile

string

Log entries of customer activities

lat

float | null

Latitude coordinate

lng

float | null

Longitude coordinate

fromShop

object

Shop where customer originated from

marketing

object

Marketing preferences and settings

shipping

object

Shipping information

Headers

string

enum

Defaults to application/problem+json

Generated from available response content types

Allowed:

Responses

204

Operation completed successfully, no response body

403

Unable to authorize the client

404

Resource was not found or not enough access privileges

415

Resource representation send in the request is not supported.

429

Too many API calls made.

400IETF RFC 9457 Problem API compliant response

401Unable to authenticate the client

409Request conflict with the current state of the target resource