v3

OpenAPI 3.0.42026-07-312008682.1 MB
Companies

Add company

Adds a new company. Note this operation supports Portfolio Access Tokens.

post/api/connector/v1/companies/add

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

ChainIdstring uuid nullable

Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.

Namestring required

Name of the company.

MotherCompanyIdstring uuid nullable

Unique identifier of the mother company.

InvoicingEmailstring email nullable

Email for issuing invoices to the company.

WebsiteUrlstring uri nullable

The website url of the company.

InvoiceDueIntervalstring nullable

The maximum time, when the invoice has to be be paid in ISO 8601 duration format.

Departmentstring nullable

The internal segmentation of a company, e.g. sales department.

DunsNumberstring nullable

The Dun & Bradstreet unique 9-digit DUNS number.

ReferenceIdentifierstring nullable

External system identifier - custom identifier used by an external system such as an external database.

AccountingCodestring nullable

Accounting code of the company.

AdditionalTaxIdentifierstring nullable

Additional tax identifer of the company.

BillingCodestring nullable

Billing code of the company.

Contactstring nullable

Other contact details, such as telephone, email or similar.

ContactPersonstring nullable

Contact person of the company.

Identifierstring nullable

Fiscal or legal identifier of the company.

Iatastring nullable

Iata of the company.

Notesstring nullable

Notes of the company.

TaxIdentifierstring nullable

Tax identification number of the company.

Telephonestring tel nullable

Contact telephone number.

ExternalIdentifierstring nullable

Identifier of the company from external system.

Response

OK

Cursorstring uuid nullable

Unique identifier of the last and hence oldest company item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older companies. If Limitation is specified in the request message, then Cursor will always be included in the response message; this is true even when using Extents set to false so that no actual data is returned.