Customer
Was this helpful?
Was this helpful?
Customer
Get details for a customer.
Required permission: TENANT.ACCESS
Reference to a Customer.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
CustomerResponseSchema
Example response
Return a complete customer with store specific details.
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to a Customer.
^[A-Za-z0-9-_]+
StoreCustomerDetailsResponseSchema
Example response
List all customers.
Required permission: TENANT.ACCESS
Reference to a tenant.
^[A-Za-z0-9-_]+
External reference to a customer.
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
ENUM | Description |
---|---|
ASC | Sort in ascending order |
DESC | Sort in descending order |
CustomerListResponse
Searches for customers based on criteria set in the request body. Required permission: TENANT.ACCESS
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
ENUM | Description |
---|---|
ASC | Sort in ascending order |
DESC | Sort in descending order |
ENUM | Description |
---|---|
CUSTOMER | Search for customers |
CONTACT | Search for customer contacts |
CustomerListResponse
Searches for customers externally based on criteria set in the request body. Required permission: TENANT.ACCESS. Must have a valid tenantExtension EXTERNAL_CUSTOMER_SEARCH.
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
ENUM | Description |
---|---|
ASC | Sort in ascending order |
DESC | Sort in descending order |
CustomerExternalListResponse
Partial updates are allowed. Required permission: TENANT.ACCESS
Reference to a Customer.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
ISO 3166-1: 2 characters representation of country
Ledger number must be a valid number with possible leading zeros
VAT identification number for value added tax reporting purposes.
^[A-Za-z0-9-_]*
Number of days to calculate due date on invoice
CustomerResponseSchema
Example response
Add an extension to a customer
Reference to a Customer.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
ENUM | Description |
---|---|
TWO_INVOICE | The Two Invoice extension. |
^[A-Za-z0-9-_]+
CustomerResponseSchema
Example response
Delete an extension to a customer
Reference to a Customer.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
ENUM | Description |
---|---|
TWO_INVOICE | The Two Invoice extension. |
^[A-Za-z0-9-_]+
No Content
No Content