Order items
Get all order items
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 and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/orderItems/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, the operation returns the order items for all enterprises within scope of the Access Token. |
| array of string | optional, max 1000 items | Unique identifiers of the Order items. Required if no other filter is provided. |
| array of string | optional, max 1000 items | Unique identifiers of the service orders (product service orders or reservations). Required if no other filter is provided. |
| array of string | optional, max 1000 items | Unique identifiers of the Services. Required if no other filter is provided. |
| array of string | optional, max 1000 items | Unique identifiers of the Bills to which order item is assigned. Required if no other filter is provided. |
| optional, max length 3 months | Interval in which the Order item was created. Required if no other filter is provided. | |
| optional, max length 3 months | Interval in which the Order item was updated. Required if no other filter is provided. | |
| optional, max length 3 months | Interval in which the Order item was consumed. Required if no other filter is provided. | |
| optional, max length 3 months | Interval in which the Order item was canceled. Required if no other filter is provided. | |
| optional, max length 3 months | Interval in which the Order item was closed. Required if no other filter is provided. | |
| string | optional | ISO-4217 code of the Currency the item costs should be converted to. |
| array of Order item accounting state | optional, max 1000 items | Accounting state of the item. |
| array of Order item type | optional, max 1000 items | Order item type, e.g. whether product order or space order. |
| required | Limitation on the quantity of data returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Order item | required, max 1000 items | Set of requested order items. |
| string | optional | Unique identifier of the last and hence oldest order item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older order items. |
Order item
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the order item. |
| string | required | Unique identifier of the Enterprise. |
| string | optional | Unique identifier of the account (for example Customer) the order item belongs to. |
| optional | A discriminator specifying the type of account, e.g. customer or company. | |
| string | required | Unique identifier of the Service the order item is assigned to. |
| string | required | Unique identifier of the Service order the order item is assigned to. |
| string | optional | Additional notes. |
| string | optional | Unique identifier of the Bill the order item is assigned to. |
| string | optional | Unique identifier of the Accounting category the order item belongs to. |
| string | optional | Name of the order item for billing purposes. |
| string | optional | Identifier of the entity from external system. |
| integer | required | Unit count of item, i.e. the number of sub-items or units, if applicable. |
| required | Unit amount of item, i.e. the amount of each individual sub-item or unit, if applicable. | |
| required | Amount of item; note a negative amount represents a rebate or payment. | |
| required | Order item's original amount. Negative amount represents either rebate or a payment. Contains the earliest known value in conversion chain. | |
| required | Revenue type of the item. | |
| string | required | Unique identifier of the user who created the order item. |
| string | required | Unique identifier of the user who updated the order item. |
| string | required | Creation date and time of the order item created in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the order item in UTC timezone in ISO 8601 format. |
| string | required | Date and time of the item consumption in UTC timezone in ISO 8601 format. |
| string | optional | Cancellation date and time of the order item in UTC timezone in ISO 8601 format. |
| string | optional | Date and time of the item bill closure in UTC timezone in ISO 8601 format. |
| string | optional | Start of the order item in UTC timezone in ISO 8601 format. |
| string | optional | Date and time when the order item was claimed in UTC timezone in ISO 8601 format. |
| required | Accounting state of the order item. | |
| required | Order item type, e.g. whether product order or space order. | |
| required | Options of the order item. | |
| optional | Additional order item data. |
Revenue type
Service
Product
Additional
Order item accounting state
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.
Order item type
CancellationFee
NightRebate
ProductOrderRebate
AdditionalExpenseRebate
Deposit
ExchangeRateDifference
CustomItem
ServiceCharge
CityTax
CityTaxDiscount
SpaceOrder
ProductOrder
Surcharge
TaxCorrection
ResourceUpgradeFee
InvoiceFee
Order item options
Options of the order item.
Property | Type | Contract | Description |
---|---|---|---|
| boolean | required | Order item was canceled with reservation cancellation. |
Order item data
Additional order item data.
Property | Type | Contract | Description |
---|---|---|---|
| required | Discriminator pointing to the fields within this object that contains additional data. | |
| optional | Contains additional data in the case of rebate item. | |
| optional | Contains additional data in the case of product item. |
Order item data discriminator
Rebate
Product
Rebate data
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Product of the original rebated Order item. |
| string | required | Unique identifier of Order item which has been rebated by current item. |
Product data
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Product. |
| string | optional | Unique identifier of the Age Category. |
Last updated