v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
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.

post/api/connector/v1/orderItems/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdsstring[] nullable

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

OrderItemIdsstring[] nullable

Unique identifiers of the Order items. Required if no other filter is provided.

AccountIdsstring[] nullable

Unique identifiers of specific Accounts to which the order items belong to. Required if no other filter is provided.

ServiceOrderIdsstring[] nullable

Unique identifiers of the service orders (product service orders or reservations). Required if no other filter is provided.

ServiceIdsstring[] nullable

Unique identifiers of the Services. Required if no other filter is provided.

BillIdsstring[] nullable

Unique identifiers of the Bills to which order item is assigned. Required if no other filter is provided.

Currencystring currency nullable

ISO-4217 code of the Currency the item costs should be converted to.

AccountingStatesAccountingStateEnum[] nullable

Accounting state of the item.

TypesOrderItemTypeEnum[] nullable

Order item type, e.g. whether product order or space order.

Response

OK

Cursorstring uuid nullable

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.