Configuration
Get configuration
Returns the enterprise configuration. For single-enterprise Access Tokens, this is the enterprise associated with the token. For Portfolio Access Tokens, use the EnterpriseId
parameter to specify which enterprise you want the configuration for. In the case of service scoped integrations, the operation returns the configuration associated with both the enterprise and the bookable service linked to the token.
Request
[PlatformAddress]/api/connector/v1/configuration/get
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the Enterprise, defaults to the enterprise associated with the given access token. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Current server date and time in UTC timezone in ISO 8601 format. |
| required | The enterprise (e.g. hotel, hostel) associated with the access token. | |
| optional | The reservable service (e.g. accommodation, parking) associated with the access token of the service scoped integration. | |
| optional | Contains information about payment card storage. |
Enterprise
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the enterprise. |
| string | required | Unique identifier of the chain whose member the enterprise is. |
| string | required | Creation date and time of the enterprise in UTC timezone in ISO 8601 format. |
| string | required | Creation date and time of the enterprise in UTC timezone in ISO 8601 format. |
| string | required | Name of the enterprise. |
| string | required | IANA timezone identifier of the enterprise. |
| string | required | Unique identifier of the legal environment where the enterprise resides. |
| string | required | Language-culture codes of the enterprise default Language. |
|
|
|
|
| string | required | Editable history interval for accounting data in ISO 8601 duration format. |
| string | required | Editable history interval for operational data in ISO 8601 duration format. |
| string | optional | URL of the enterprise website. |
| string | optional | Email address of the enterprise. |
| string | optional | Phone number of the enterprise. |
| string | required | Unique identifier of the enterprise logo image. |
| string | required | Unique identifier of the enterprise cover image. |
| string | required | Unique identifier of the Address of the enterprise. |
|
|
| |
| array of Accepted currency | required | Currencies accepted by the enterprise. |
| string | required | Pricing of the enterprise. |
| string | optional | Tax precision used for financial calculations in the enterprise. If |
| string | optional, max 255 characters | Identifier of the enterprise from external system. |
| optional | Configuration information containg financial information about the property. |
Address
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the address. |
| string | optional | First line of the address. |
| string | optional | Second line of the address. |
| string | optional | The city. |
| string | optional | Postal code. |
| string | optional | ISO 3166-1 code of the Country. |
| string | optional | ISO 3166-2 code of the administrative division, e.g. |
| number | optional | The latitude. |
| number | optional | The longitude. |
Accepted currency
Property | Type | Contract | Description |
---|---|---|---|
| string | required | ISO-4217 code of the Currency. |
| bool | required | Whether the currency is a default accounting currency. |
| bool | required | Whether the currency is enabled for usage. |
Pricing
Gross
- the enterprise shows amount with gross prices.Net
- the enterprise shows amount with net prices.
Payment card storage
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Key for accessing PCI proxy storage. |
Accounting configuration
Property | Type | Contract | Description |
---|---|---|---|
| string | optional, max 50 characters | Organization number. |
| string | optional, max 100 characters | Legal name of the company. |
| string | optional, max 50 characters | Bank account number. |
| string | optional, max 100 characters | Name of the bank. |
| string | optional, max 40 characters | International Bank Account Number. |
| string | optional, max 11 characters | Business Identification Code. |
Last updated