--- title: "Get all enterprises" method: POST path: "/api/connector/v1/enterprises/getAll" tags: ["Enterprises"] --- # 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](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). ## Request body - EnterpriseFilterParameters - `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. - `EnterpriseIds` string[], nullable — Unique identifiers of the [Enterprises](https://mews-systems.gitbook.io/connector-api/operations/#enterprise). If not specified, all enterprises within scope of the Access Token are returned. - `ExternalIdentifiers` string[], nullable — Identifiers of the [Enterprise](https://mews-systems.gitbook.io/connector-api/operations/#enterprise) from external system. - `LinkedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `UpdatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `Limitation` Limitation, required — Limitation on the quantity of data returned. - `Count` integer, required - `Cursor` string, uuid, nullable ## Response `200` OK - EnterpriseResult - `Enterprises` EnterprisePortfolio[], required — The filtered enterprises. - `Id` string, uuid, required — Unique identifier of the enterprise. - `ExternalIdentifier` string, nullable — Identifier of the enterprise from external system. - `HoldingKey` string, nullable — Identifies an enterprise in the external system of a holding company. The holding company may administer multiple portfolios. - `ChainId` string, uuid, required — Unique identifier of the chain to which the enterprise belongs. - `ChainName` string, required — Name of the `Chain` to which the enterprise belongs. - `CreatedUtc` string, date-time, required — Creation date and time of the enterprise in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the enterprise in UTC timezone in ISO 8601 format. - `Name` string, required — Name of the enterprise. - `ShortName` string, nullable — Short name of the enterprise used in Manager Report exports. - `TimeZoneIdentifier` string, required — IANA timezone identifier of the enterprise. - `LegalEnvironmentCode` string, required — Unique identifier of the legal environment where the enterprise resides. - `AccommodationEnvironmentCode` string, required — Unique code of the accommodation environment where the enterprise resides. - `AccountingEnvironmentCode` string, required — Unique code of the accounting environment where the enterprise resides. - `TaxEnvironmentCode` string, required — Unique code of the tax environment where the enterprise resides. - `DefaultLanguageCode` string, required — Language-culture codes of the enterprise default `Language`. - `EditableHistoryInterval` string, required - `AccountingEditableHistoryInterval` string, required — Editable history interval for accounting data in ISO 8601 duration format. - `OperationalEditableHistoryInterval` string, required — Editable history interval for operational data in ISO 8601 duration format. - `BusinessDayClosingOffset` string, nullable — The offset value for the business day closing time, in ISO 8601 duration format. - `WebsiteUrl` string, uri, nullable — URL of the enterprise website. - `Email` string, email, nullable — Email address of the enterprise. - `Phone` string, tel, nullable — Phone number of the enterprise. - `LogoImageId` string, uuid, nullable — Unique identifier of the `Image` of the enterprise logo. - `CoverImageId` string, uuid, nullable — Unique identifier of the `Image` of the enterprise cover. - `Pricing` 'Gross' | 'Net', required — Gross (The enterprise shows amount with gross prices.) Net (The enterprise shows amount with net prices.) - `TaxPrecision` integer, nullable — Tax precision used for financial calculations in the enterprise. If `null`, `Currency` precision is used. - `AddressId` string, uuid, required — Unique identifier of the `Address` of the enterprise. - `Address` OldAddress, required - `Id` string, uuid — Unique identifier of the address. - `Line1` string, nullable — First line of the address. - `Line2` string, nullable — Second line of the address. - `City` string, nullable — The city. - `PostalCode` string, nullable — Postal code. - `CountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `CountrySubdivisionCode` string, nullable — ISO 3166-2 code of the administrative division, e.g. `DE-BW`. - `Latitude` number, double, nullable — The latitude. - `Longitude` number, double, nullable — The longitude. - `GroupNames` string[], required — A list of the group names of the enterprise. - `Subscription` EnterpriseSubscription, required - `TaxIdentifier` string, nullable — Tax identifier of the `Enterprise`. - `LinkedUtc` string, date-time, required — Date and time when enterprise was added to the portfolio in UTC timezone in ISO 8601 format. - `Cursor` string, uuid, nullable — Unique identifier of the last and hence oldest enterprise returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of older enterprises. ## Other responses - `204` — Server has successfully fulfilled the request and there is no additional information to send back. - `400` — 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). - `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. - `403` — 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. - `408` — 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) - `429` — 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). - `500` — 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](https://github.com/MewsSystems/gitbook-connector-api). --- [API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/revisions/f37f136ed35a/schema)