Connector API
Search…
Introduction
Use cases
Guidelines
Operations
Accounting categories
Accounting items
Age categories
Availability blocks
Bills
Business segments
Cashiers
Cashier transactions
Commands
Companies
Companionships
Company contracts
Configuration
Counters
Countries
Credit cards
Currencies
Customers
Departments
Devices
Exchange rates
Images
Languages
Messages
Message threads
Orders
Outlet bills
Outlet items
Outlets
Payments
Preauthorizations
Products
Rates
Reservations
Resource access tokens
Resource blocks
Resources
Restrictions
Rules
Services
Tasks
Tax environments
Taxations
Vouchers
Webhooks
WebSockets
Deprecations
Changelog
Powered By GitBook
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
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0"
5
"Ids": [
6
"3ed9e2f3-4bba-4df6-8d41-ab1b009b6425",
7
"8a98965a-7c03-48a1-a28c-ab1b009b53c8"
8
],
9
"Names": [
10
"AC Company"
11
],
12
"CreatedUtc": {
13
"StartUtc": "2019-12-05T00:00:00Z",
14
"EndUtc": "2019-12-10T00:00:00Z"
15
},
16
"UpdatedUtc": {
17
"StartUtc": "2019-12-10T00:00:00Z",
18
"EndUtc": "2019-12-17T00:00:00Z"
19
}
20
}
Copied!
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
​Time interval​
optional, max length 3 months
Interval of Company creation date and time.
UpdatedUtc
​Time interval​
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

1
{
2
"Companies": [
3
{
4
"AccountingCode": "",
5
"AdditionalTaxIdentifier": "",
6
"Address": {
7
"Id": "bab7441c-4b82-43bc-8001-ab0400a346ec",
8
"Line1": "Rheinlanddamm 207-209",
9
"Line2": "",
10
"City": "Dortmund",
11
"PostalCode": "44137"
12
"CountryCode": "DE",
13
"CountrySubdivisionCode": null,
14
"Latitude": null,
15
"Longitude": null
16
},
17
"ElectronicInvoiceIdentifier": "",
18
"Id": "207b9da3-1c2a-45df-af20-54e57a13368c",
19
"Identifier": "",
20
"Name": "IBM",
21
"IsActive": true,
22
"Number": 25,
23
"TaxIdentifier": "",
24
"BillingCode": "",
25
"Options": {
26
"Invoiceable": true
27
}
28
},
29
{
30
"AccountingCode": "",
31
"AdditionalTaxIdentifier": "",
32
"Address": null,
33
"ElectronicInvoiceIdentifier": "",
34
"Id": "217b9da3-1c2a-45df-af20-54e57a13368c",
35
"Identifier": "",
36
"Name": "Booking.com",
37
"IsActive": true,
38
"TaxIdentifier": "",
39
"BillingCode": ""
40
}
41
]
42
}
Copied!
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.
AccountingCode
string
optional
Accounting code of the company.
Address
​Address​
optional
Address of the company (if it is non-empty, otherwise null).
BillingCode
string
optional
Billing code of the company.
Options
​Company options​
required
Options of the company.

Company options

Property
Type
Contract
Description
Invoiceable
boolean
required
Whether the company is invoiceable or not.

Add company

Adds a new company to the enterprise.

Request

[PlatformAddress]/api/connector/v1/companies/add
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"Name": "Mews",
6
"Options": {
7
"Invoiceable": true
8
},
9
"MotherCompanyId": null,
10
"Identifier": null,
11
"TaxIdentifier": null,
12
"AdditionalTaxIdentifier": null,
13
"BillingCode": null,
14
"AccountingCode": null,
15
"Address": null,
16
"InvoiceDueInterval": "P2DT23H",
17
"Telephone": "111-222-333",
18
"ContacPerson": "SamplePerson",
19
"Contact": "ContactInfo",
20
"Notes": "Note1",
21
"Iata": "PAO"
22
}
Copied!
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
​Address parameters​
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
Contact of the company.
Notes
string
optional
Notes of the company.
Iata
string
optional
Iata of the company.

Company options parameters

Property
Type
Contract
Description
Invoiceable
bool
required
Whether the company is invoiceable 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
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"CompanyId": "7a1e4d67-d6a2-4a4c-a464-ab1100bea786",
6
"Name": {
7
"Value": "Sample company name"
8
},
9
"Options": {
10
"Invoiceable": {
11
"Value": true
12
}
13
},
14
"MotherCompanyId": {
15
"Value": "ff649bce-0c4b-4395-9cdd-02039acb7cb3"
16
},
17
"Identifier": null,
18
"TaxIdentifier": null,
19
"AdditionalTaxIdentifier": null,
20
"BillingCode": null,
21
"AccountingCode": null,
22
"InvoiceDueInterval": {
23
"Value": "P2DT23H"
24
},
25
"ContactPerson": {
26
"Value": "John Snow"
27
},
28
"Contact": {
29
"Value": "John Snow"
30
},
31
"Notes": {
32
"Value": "Notes"
33
},
34
"Iata": {
35
"Value": "PAO"
36
}
37
}
Copied!
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
​String update value​
optional
Name of the company (or null if the name should not be updated).
Options
​Options update value​
optional
Options of the company.
MotherCompanyId
​String update value​
optional
Unique identifier of the mother company (or null if the mother company should not be updated).
Identifier
​String update value​
optional
Identifier of the company, e.g. legal identifier (or null if the identifier should not be updated).
TaxIdentifier
​String update value​
optional
Tax identification number of the company (or null if the tax identifier should not be updated).
AdditionalTaxIdentifier
​String update value​
optional
Additional tax identifer of the company (or null if the additional tax identifier should not be updated).
BillingCode
​String update value​
optional
Billing code of the company (or null if the billing code should not be updated).
AccountingCode
​String update value​
optional
Accounting code of the company (or null if the acounting code should not be updated).
InvoiceDueInterval
​String update value​
optional
The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
ContactPerson
​String update value​
optional
Contact person of the company.
Contact
​String update value​
optional
Contact of the company.
Notes
​String update value​
optional
Notes of the company.
Iata
​String update value​
optional
Iata of the company.

String update value

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

Company options update value

Property
Type
Contract
Description
Invoiceable
​Bool update value​
optional
Whether the company is invoiceable or not.

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.
Previous
Commands
Next
Companionships
Last modified 1mo ago
Copy link
Contents
Get all companies
Request
Response
Add company
Request
Response
Update company
Request
Response