--- title: "Get all outlet items" method: POST path: "/api/connector/v1/outletItems/getAll" tags: ["Outlet items"] --- # Get all outlet items `POST /api/connector/v1/outletItems/getAll` Returns all outlet items of the enterprise that were consumed (posted) or will be consumed within the specified interval. If the `Currency` is specified, costs of the items are converted to that currency. 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 - OutletItemsFilterParameters - `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. - `Limitation` Limitation, required — Limitation on the quantity of data returned. - `Count` integer, required - `Cursor` string, uuid, nullable - `EnterpriseIds` string[], nullable — Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. - `Ids` string[], nullable — Unique identifiers of the [Outlet items](#outlet-item). If not specified, the operation returns data for all [Outlet items](#outlet-item) within scope of the Access Token. - `ConsumedUtc` 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 - `ClosedUtc` 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 - `Currency` string, currency, nullable — ISO-4217 code of the [Currency](#currency) the item costs should be converted to. ## Response `200` OK - OutletItemResult - `OutletItems` OutletItem[], required — The outlet items. - `Id` string, uuid, required — Unique identifier of the item. - `EnterpriseId` string, uuid, required — Unique identifier of the [Enterprise](https://mews-systems.gitbook.io/connector-api/operations/enterprises/#enterprise). - `BillId` string, uuid, required — Unique identifier of the [Outlet bill](https://mews-systems.gitbook.io/connector-api/operations/#outlet-bill) the item belongs to. - `AccountingCategoryId` string, uuid, nullable — Unique identifier of the [Accounting category](https://mews-systems.gitbook.io/connector-api/operations/accountingcategories/#accounting-category) the item belongs to. - `Type` 'Revenue' | 'NonRevenue' | 'Payment', required — Type of the outlet item. - `Name` string, nullable — Name of the item. - `UnitCount` integer, required — Unit count of the item. - `UnitAmount` Amount, required - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - `Code` string, nullable — Code corresponding to tax type. - `Value` number, double, required — Amount of tax applied. - `Breakdown` TaxBreakdown, required - `Items` TaxBreakdownItem[], required — Tax breakdown items per each tax rate applied. - `TaxRateCode` string, nullable — Tax rate code for the item. `null` for untaxed amounts. - `NetValue` number, double, required — The net value that the tax is calculated from. - `TaxValue` number, double, required — The value of the tax. - `CreatedUtc` string, date-time, required — Date and time of the item creation in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the item in UTC timezone in ISO 8601 format. - `ConsumedUtc` string, date-time, required — Date and time of the item consumption in UTC timezone in ISO 8601 format. - `ExternalIdentifier` string, nullable — An identifier of this item from another system. - `Notes` string, nullable — Additional notes. - `PaymentCardPaymentId` string, uuid, nullable — Unique identifier of the payment card `Payment` this item is linked to. This is only applicable to items where `Type` is `Payment`. - `UnitCost` CurrencyValueOld — Total price of the reservation. - `Currency` string, currency, required - `Value` number, double, nullable - `Net` number, double, nullable - `Tax` number, double, nullable - `TaxRate` number, double, nullable - `OutletBills` OutletBill[], required — The outlet bills of the items. - `Id` string, uuid, required — Unique identifier of the bill. - `EnterpriseId` string, uuid, required — Unique identifier of the Enterprise. - `OutletId` string, uuid, required — Unique identifier of the [Outlet](https://mews-systems.gitbook.io/connector-api/operations/outlets/#outlet) where the bill was issued. - `Number` string, nullable — Number of the bill. - `ClosedUtc` string, date-time, required — Date and time of the bill closure in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the bill in UTC timezone in ISO 8601 format. - `Notes` string, nullable — Additional notes on the bill. - `Cursor` string, uuid, nullable — Unique identifier of the last and hence oldest outlet item 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 outlet items. ## 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/66301d8e85af/schema)