Connector API
Search…
⌃K

Companies

Get all companies

Returns all company profiles of the enterprise, possibly filtered by identifiers, names or other filters.

Request

[PlatformAddress]/api/connector/v1/companies/getAll
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0"
"Ids": [
"3ed9e2f3-4bba-4df6-8d41-ab1b009b6425",
"8a98965a-7c03-48a1-a28c-ab1b009b53c8"
],
"Names": [
"AC Company"
],
"CreatedUtc": {
"StartUtc": "2019-12-05T00:00:00Z",
"EndUtc": "2019-12-10T00:00:00Z"
},
"UpdatedUtc": {
"StartUtc": "2019-12-10T00:00:00Z",
"EndUtc": "2019-12-17T00:00:00Z"
}
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
Ids
array of string
optional, max 1000 items
Unique identifiers of Companies.
Names
array of string
optional, max 1000 items
Names of Companies.
CreatedUtc
optional, max length 3 months
Interval of Company creation date and time.
UpdatedUtc
optional, max length 3 months
Interval of Company last update date and time.

Time interval

Property
Type
Contract
Description
StartUtc
string
required
Start of the interval in UTC timezone in ISO 8601 format.
EndUtc
string
required
End of the interval in UTC timezone in ISO 8601 format.

Response

{
"Companies": [
{
"Id": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
"Name": "Sample Company 1",
"IsActive": true,
"Number": 11,
"Identifier": null,
"TaxIdentifier": null,
"AdditionalTaxIdentifier": null,
"ElectronicInvoiceIdentifier": null,
"InvoiceDueInterval": "P2DT23H",
"AccountingCode": null,
"MotherCompanyId": null,
"CreatedUtc": "2022-07-11T09:56:54Z",
"UpdatedUtc": "2022-07-11T09:56:54Z",
"Address": {
"Id": "bab7441c-4b82-43bc-8001-ab0400a346ec",
"Line1": "Rheinlanddamm 207-209",
"Line2": "",
"City": "Dortmund",
"PostalCode": "44137"
"CountryCode": "DE",
"CountrySubdivisionCode": null,
"Latitude": null,
"Longitude": null
},
"BillingCode": null,
"Iata": "PAO",
"Telephone": "111-222-333",
"InvoicingEmail": "[email protected]",
"ContacPerson": "Sample Person 1",
"Contact": "Contact Info 1",
"Notes": "Note 1",
"Options": {
"Invoiceable": true,
"AddFeesToInvoices": true
},
"Department": "Sales",
"DunsNumber": "123456789",
"CreditRating": {
"Basic": "PaymentRequiredUpfront"
}
},
{
"Id": "da34b396-41f7-47f6-8847-aecf00a3f19e",
"Name": "Sample Company 2",
"IsActive": true,
"Number": 12,
"Identifier": null,
"TaxIdentifier": null,
"AdditionalTaxIdentifier": null,
"ElectronicInvoiceIdentifier": null,
"InvoiceDueInterval": "P2DT23H",
"AccountingCode": null,
"MotherCompanyId": null,
"CreatedUtc": "2022-07-11T09:56:54Z",
"UpdatedUtc": "2022-07-11T09:56:54Z",
"Address": null,
"BillingCode": null,
"Iata": "PAO",
"Telephone": "111-222-333",
"InvoicingEmail": "[email protected]",
"ContacPerson": "Sample Person 2",
"Contact": "Contact Info 2",
"Notes": "Note 2",
"Options": {
"Invoiceable": true,
"AddFeesToInvoices": false
},
"Department": "Accounting",
"DunsNumber": "987654321",
"CreditRating": {
"Basic": "CreditOk"
}
}
]
}
Property
Type
Contract
Description
Companies
array of Company
required
The company profiles of the enterprise.

Company

Property
Type
Contract
Description
Id
string
required
Unique identifier of the company.
Name
string
required
Name of the company.
IsActive
boolean
required
Whether the company is still active.
Number
number
required
Unique number of the company.
Identifier
string
optional
Identifier of the company (e.g. legal identifier).
TaxIdentifier
string
optional
Tax identification number of the company.
AdditionalTaxIdentifier
string
optional
Additional tax identifier of the company.
ElectronicInvoiceIdentifier
string
optional
Electronic invoice identifier of the company.
InvoiceDueInterval
string
optional
The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
AccountingCode
string
optional
Accounting code of the company.
MotherCompanyId
guid
optional
Unique identifier of mother company.
CreatedUtc
string
optional
Date of Company creation date and time.
UpdatedUtc
string
optional
Date of Company last update date and time.
Address
Address
optional
Address of the company (if it is non-empty, otherwise null).
BillingCode
string
optional
Billing code of the company.
Iata
string
optional
Iata of the company.
Telephone
string
optional
Contact telephone number.
InvoicingEmail
string
optional
Email for issuing invoices to the company.
ContactPerson
string
optional
Contact person of the company.
Contact
string
optional
Other contact details, such as telephone, email or similar.
Notes
string
optional
Additional notes.
Options
required
Options of the company.
Department
string
optional
The internal segmentation of a company, e.g. sales department.
DunsNumber
string
optional
The Dun & Bradstreet unique 9-digit DUNS number.
CreditRating
optional
Credit rating to define creditworthiness of the company.

Company options

Property
Type
Contract
Description
Invoiceable
boolean
required
Whether the company is invoiceable or not.
AddFeesToInvoices
boolean
required
Whether the company has an additional fee applied for invoicing or not.

Credit rating

Property
Type
Contract
Description
Basic
optional
The level of creditworthiness of the company.

Credit rating basic

  • CreditOk
  • PaymentRequiredUpfront
  • LocalDecisionRequired

Add company

Adds a new company to the enterprise.

Request

[PlatformAddress]/api/connector/v1/companies/add
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"Name": "Mews",
"Options": {
"Invoiceable": true,
"AddFeesToInvoices": true
},
"MotherCompanyId": null,
"Identifier": null,
"TaxIdentifier": null,
"AdditionalTaxIdentifier": null,
"BillingCode": null,
"AccountingCode": null,
"Address": null,
"InvoiceDueInterval": "P2DT23H",
"Telephone": "111-222-333",
"ContacPerson": "SamplePerson",
"Contact": "ContactInfo",
"Notes": "Note1",
"Iata": "PAO",
"Department": "Sales",
"DunsNumber": "987654321",
"CreditRating": {
"Basic": "CreditOk"
}
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
Name
string
required
Name of the company.
Options
required
Options of the company.
MotherCompanyId
string
optional
Unique identifier of the mother company.
Identifier
string
optional
Identifier of the company (e.g. legal identifier).
TaxIdentifier
string
optional
Tax identification number of the company.
AdditionalTaxIdentifier
string
optional
Additional tax identifer of the company.
BillingCode
string
optional
Billing code of the company.
AccountingCode
string
optional
Accounting code of the company.
Address
optional
Address of the company.
InvoiceDueInterval
string
optional
The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
ContactPerson
string
optional
Contact person of the company.
Contact
string
optional
Other contact details, such as telephone, email or similar.
Notes
string
optional
Notes of the company.
Iata
string
optional
Iata of the company.
Department
string
optional
The internal segmentation of a company, e.g. sales department.
DunsNumber
string
optional
The Dun & Bradstreet unique 9-digit DUNS number.
CreditRating
optional
Credit rating to define creditworthiness of the company.

Company options parameters

Property
Type
Contract
Description
Invoiceable
boolean
required
Whether the company is invoiceable or not.
AddFeesToInvoices
boolean
required
Whether the company has an additional fee applied for invoicing or not.

Response

Same structure as in Get all companies operation.

Update company

Updates information of the company.

Request

[PlatformAddress]/api/connector/v1/companies/update
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"CompanyId": "7a1e4d67-d6a2-4a4c-a464-ab1100bea786",
"Name": {
"Value": "Sample company name"
},
"Options": {
"Invoiceable": {
"Value": true
},
"AddFeesToInvoices": {
"Value": false
}
},
"MotherCompanyId": {
"Value": "ff649bce-0c4b-4395-9cdd-02039acb7cb3"
},
"Identifier": null,
"TaxIdentifier": null,
"AdditionalTaxIdentifier": null,
"BillingCode": null,
"AccountingCode": null,
"InvoiceDueInterval": {
"Value": "P2DT23H"
},
"ContactPerson": {
"Value": "John Snow"
},
"Contact": {
"Value": "John Snow"
},
"Notes": {
"Value": "Notes"
},
"Iata": {
"Value": "PAO"
},
"Department": {
"Value": "Marketing"
},
"DunsNumber": {
"Value": "123456789"
},
"CreditRating": {
"Basic": {
"Value": "PaymentRequiredUpfront"
}
}
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
CompanyId
string
required
Unique identifier of the Company.
Name
optional
Name of the company (or null if the name should not be updated).
Options
optional
Options of the company.
MotherCompanyId
optional
Unique identifier of the mother company (or null if the mother company should not be updated).
Identifier
optional
Identifier of the company, e.g. legal identifier (or null if the identifier should not be updated).
TaxIdentifier
optional
Tax identification number of the company (or null if the tax identifier should not be updated).
AdditionalTaxIdentifier
optional
Additional tax identifer of the company (or null if the additional tax identifier should not be updated).
BillingCode
optional
Billing code of the company (or null if the billing code should not be updated).
AccountingCode
optional
Accounting code of the company (or null if the acounting code should not be updated).
InvoiceDueInterval
optional
The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
ContactPerson
optional
Contact person of the company.
Contact
optional
Other contact details, such as telephone, email or similar.
Notes
optional
Notes of the company.
Iata
optional
Iata of the company.
Department
optional
The internal segmentation of a company, e.g. sales department.
DunsNumber
optional
The Dun & Bradstreet unique 9-digit DUNS number.
CreditRating
optional
Credit rating to define creditworthiness of the company.

Company options update value

Property
Type
Contract
Description
Invoiceable
optional
Whether the company is invoiceable or not.
AddFeesToInvoices
optional
Whether the company has an additional fee applied for invoicing or not.

Credit rating update value

Property
Type
Contract
Description
Basic
string update value with possible values of Credit rating basic
optional
The level of creditworthiness of the company.

String update value

Property
Type
Contract
Description
Value
string
optional
Value which is to be updated.

Bool update value

Property
Type
Contract
Description
Value
bool
optional
Value which is to be updated.

Response

Same structure as in Get all companies operation.