Accounting items
Get all accounting items
Deprecated!This operation is deprecated, please use Get all payments and Get all order items instead.
Returns all accounting items of the enterprise that were consumed (posted) or will be consumed within the specified interval. If the Currency
is specified, costs of the items are converted to that currency. Accounting items are split into Order items (consumed items such as nights or products) and Payment items (such as cash, credit card payments or invoices).
Request
[PlatformAddress]/api/connector/v1/accountingItems/getAll
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"ConsumedUtc": {
"StartUtc": "2020-01-05T00:00:00Z",
"EndUtc": "2020-01-10T00:00:00Z"
},
"ClosedUtc": {
"StartUtc": "2020-01-05T00:00:00Z",
"EndUtc": "2020-01-10T00:00:00Z"
},
"UpdatedUtc": {
"StartUtc": "2020-01-05T00:00:00Z",
"EndUtc": "2020-01-10T00:00:00Z"
},
"ItemIds": [
"cb643cb7-8b6e-48a6-b67e-ad4c0041f550",
"44ca12b8-f009-455e-be91-ad4c013fcbc5"
],
"Extent": {
"OrderItems": true,
"PaymentItems": true,
"CreditCardTransactions": false
},
"States": [
"Open"
]
}
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.
ConsumedUtc
optional, max length 3 months
Interval in which the accounting item was consumed. Required if no other filter is provided.
ClosedUtc
optional, max length 3 months
Interval in which the accounting item was closed. Required if no other filter is provided.
UpdatedUtc
optional, max length 3 months
Interval in which the accounting item was updated. Required if no other filter is provided.
ItemIds
array of string
optional, max 1000 items
Unique identifiers of the Accounting items. Required if no other filter is provided.
RebatedItemIds
array of string
optional, max 1000 items
Unique identifiers of the Accounting items we are finding rebates for. Required if no other filter is provided.
Extent
required
Extent of data to be returned. E.g. it is possible to specify that together with the accounting items, credit card transactions should be also returned.
States
array of string Accounting item state
optional
States the accounting items should be in. If not specified, accounting items in Open
or Closed
states are returned.
Accounting item extent
OrderItems
bool
required
Whether the response should contain Order items (consumed items such as nights or products).
PaymentItems
bool
required
Whether the response should contain Payment items (such as cash, credit card payments or invoices).
CreditCardTransactions
bool
required
Whether the response should contain Credit card transactions of the payment items.
Accounting item state
Open
- Accounting items which carry a non-zero value, are open, and have not been closed on a bill or invoice.Closed
- Accounting items which carry a non-zero value and have been closed on a bill or invoice.Inactive
- Accounting 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
- Accounting items which have been canceled, regardless of whether the item is of zero value
Response
{
"OrderItems": [
{
"Id": "cb643cb7-8b6e-48a6-b67e-ad4c0041f550",
"AccountId": "77673c9d-0e31-4e90-9228-ad4b00a9fcdc",
"OrderId": "1103b431-998a-4b78-84de-ad4b00a9fd99",
"BillId": null,
"AccountingCategoryId": "d250149e-a29d-4c70-b607-a1759faf7320",
"UnitCount": 15,
"UnitAmount": {
"Currency": "EUR",
"NetValue": 8.40,
"GrossValue": 10.00,
"TaxValues": [
{
"Code": "DE-2020-1-I",
"Value": 1.60
}
],
"Breakdown": {
"Items": [
{
"TaxRateCode": "DE-2020-1-I",
"NetValue": 8.40,
"TaxValue": 1.60
}
]
}
},
"Amount": {
"Currency": "EUR",
"NetValue": 126.05,
"GrossValue": 150.00,
"TaxValues": [
{
"Code": "DE-2020-1-I",
"Value": 23.95
}
],
"Breakdown": {
"Items": [
{
"TaxRateCode": "DE-2020-1-I",
"NetValue": 126.05,
"TaxValue": 23.95
}
]
}
},
"OriginalAmount": {
"Currency": "EUR",
"NetValue": 126.05,
"GrossValue": 150.00,
"TaxValues": [
{
"Code": "DE-2020-1-I",
"Value": 23.95
}
],
"Breakdown": {
"Items": [
{
"TaxRateCode": "DE-2020-1-I",
"NetValue": 126.05,
"TaxValue": 23.95
}
]
}
},
"RevenueType": "Additional",
"ConsumedUtc": "2021-06-19T04:00:08Z",
"ClosedUtc": null,
"AccountingState": "Open",
"Data": {
"Discriminator": "CancellationFee",
"Value": null
}
}
],
"PaymentItems": [
{
"Id": "44ca12b8-f009-455e-be91-ad4c013fcbc5",
"AccountId": "5da55e5c-18e5-48d8-9a0e-ac0600704c5c",
"BillId": null,
"AccountingCategoryId": "b89345c1-2814-4750-808d-aa7900ee464a",
"Amount": {
"Currency": "GBP",
"NetValue": 850.00,
"GrossValue": 850.00,
"TaxValues": [],
"Breakdown": {
"Items": [
{
"TaxRateCode": null,
"NetValue": 850.00,
"TaxValue": 0.0
}
]
}
},
"OriginalAmount": {
"Currency": "GBP",
"NetValue": 850.00,
"GrossValue": 850.00,
"TaxValues": [],
"Breakdown": {
"Items": [
{
"TaxRateCode": null,
"NetValue": 850.00,
"TaxValue": 0.0
}
]
}
},
"Notes": "NORMAL0140",
"SettlementId": "po_1Lun9w4JpyDC38oQJQz7hAcx",
"ConsumedUtc": "2021-06-19T19:24:20Z",
"ClosedUtc": null,
"AccountingState": "Open",
"State": "Charged",
"Data": {
"Discriminator": "Invoice",
"Value": {
"InvoiceId": "3c818013-d9de-47e9-bb2c-ad4c013f9ad3"
}
}
}
],
"CreditCardTransactions": null
}
PaymentItems
array of Payment item
optional
The payment items (such as cash, credit card payments or invoices).
Order item
Id
string
required
Unique identifier of the item.
OrderId
string
required
Unique identifier of the order (or Reservation which is a special type of order) the item belongs to.
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.
OriginalAmount
required
Amount of item; note a negative amount represents a rebate or payment. Contains the earliest known value in conversion chain.
ConsumedUtc
string
required
Date and time of the item consumption 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.
Payment item
Id
string
required
Unique identifier of the item.
OriginalAmount
required
Amount of item; note a negative amount represents a rebate or payment. Contains the earliest known value in conversion chain.
AmountDefault
required
Item's amount in property's default currency, negative amount represents either rebate or a payment. Deprecated!
Notes
string
optional
Additional notes.
SettlementId
string
optional
Identifier of the settled payment from the external system (ApplePay/GooglePay).
ConsumedUtc
string
required
Date and time of the item consumption 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.
Credit card transaction
SettlementId
string
optional
Identifier of the settlement.
SettledUtc
string
optional
Settlement date and time in UTC timezone in ISO 8601 format.
AdjustedFee
optional
Transaction fee (adjusted) - this is the final confirmed transaction fee, including confirmed bank charges.
Amount Value
For most amounts, precision of values depends on TaxPrecision
of Enterprise or Currency precision. But in some cases, precision can be higher.
Tax value
Code
number
required
Code corresponding to tax type.
Value
number
required
Amount of tax applied.
Revenue type
Service
Product
Additional
Order item data
Discriminator
required
Type of the order item (e.g. ProductOrder
).
Value
object
optional
Based on order item discriminator, e.g. Product order item data or null
for types without any additional data.
Order item data discriminator
CancellationFee
- no additional data.Rebate
- Rebate order item data.Deposit
- no additional data.ExchangeRateDifference
- no additional data.CustomItem
- no additional data.Surcharge
- no additional data.SurchargeDiscount
- no additional data.ProductOrder
- Product order item data.Other
- no additional data.
Product order item data
Rebate order item data
Payment item state
Charged
Canceled
Pending
Failed
Verifying
Payment item data
Discriminator
required
Type of the payment item (e.g. CreditCard
).
Value
object
optional
Based on order item discriminator, e.g. Credit card payment item data or null
for types without any additional data.
Payment item data discriminator
CreditCard
- Credit card payment item data.Invoice
- Invoice payment item data.Cash
- no additional data.Unspecified
- no additional data.BadDebts
- no additional data.WireTransfer
- no additional data.ExchangeRateDifference
- no additional data.ExchangeRoundingDifference
- no additional data.BankCharges
- no additional data.Cheque
- no additional data.Other
- no additional data.
Credit card payment item data
Invoice payment item data
Currency value
Value
number
optional
Amount in the currency.
Update accounting items
Updates specified accounting items. You can use this operation to assign an accounting item to a different account or bill. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/accountingItems/update
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"AccountingItemUpdates": [
{
"AccountingItemId": "6c2897de-620a-4f48-af1e-ada8004202bd",
"AccountId": {
"Value": "182a56ee-037d-4da5-b6f8-ada8006e7d5c"
},
"BillId": {
"Value": "9e3791dc-95c7-439a-aa8a-ada8007de0ca"
}
}
]
}
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
Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise.
Accounting item update
AccountId
optional
Unique identifier of the account (for example Customer) the item is assigned to (or null
if the assigned account should not be updated). If defined, valid account identifier must be provided.
BillId
required
Unique identifier of the Bill the items is assigned to. It's possible to assign item to bill belonging to another account, in that case both AccountId
and BillId
must be provided.
Response
{
"OrderItems": [
{
"Id": "6c2897de-620a-4f48-af1e-ada8004202bd",
"AccountId": "182a56ee-037d-4da5-b6f8-ada8006e7d5c",
"OrderId": "f9090129-fb49-46d2-9dc5-ad9d015d43b9",
"BillId": "9e3791dc-95c7-439a-aa8a-ada8007de0ca",
"AccountingCategoryId": "d250149e-a29d-4c70-b607-a1759faf7320",
"Amount": {
"Currency": "GBP",
"NetValue": 95.24,
"GrossValue": 100.00,
"TaxValues": [
{
"Code": "UK-2020-R",
"Value": 4.76
}
],
"Breakdown": {
"Items": [
{
"TaxRateCode": "UK-2020-R",
"NetValue": 95.24,
"TaxValue": 4.76
}
]
}
},
"RevenueType": "Additional",
"ConsumedUtc": "2021-09-19T04:00:20Z",
"ClosedUtc": null,
"AccountingState": "Open",
"Data": {
"Discriminator": "CancellationFee",
"Value": null
}
}
],
"PaymentItems": [],
}
OrderItems
array of Order item
optional
Updated order items (consumed items such as nights or products).
PaymentItems
array of Payment item
optional
Updated payment items (such as cash, credit card payments or invoices).
Last updated
Was this helpful?