Order items
Last updated
Was this helpful?
Last updated
Was this helpful?
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 and supports .
[PlatformAddress]/api/connector/v1/orderItems/getAll
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
array of string
optional, max 1000 items
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
OrderItemIds
array of string
optional, max 1000 items
AccountIds
array of string
optional, max 100 items
Unique identifiers of specific Accounts
to which the order items belong to. Required if no other filter is provided.
ServiceOrderIds
array of string
optional, max 1000 items
ServiceIds
array of string
optional, max 1000 items
BillIds
array of string
optional, max 1000 items
CreatedUtc
optional, max length 3 months
UpdatedUtc
optional, max length 3 months
ConsumedUtc
optional, max length 3 months
CanceledUtc
optional, max length 3 months
ClosedUtc
optional, max length 3 months
Currency
string
optional
AccountingStates
optional, max 1000 items
Accounting state of the item.
Types
optional, max 1000 items
Order item type, e.g. whether product order or space order.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
OrderItems
required, max 1000 items
Set of requested order items.
Cursor
string
optional
Id
string
required
Unique identifier of the order item.
EnterpriseId
string
required
AccountId
string
optional
AccountType
optional
ServiceId
string
required
ServiceOrderId
string
required
Notes
string
optional
Additional notes.
BillId
string
optional
AccountingCategoryId
string
optional
BillingName
string
optional
Name of the order item for billing purposes.
ExternalIdentifier
string
optional
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
required
Unit amount of item, i.e. the amount of each individual sub-item or unit, if applicable.
Amount
required
Amount of item; note a negative amount represents a rebate or payment.
OriginalAmount
required
Order item's original amount. Negative amount represents either rebate or a payment. Contains the earliest known value in conversion chain.
RevenueType
required
Revenue type of the item.
CreatorProfileId
string
required
Unique identifier of the user who created the order item.
UpdaterProfileId
string
required
Unique identifier of the user who updated the order item.
CreatedUtc
string
required
Creation date and time of the order item created in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the order item in UTC timezone in ISO 8601 format.
ConsumedUtc
string
required
Date and time of the item consumption in UTC timezone in ISO 8601 format.
CanceledUtc
string
optional
Cancellation date and time of the order item in UTC timezone in ISO 8601 format.
ClosedUtc
string
optional
Date and time of the item bill closure in UTC timezone in ISO 8601 format.
StartUtc
string
optional
Start of the order item in UTC timezone in ISO 8601 format.
ClaimedUtc
string
optional
Date and time when the order item was claimed in UTC timezone in ISO 8601 format.
AccountingState
required
Accounting state of the order item.
Type
required
Order item type, e.g. whether product order or space order.
Options
required
Options of the order item.
Data
optional
Additional order item data.
TaxExemptionReason
optional
Specifies the reason an order item is exempt from tax.
TaxExemptionLegalReference
string
optional
Legal reference that states why this order item is exempt from tax.
Service
Product
Additional
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.
CancellationFee
NightRebate
ProductOrderRebate
AdditionalExpenseRebate
Deposit
ExchangeRateDifference
CustomItem
ServiceCharge
CityTax
CityTaxDiscount
SpaceOrder
ProductOrder
Surcharge
TaxCorrection
ResourceUpgradeFee
InvoiceFee
MulticurrencyFee
AllowanceDiscount
AllowanceBreakage
AllowanceContraBreakage
Options of the order item.
CanceledWithReservation
boolean
required
Order item was canceled with reservation cancellation.
Additional order item data.
Discriminator
required
Discriminator pointing to the fields within this object that contains additional data.
Rebate
optional
Contains additional data in the case of rebate item.
Product
optional
Contains additional data in the case of product item.
Rebate
Product
ProductId
string
required
RebatedItemId
string
required
ProductId
string
required
AgeCategoryId
string
optional
IT_N1
- N1 - Escluse ex art.15
IT_N2_2
- N2.2 - Non soggette – altri casi
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
Restricted!This operation is currently in beta-test and as such it is subject to change.
[PlatformAddress]/api/connector/v1/orderItems/cancel
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.
EnterpriseId
string
optional
OrderItemIds
array of string
required, max 10 items
Unique identifiers of the OrderItems
to cancel.
Unique identifiers of the . Required if no other filter is provided.
Unique identifiers of the service orders ( or ). Required if no other filter is provided.
Unique identifiers of the . Required if no other filter is provided.
Unique identifiers of the to which order item is assigned. Required if no other filter is provided.
Interval in which the was created. Required if no other filter is provided.
Interval in which the was updated. Required if no other filter is provided.
Interval in which the was consumed. Required if no other filter is provided.
Interval in which the was canceled. Required if no other filter is provided.
Interval in which the was closed. Required if no other filter is provided.
ISO-4217 code of the the item costs should be converted to.
array of
array of
array of
Unique identifier of the last and hence oldest order item returned. This can be used in in a subsequent request to fetch the next batch of older order items.
Unique identifier of the .
Unique identifier of the account (for example ) the order item belongs to.
A discriminator specifying the , e.g. customer or company.
Unique identifier of the the order item is assigned to.
Unique identifier of the the order item is assigned to.
Unique identifier of the the order item is assigned to.
Unique identifier of the the order item belongs to.
Unique identifier of the of the original rebated .
Unique identifier of which has been rebated by current item.
Unique identifier of the .
Unique identifier of the .
Cancels all order items with specified identifiers. Note this operation supports .
Unique identifier of the enterprise. Required when using , ignored otherwise.