Outlet items
Get all outlet items
Returns all outlet 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. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/outletItems/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.
Ids
array of string
optional, max 1000 items
Unique identifiers of the Outlet items. If not specified, the operation returns data for all Outlet items within scope of the Access Token.
ConsumedUtc
optional, max length 3 months
Interval in which the Outlet item was consumed. Required if no other filter is provided.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
Response
Cursor
string
optional
Unique identifier of the last and hence oldest outlet item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older outlet items.
Outlet item
Id
string
required
Unique identifier of the item.
Name
string
optional
Name of the item.
UnitCount
integer
required
Unit count of the item.
CreatedUtc
string
required
Date and time of the item creation in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the 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.
ExternalIdentifier
string
optional
An identifier of this item from another system.
Notes
string
optional
Additional notes.
PaymentCardPaymentId
string
optional
Unique identifier of the payment card Payment
this item is linked to. This is only applicable to items where Type
is Payment
.
UnitCost
optional
Total price of the reservation. Deprecated! Use UnitAmount
instead.
Outlet item type
Revenue
NonRevenue
Payment
Outlet bill
Id
string
required
Unique identifier of the bill.
EnterpriseId
string
required
Unique identifier of the Enterprise.
Number
string
optional
Number of the bill.
ClosedUtc
string
required
Date and time of the bill closure in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the bill in UTC timezone in ISO 8601 format.
Notes
string
optional
Additional notes on the bill.
Last updated