Enterprises
Get all enterprises
Returns all enterprises within scope of the Access Token
, optionally filtered by enterprise identifiers and external identifiers. This operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/enterprises/getAll
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. |
| array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, all enterprises within scope of the Access Token are returned. |
| array of string | optional, max 1000 items | Identifiers of the Enterprise from external system. |
| optional, max length 3 months | Interval in which the Enterprise was added to the portfolio. | |
| optional, max length 3 months | Interval in which Enterprise was updated. | |
| required | Limitation on the quantity of enterprises returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Enterprise | required | The filtered enterprises. |
| string | optional | Unique identifier of the last and hence oldest enterprise returned. This can be used in Limitation in a subsequent request to fetch the next batch of older enterprises. |
Enterprise
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the enterprise. |
| string | optional, max 255 characters | Identifier of the enterprise from external system. |
| string | required | Unique identifier of the chain to which the enterprise belongs. |
| string | required | Creation date and time of the enterprise in UTC timezone in ISO 8601 format. |
| string | required | Date and time when enterprise was added to the portfolio 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 | optional | Unique identifier of the enterprise's accommodation environment. |
| string | optional | Unique identifier of the enterprise's accounting environment. |
| string | optional | Unique identifier of the enterprise's tax environment. |
| 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 | optional | Unique identifier of the enterprise logo image. |
| string | optional | Unique identifier of the enterprise cover image. |
| string | required | Pricing of the enterprise. |
| string | optional | Tax precision used for financial calculations in the enterprise. If |
| string | required | Id of the Address of the enterprise. |
Pricing
Gross
- the enterprise shows amount with gross prices.Net
- the enterprise shows amount with net prices.
Last updated