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

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "EnterpriseIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "4d0201db-36f5-428b-8d11-4f0a65e960cc"
  ],
  "OrderItemIds": [
    "3e982ab5-6245-4c39-80af-1118d40e7494",
    "bd11dc4a-8f9e-442b-bb1e-f5361b31dfa2"
  ],
  "ServiceOrderIds": [
    "ac5ef5eb-c5b2-4083-879f-83f04a5ebda5",
    "5d603823-b40a-43a4-8244-d5d2b515deb5"
  ],
  "ServiceIds": [
    "294c7859-63ba-46ad-a8bf-34fad2019383",
    "05089c0c-5d55-4756-827b-c4bcee1edf00"
  ],
  "BillIds": [
    "d27ffe99-ff92-4afb-ac03-9268f24f0556",
    "297de6f8-bd67-4ebd-98b6-ecc1cd8f920c"
  ],
  "CreatedUtc": {
    "StartUtc": "2023-03-01T00:00:00Z",
    "EndUtc": "2023-03-31T00:00:00Z"
  },
  "UpdatedUtc": {
    "StartUtc": "2023-03-01T00:00:00Z",
    "EndUtc": "2023-03-31T00:00:00Z"
  },
  "ConsumedUtc": {
    "StartUtc": "2023-03-01T00:00:00Z",
    "EndUtc": "2023-03-31T00:00:00Z"
  },
  "CanceledUtc": {
    "StartUtc": "2023-03-01T00:00:00Z",
    "EndUtc": "2023-03-31T00:00:00Z"
  },
  "ClosedUtc": {
    "StartUtc": "2023-03-01T00:00:00Z",
    "EndUtc": "2023-03-31T00:00:00Z"
  },
  "AccountingStates": [
    "Open",
    "Closed"
  ],
  "Types": [
    "CityTax",
    "SpaceOrder"
  ],
  "Currency": "EUR",
  "Limitation": {
    "Count": 10,
    "Cursor": null
  }
}
Property
Type
Contract
Description

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

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.

Response

{
  "OrderItems": [
    {
      "Id": "53896156-f25b-4949-b55b-afd3007b1146",
      "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "AccountId": "c173bb22-6ff8-4ffd-875f-afb900c92865",
      "AccountType": "Customer",
      "Notes": "Additional note",
      "ServiceId": "294c7859-63ba-46ad-a8bf-34fad2019383",
      "ServiceOrderId": "ac5ef5eb-c5b2-4083-879f-83f04a5ebda5",
      "BillId": "d27ffe99-ff92-4afb-ac03-9268f24f0556",
      "AccountingCategoryId": "c0610937-0165-4091-a79c-44eb34173daf",
      "UnitCount": 1,
      "UnitAmount": {
        "Currency": "EUR",
        "NetValue": 5,
        "GrossValue": 5,
        "TaxValues": [
          {
            "Code": "DE-2020-1-Z",
            "Value": 0
          }
        ],
        "Breakdown": {
          "Items": [
            {
              "TaxRateCode": "DE-2020-1-Z",
              "NetValue": 5,
              "TaxValue": 0
            }
          ]
        }
      },
      "Amount": {
        "Currency": "EUR",
        "NetValue": 5,
        "GrossValue": 5,
        "TaxValues": [
          {
            "Code": "DE-2020-1-Z",
            "Value": 0
          }
        ],
        "Breakdown": {
          "Items": [
            {
              "TaxRateCode": "DE-2020-1-Z",
              "NetValue": 5,
              "TaxValue": 0
            }
          ]
        }
      },
      "OriginalAmount": {
        "Currency": "EUR",
        "NetValue": 5,
        "GrossValue": 5,
        "TaxValues": [
          {
            "Code": "DE-2020-1-Z",
            "Value": 0
          }
        ],
        "Breakdown": {
          "Items": [
            {
              "TaxRateCode": "DE-2020-1-Z",
              "NetValue": 5,
              "TaxValue": 0
            }
          ]
        }
      },
      "RevenueType": "Additional",
      "CreatorProfileId": "3cd637ef-4728-47f9-8fb1-afb900c9cdcf",
      "UpdaterProfileId": "3cd637ef-4728-47f9-8fb1-afb900c9cdcf",
      "CreatedUtc": "2023-03-28T07:28:04Z",
      "UpdatedUtc": "2023-03-28T07:28:04Z",
      "ConsumedUtc": "2023-03-31T00:00:00Z",
      "CanceledUtc": null,
      "ClosedUtc": null,
      "StartUtc": "2023-03-30T22:00:00Z",
      "AccountingState": "Open",
      "Type": "CityTax",
      "Options": {
        "CanceledWithReservation": false
      },
      "Data": null
    },
    {
      "Id": "bd11dc4a-8f9e-442b-bb1e-f5361b31dfa2",
      "EnterpriseId": "4d0201db-36f5-428b-8d11-4f0a65e960cc",
      "AccountId": "c173bb22-6ff8-4ffd-875f-afb900c92865",
      "AccountType": "Company",
      "Notes": "Additional note",
      "ServiceId": "05089c0c-5d55-4756-827b-c4bcee1edf00",
      "ServiceOrderId": "dd01a673-ee6e-4f10-9c93-afcd00759ddd",
      "BillId": "297de6f8-bd67-4ebd-98b6-ecc1cd8f920c",
      "AccountingCategoryId": "c5819fe7-d67c-4c24-b02e-6ce84a1d3b1d",
      "UnitCount": 1,
      "UnitAmount": {
        "Currency": "EUR",
        "NetValue": 93.46,
        "GrossValue": 100,
        "TaxValues": [
          {
            "Code": "DE-2020-1-L",
            "Value": 6.54
          }
        ],
        "Breakdown": {
          "Items": [
            {
              "TaxRateCode": "DE-2020-1-L",
              "NetValue": 93.46,
              "TaxValue": 6.54
            }
          ]
        }
      },
      "Amount": {
        "Currency": "EUR",
        "NetValue": 93.46,
        "GrossValue": 100,
        "TaxValues": [
          {
            "Code": "DE-2020-1-L",
            "Value": 6.54
          }
        ],
        "Breakdown": {
          "Items": [
            {
              "TaxRateCode": "DE-2020-1-L",
              "NetValue": 93.46,
              "TaxValue": 6.54
            }
          ]
        }
      },
      "OriginalAmount": {
        "Currency": "EUR",
        "NetValue": 93.46,
        "GrossValue": 100,
        "TaxValues": [
          {
            "Code": "DE-2020-1-L",
            "Value": 6.54
          }
        ],
        "Breakdown": {
          "Items": [
            {
              "TaxRateCode": "DE-2020-1-L",
              "NetValue": 93.46,
              "TaxValue": 6.54
            }
          ]
        }
      },
      "RevenueType": "Service",
      "CreatorProfileId": "3cd637ef-4728-47f9-8fb1-afb900c9cdcf",
      "UpdaterProfileId": "3cd637ef-4728-47f9-8fb1-afb900c9cdcf",
      "CreatedUtc": "2023-03-28T07:28:01Z",
      "UpdatedUtc": "2023-03-28T07:28:04Z",
      "ConsumedUtc": "2023-03-31T00:00:00Z",
      "CanceledUtc": null,
      "ClosedUtc": null,
      "StartUtc": "2023-03-30T22:00:00Z",
      "AccountingState": "Open",
      "Type": "SpaceOrder",
      "Options": {
        "CanceledWithReservation": false
      },
      "Data": {
        "Discriminator": "Product",
        "Rebate": null,
        "Product": {
          "ProductId": "8c8dbd02-f2e2-4845-b964-afb900c8f919",
          "AgeCategoryId": null
        }
      }
    }
  ],
  "Cursor": "d98c9611-0006-4691-a835-af2e00b170c4"
}
Property
Type
Contract
Description

OrderItems

required, max 1000 items

Set of requested order items.

Cursor

string

optional

Order item

Property
Type
Contract
Description

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.

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

  • MulticurrencyFee

Order item options

Options of the order item.

Property
Type
Contract
Description

CanceledWithReservation

boolean

required

Order item was canceled with reservation cancellation.

Order item data

Additional order item data.

Property
Type
Contract
Description

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.

Order item data discriminator

  • Rebate

  • Product

Rebate data

Property
Type
Contract
Description

ProductId

string

required

RebatedItemId

string

required

Product data

Property
Type
Contract
Description

ProductId

string

required

AgeCategoryId

string

optional

Cancel order items

Cancels all order items with specified identifiers. Note this operation supports Portfolio Access Tokens.

Request

[PlatformAddress]/api/connector/v1/orderItems/cancel

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "OrderItemIds": [
    "f5c6b7a8-9d4f-4e2a-8a3b-2f3b8b9e6a1f",
    "a6b7c8d9-0e1f-4d2a-9b3c-5d6e7f8a9b0c"
  ],
  "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Property
Type
Contract
Description

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.

Response

{}

Last updated