HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Create customer

post
https://api.instellix.io/v2/customers

A new customer can be created together with their addresses (at least one) and properties (optional).
The ident is required and must be unique.

Query Params
boolean
Defaults to false

If set to true, the response objects will be smaller and not contain nested collection fields, i.e. Addresses.

Body Params

The representation of a customer. Customers are assigned addresses and properties.
Other objects are linked to the customer via the unique ident, which can be an external reference such as a customer number.

addresses
array of objects
required
length ≥ 1

The addresses of the customer.
Must not be empty.

addresses*

An address create request that is assigned to a specific debtorId. Can be of addressType INVOICE or SHIPPING.

string | null

Size must be between 0 and 255.

string | null

Optional additional address information.
Size must be between 0 and 255.

string | null
[a-zA-Z0-9_.~-]{1,100}

Unique external reference. If not provided NBX will auto generate a UUID.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

string
required

Cannot be amended after the initial POST.
Must not be null.
Must be one of:

INVOICE
SHIPPING
string | null

Agency Profession Title.
Size must be between 0 and 255.

string | null

City.
Size must be between 0 and 255.

string | null

Company name.
Size must be between 0 and 255.

string
required

Country code for country of address. Uses Alpha-2 or Alpha3 code (ISO 3166): https://www.iban.com/country-codes.
Must not be null.

string | null

Department within a company.
Size must be between 0 and 255.

eInvoicingParameters
object | null

Provides information needed to handle e-invoicing.

string | null

Recipient's email. It becomes mandatory for addresses of addressType INVOICE and preferredDocumentDelivery EMAIL.
Size must be between 0 and 255.

string | null

First name of recipient.
Size must be between 0 and 255.

string | null

Recipient's gender.
Must be one of:

MALE
FEMALE
OTHER
NOTSET
string | null

Last name of recipient.
Size must be between 0 and 255.

string | null

Number of post office box.
Size must be between 0 and 255.

string
Defaults to NONE

Defines the preferred way of delivering documents to this customer. Only used for Addresses of Type INVOICE. When set to EMAIL and addressType is INVOICE, the field email must be filled.
Must be one of:

EMAIL
LETTER
NONE
properties
array of objects | null, unique

Array of properties assigned to the specific address.

properties
string | null

State.
Size must be between 0 and 255.

string | null

State code. ISO 3166-2 subdivision code.
Size must be between 0 and 255.

string | null

Name of street.
Size must be between 0 and 255.

string | null

Street Number.
Size must be between 0 and 255.

string | null

The taxNumber is the local country tax number given to a legal entity by their tax authority such as the German Steuernummer or Italian Codice Fiscale.
Size must be between 0 and 32.

string | null

Status of address validation if required by configured tax provider.
Must be one of:

TAXABLE
NON_TAXABLE
VALIDATION_PENDING
VALIDATION_NOT_REQUIRED
NOT_VALIDATED
VALIDATION_FAILED
string | null

Also known as VAT identification number (VATIN). An identifier used by countries for Value Added Tax purposes to identify legal entities, especially in the EU.
Size must be between 0 and 20.

string | null

Postcode.
Size must be between 0 and 20.

string | null

Contractor (reference) id which can be used for example as customer support ident by third parties' system.
Size must be between 0 and 255.

string | null

Additional type that can be used to distinguish contractor reference ident, e.g. DEALER_ID or CUSTOMER_ID.
Size must be between 0 and 255.

string | null

Type of the customer.
Must be one of:

B2B
B2C
AFFILIATED
int64 | null

Can be either set at customer creation, in which case the associated debtor booking account will receive the provided number, or set by the nitrobox system automatically.

dunning
object | null

The customer dunning configuration.

string
required
length between 1 and 100
[a-zA-Z0-9_.~-]{1,100}

Unique external reference.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

string | null

The language of the customer. Should be in ISO 639-1 ('de') format and if given must match to the used Business Segment.

properties
array of objects | null, unique

Set of properties assigned to the specific customer.

properties
taxClassifications
array of objects | null

Updates a tax classification of a customer with a validity period.

taxClassifications
int64 | null

Is set by the Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.

Responses

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?