Accounting items
Last updated
Was this helpful?
Last updated
Was this helpful?
Deprecated!This operation is , please use and 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 (consumed items such as nights or products) and (such as cash, credit card payments or invoices).
[PlatformAddress]/api/connector/v1/accountingItems/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.
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.
Currency
string
optional
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
optional
States the accounting items should be in. If not specified, accounting items in Open
or Closed
states are returned.
OrderItems
bool
required
PaymentItems
bool
required
CreditCardTransactions
bool
required
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
OrderItems
optional
The order items (consumed items such as nights or products).
PaymentItems
optional
The payment items (such as cash, credit card payments or invoices).
CreditCardTransactions
optional
The credit card payment transactions.
Id
string
required
Unique identifier of the item.
AccountId
string
required
OrderId
string
required
BillId
string
optional
AccountingCategoryId
string
optional
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
Amount of item; note a negative amount represents a rebate or payment. Contains the earliest known value in conversion chain.
RevenueType
required
Revenue type of the item.
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.
AccountingState
required
Accounting state of the item.
Data
required
Additional data specific to particular order item.
Id
string
required
Unique identifier of the item.
AccountId
string
required
BillId
string
optional
AccountingCategoryId
string
optional
Amount
required
Item's amount, negative amount represents either rebate or a payment.
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.
AccountingState
required
Accounting state of the item.
State
required
Payment state of the item.
Data
required
Additional data specific to particular payment item.
PaymentId
string
required
SettlementId
string
optional
Identifier of the settlement.
SettledUtc
string
optional
Settlement date and time in UTC timezone in ISO 8601 format.
Fee
optional
Transaction fee - this includes an estimate of bank charges.
AdjustedFee
optional
Transaction fee (adjusted) - this is the final confirmed transaction fee, including confirmed bank charges.
ChargedAmount
required
Charged amount of the transaction.
SettledAmount
optional
Settled amount of the transaction.
Currency
string
required
NetValue
number
optional
Net value in case the item is taxed.
GrossValue
number
optional
Gross value including all taxes.
TaxValues
optional
The tax values applied.
Code
number
required
Code corresponding to tax type.
Value
number
required
Amount of tax applied.
Service
Product
Additional
Discriminator
required
Type of the order item (e.g. ProductOrder
).
Value
object
optional
CancellationFee
- no additional data.
Deposit
- no additional data.
ExchangeRateDifference
- no additional data.
CustomItem
- no additional data.
Surcharge
- no additional data.
SurchargeDiscount
- no additional data.
Other
- no additional data.
ProductId
string
required
AgeCategoryId
string
optional
RebatedItemId
string
required
Charged
Canceled
Pending
Failed
Verifying
Discriminator
required
Type of the payment item (e.g. CreditCard
).
Value
object
optional
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.
CreditCardId
string
required
InvoiceId
string
required
Currency
string
required
Value
number
optional
Amount in the currency.
[PlatformAddress]/api/connector/v1/accountingItems/update
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
AccountingItemUpdates
required
List of requested updates.
AccountingItemId
string
required
AccountId
optional
BillId
required
OrderItems
optional
Updated order items (consumed items such as nights or products).
PaymentItems
optional
Updated payment items (such as cash, credit card payments or invoices).
ISO-4217 code of the the item costs should be converted to.
array of string
Whether the response should contain s (consumed items such as nights or products).
Whether the response should contain (such as cash, credit card payments or invoices).
Whether the response should contain of the payment items.
array of
array of
array of
Unique identifier of the account (for example ) the item belongs to.
Unique identifier of the order (or which is a special type of order) the item belongs to.
Unique identifier of the the item is assigned to.
Unique identifier of the the item belongs to.
string
string
object
Unique identifier of the account (for example ) the item belongs to.
Unique identifier of the the item is assigned to.
Unique identifier of the the item belongs to.
string
string
object
Unique identifier of the .
ISO-4217 code of the .
array of
For most amounts, precision of values depends on TaxPrecision
of or precision. But in some cases, precision can be higher.
string
Based on order item discriminator, e.g. or null
for types without any additional data.
Rebate
- .
ProductOrder
- .
Unique identifier of the .
Unique identifier of the .
Unique identifier of which has been rebated by current item.
string
Based on order item discriminator, e.g. or null
for types without any additional data.
CreditCard
- .
Invoice
- .
Unique identifier of the .
Unique identifier of the invoice .
ISO-4217 code of the .
Updates specified accounting items. You can use this operation to assign an accounting item to a different account or bill. Note this operation supports .
Unique identifier of the . Required when using a , ignored otherwise.
array of
Unique identifier of the .
Unique identifier of the account (for example ) the item is assigned to (or null
if the assigned account should not be updated). If defined, valid account identifier must be provided.
Unique identifier of the 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.
array of
array of