---
title: "Get all order items"
method: POST
path: "/api/connector/v1/orderItems/getAll"
tags: ["Order items"]
---

# Get all order items

`POST /api/connector/v1/orderItems/getAll`

Returns all order items. At least one of the `OrderItemIds`, `ServiceOrderIds`, `ServiceIds`, `BillIds`, `CreatedUtc`, `UpdatedUtc`, `ClosedUtc` filters must be specified in the request. 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

- OrderItemFilterParameters
  - `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.
  - `OrderItemIds` string[], nullable — Unique identifiers of the [Order items](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item). Required if no other filter is provided.
  - `AccountIds` string[], nullable — Unique identifiers of specific `Accounts` to which the order items belong to. Required if no other filter is provided.
  - `ServiceOrderIds` string[], nullable — Unique identifiers of the service orders ([product service orders](https://mews-systems.gitbook.io/connector-api/operations/productserviceorders/#product-service-order) or [reservations](https://mews-systems.gitbook.io/connector-api/operations/reservations/#reservation-ver-2023-06-06)). Required if no other filter is provided.
  - `ServiceIds` string[], nullable — Unique identifiers of the [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service). Required if no other filter is provided.
  - `BillIds` string[], nullable — Unique identifiers of the [Bills](https://mews-systems.gitbook.io/connector-api/operations/bills/#bill) to which order item is assigned. Required if no other filter is provided.
  - `CreatedUtc` 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
  - `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
  - `CanceledUtc` 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](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency) the item costs should be converted to.
  - `AccountingStates` AccountingStateEnum[], nullable — Accounting state of the item.
  - `Types` OrderItemTypeEnum[], nullable — Order item type, e.g. whether product order or space order.

## Response `200`

OK

- OrderItemResult
  - `OrderItems` OrderItem[], required — Set of requested order items.
    - `Id` string, uuid, required — Unique identifier of the order item.
    - `EnterpriseId` string, uuid, required — Unique identifier of the [Enterprise](https://mews-systems.gitbook.io/connector-api/operations/enterprises/#enterprise).
    - `AccountId` string, uuid, nullable — Unique identifier of the account (for example [Customer](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer)) the order item belongs to.
    - `AccountType` 'Company' | 'Customer' — A discriminator specifying the account type, e.g. `Customer` or `Company` Company Customer
    - `ServiceId` string, uuid, required — Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service) the order item is assigned to.
    - `ServiceOrderId` string, uuid, required — Unique identifier of the [Service order](https://mews-systems.gitbook.io/connector-api/operations/serviceorders/#service-order) the order item is assigned to.
    - `Notes` string, nullable — Additional notes.
    - `BillId` string, uuid, nullable — Unique identifier of the [Bill](https://mews-systems.gitbook.io/connector-api/operations/bills/#bill) the order item is assigned to.
    - `AccountingCategoryId` string, uuid, nullable — Unique identifier of the [Accounting category](https://mews-systems.gitbook.io/connector-api/operations/accountingcategories/#accounting-category) the order item belongs to.
    - `BillingName` string, nullable — Name of the order item for billing purposes.
    - `ExternalIdentifier` string, nullable — Identifier of the entity from external system.
    - `UnitCount` integer, required — Unit count of item, i.e. the number of sub-items or units, if applicable.
    - `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.
    - `Amount` 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.
    - `OriginalAmount` 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.
    - `RevenueType` 'Service' | 'Product' | 'Additional', required — Revenue type. Service Product Additional
    - `CreatorProfileId` string, uuid, required — Unique identifier of the user who created the order item.
    - `UpdaterProfileId` string, uuid, required — Unique identifier of the user who updated the order item.
    - `CreatedUtc` string, date-time, required — Creation date and time of the order item created in UTC timezone in ISO 8601 format.
    - `UpdatedUtc` string, date-time, required — Last update date and time of the order 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.
    - `CanceledUtc` string, date-time, nullable — Cancellation date and time of the order item in UTC timezone in ISO 8601 format.
    - `ClosedUtc` string, date-time, nullable — Date and time of the item bill closure in UTC timezone in ISO 8601 format.
    - `StartUtc` string, date-time, nullable — Start of the order item in UTC timezone in ISO 8601 format.
    - `ClaimedUtc` string, date-time, nullable — Date and time when the order item was claimed in UTC timezone in ISO 8601 format.
    - `AccountingState` 'Open' | 'Closed' | 'Inactive' | 'Canceled', required — Open (Order items which carry a non-zero value, are open, and have not been closed on a bill or invoice.) Closed (Order items which carry a non-zero value and have been closed on a bill or invoice.) Inactive (Order items which are either of zero value and have not been canceled, if the state of the payment item is Pending or Failed, or items of optional reservations. Until the reservation is confirmed, all its accounting items are Inactive.) Canceled (Order items which have been canceled, regardless of whether the item is of zero value.)
    - `Type` 'CancellationFee' | 'NightRebate' | 'ProductOrderRebate' | 'AdditionalExpenseRebate' | 'Deposit' | 'ExchangeRateDifference' | 'CustomItem' | 'ServiceCharge' | 'CityTax' | 'CityTaxDiscount' | 'SpaceOrder' | 'ProductOrder' | 'Surcharge' | 'TaxCorrection' | 'ResourceUpgradeFee' | 'InvoiceFee' | 'MulticurrencyFee' | 'AllowanceDiscount' | 'AllowanceBreakage' | 'AllowanceContraBreakage', required — CancellationFee NightRebate ProductOrderRebate AdditionalExpenseRebate Deposit ExchangeRateDifference CustomItem ServiceCharge CityTax CityTaxDiscount SpaceOrder ProductOrder Surcharge TaxCorrection ResourceUpgradeFee InvoiceFee MulticurrencyFee AllowanceDiscount AllowanceBreakage AllowanceContraBreakage
    - `Options` OrderItemOptions, required — Options of the order item.
      - `CanceledWithReservation` boolean, required — Order item was canceled with reservation cancellation.
    - `Data` OrderItemData — Additional order item data.
      - `Discriminator` 'Rebate' | 'Product' | 'AllowanceDiscount' | 'AllowanceProfits' — Rebate (Rebate.) Product (Product.) AllowanceDiscount (Allowance discount.) AllowanceProfits (Allowance profits.)
      - `Rebate` OrderItemRebateData
        - `ProductId` string, uuid, required — Unique identifier of the [Product](https://mews-systems.gitbook.io/connector-api/operations/products/#product) of the original rebated [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item).
        - `RebatedItemId` string, uuid, required — Unique identifier of [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) which has been rebated by current item.
      - `Product` OrderItemProductData
        - `ProductId` string, uuid, required — Unique identifier of the [Product](https://mews-systems.gitbook.io/connector-api/operations/products/#product).
        - `AgeCategoryId` string, uuid, nullable — Unique identifier of the [Age Category](https://mews-systems.gitbook.io/connector-api/operations/agecategories/#age-category).
        - `ProductType` 'Product' | 'Allowance' — Product Allowance
      - `AllowanceDiscount` OrderItemAllowanceDiscountData
        - `DiscountedOrderItemId` string, uuid, required — Unique identifier of [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) which has been discounted by current item.
        - `AllowanceProductOrderItemId` string, uuid, required — Unique identifier of the allowance product [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) which credit has been consumed by current item.
      - `AllowanceProfits` OrderItemAllowanceProfitsData
        - `AllowanceProductOrderItemId` string, uuid, required — Unique identifier of the allowance product [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) which credit has been consumed by current item.
        - `AllowanceProfitType` 'AllowanceBreakage' | 'AllowanceContraBreakage' | 'AllowanceLoss' | 'AllowanceContraLoss', required — AllowanceBreakage (Profit of the allowance product.) AllowanceContraBreakage (Accounting balance for profit of the allowance product.) AllowanceLoss (Loss of the allowance product.) AllowanceContraLoss (Accounting balance for loss of the allowance product.)
    - `TaxExemptionReason` 'Unknown' | 'IT_N1' | 'IT_N2_1' | 'IT_N2_2' | 'IT_N3_4' | 'IT_N3_5' | 'IT_N4' | 'IT_N5' | 'PL_ZW' | 'PL_NP' | 'DE_NATO' | 'FR_261_7' | 'FR_262_00_BIS' | 'FR_293_B' — Unknown (Unknown tax exemption reason) IT_N1 (N1 - Escluse ex art.15) IT_N2_1 (N2.1 - Non soggette ad IVA ai sensi degli artt. da 7 a 7-septies del d.P.R. n. 633/72) IT_N2_2 (N2.2 - Non soggette – altri casi) IT_N3_4 (N3.4 - Non imponibili – operazioni assimilate alle cessioni all’esportazione) IT_N3_5 (N3.5 - Non imponibili – a seguito di dichiarazioni d’intento) IT_N4 (N4 - Esenti) IT_N5 (N5 - Regime del margine / IVA non esposta in fattura) PL_ZW (ZW - Zwolniony) PL_NP (NP - Nie podlega) DE_NATO (NATO-ZAbk - Umsatzsteuerbefreiung gemäß Artikel 67(3) NATO-Zusatzabkommen) FR_261_7 (Exonération de TVA, article 261, 7 du CGI) FR_262_00_BIS (Exonération de TVA, article 262-00 bis du CGI) FR_293_B (TVA non applicable, article 293 B du CGI)
    - `TaxExemptionLegalReference` string, nullable — Legal reference that states why this order item is exempt from tax.
  - `Cursor` string, uuid, nullable — Unique identifier of the last and hence oldest order 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 order 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).

## Changes

- **2026-07-31** `349059cceec7` — 3 warning
  - added the new `FR_261_7` enum value to the `OrderItems/items/TaxExemptionReason/allOf[subschema #1: Tax exemption reason type]/` response property for the response status `200`
  - added the new `FR_262_00_BIS` enum value to the `OrderItems/items/TaxExemptionReason/allOf[subschema #1: Tax exemption reason type]/` response property for the response status `200`
  - added the new `FR_293_B` enum value to the `OrderItems/items/TaxExemptionReason/allOf[subschema #1: Tax exemption reason type]/` response property for the response status `200`

[Change history](https://skmtc.dev/mews/apis/connector-api/changes/api/connector/v1/orderItems/getAll/post.md)

---

[API](https://skmtc.dev/mews/apis/connector-api.md) · [All operations](https://skmtc.dev/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mews/connector-api/revisions/b5dc3b2c1e7d/schema)