Get all enterprises
POST /api/connector/v1/enterprises/getAll
Returns all enterprises within scope of the Access Token, optionally filtered by enterprise identifiers and external identifiers. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifiers of the Enterprises. If not specified, all enterprises within scope of the Access Token are returned.
Identifiers of the Enterprise from external system.
object
object
Limitation on the quantity of data returned.
object
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "ExternalIdentifiers": [ "Enterprise2023" ], "LinkedUtc": { "StartUtc": "2023-06-01T00:00:00Z", "EndUtc": "2023-06-06T00:00:00Z" }, "UpdatedUtc": { "StartUtc": "2023-10-01T00:00:00Z", "EndUtc": "2023-10-31T00:00:00Z" }, "Limitation": { "Count": 100, "Cursor": "4d0201db-36f5-428b-8d11-4f0a65e960cc" }}Responses
Section titled “ Responses ”OK
object
The filtered enterprises.
object
Unique identifier of the enterprise.
Identifier of the enterprise from external system.
Identifies an enterprise in the external system of a holding company. The holding company may administer multiple portfolios.
Unique identifier of the chain to which the enterprise belongs.
Name of the Chain to which the enterprise belongs.
Creation date and time of the enterprise in UTC timezone in ISO 8601 format.
Creation date and time of the enterprise in UTC timezone in ISO 8601 format.
Name of the enterprise.
IANA timezone identifier of the enterprise.
Unique identifier of the legal environment where the enterprise resides.
Unique code of the accommodation environment where the enterprise resides.
Unique code of the accounting environment where the enterprise resides.
Unique code of the tax environment where the enterprise resides.
Language-culture codes of the enterprise default Language.
Editable history interval for accounting data in ISO 8601 duration format.
Editable history interval for operational data in ISO 8601 duration format.
URL of the enterprise website.
Email address of the enterprise.
Phone number of the enterprise.
Unique identifier of the Image of the enterprise logo.
Unique identifier of the Image of the enterprise cover.
Pricing of the enterprise.
Gross (The enterprise shows amount with gross prices.)
Net (The enterprise shows amount with net prices.)
Tax precision used for financial calculations in the enterprise. If null, Currency precision is used.
Unique identifier of the Address of the enterprise.
Address of the enterprise.
object
Unique identifier of the address.
First line of the address.
Second line of the address.
The city.
Postal code.
ISO 3166-1 code of the Country.
ISO 3166-2 code of the administrative division, e.g. DE-BW.
The latitude.
The longitude.
A list of the group names of the enterprise.
Subscription information of the enterprise.
object
Tax identifier of the Enterprise.
Date and time when enterprise was added to the portfolio in UTC timezone in ISO 8601 format.
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.
Example
{ "Enterprises": [ { "LinkedUtc": "2023-06-01T00:00:00Z", "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ExternalIdentifier": "Enterprise2023", "HoldingKey": "CA123", "ChainId": "2f6be44e-9881-4b12-aefe-afce011a9d67", "ChainName": "Connector API Chain", "CreatedUtc": "2022-03-23T17:12:06Z", "UpdatedUtc": "2022-03-23T17:12:06Z", "Name": "Sample Portfolio Hotel", "TimeZoneIdentifier": "Europe/Budapest", "LegalEnvironmentCode": "DE-2020-1", "AccommodationEnvironmentCode": "DE", "AccountingEnvironmentCode": "DE", "TaxEnvironmentCode": "DE-2020-1", "DefaultLanguageCode": "en-US", "EditableHistoryInterval": null, "AccountingEditableHistoryInterval": "P0M7DT0H0M0S", "OperationalEditableHistoryInterval": "P0M5DT0H0M0S", "WebsiteUrl": "https://www.sample-portfolio-hotel-10004.com/", "Email": "email@sample-portfolio-hotel.com", "Phone": "(555) 555-1234", "LogoImageId": null, "CoverImageId": null, "Pricing": "Gross", "TaxPrecision": 2, "AddressId": "31c505e9-9858-4d2f-9eab-afce011c4f47", "Address": { "Id": "8c2c4371-5d42-40a9-b551-ab0b00d75076", "Line1": "I.P. Pavlova 5", "Line2": null, "City": "Prague", "PostalCode": "1200", "CountryCode": "CZ", "CountrySubdivisionCode": null, "Latitude": 14.429645, "Longitude": 50.075181 }, "GroupNames": [ "Sample Group Name" ], "Subscription": { "TaxIdentifier": "123456789 RC 0001" } } ], "Cursor": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.