Skip to content

Get all reservation items

Deprecated
POST
/api/connector/v1/reservations/getAllItems

Use orderItems/getAll.

ReservationItemParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
ReservationIds
required

Unique identifiers of the reservation.

Array<string>
>= 1 items <= 1000 items
Currency

ISO-4217 code of the Currency the item costs should be converted to.

string format: currency
nullable
AccountingStates

States the items should be in. If not specified, items in Open or Closed states are returned.

Array<string>
nullable
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"ReservationIds": [
"e6ea708c-2a2a-412f-a152-b6c76ffad49b"
],
"Currency": "EUR",
"AccountingStates": [
"Closed"
]
}

OK

ReservationItemResult
object
Reservations
required

The reservations with their items.

Array<object>
Reservation items
object
ReservationId

Unique identifier of the reservation.

string format: uuid
Items
required

Accounting items associated with the reservation.

Array<object>
Accounting item
object
Id
string format: uuid
AccountId
string format: uuid
CustomerId
string format: uuid
nullable
OrderId
string format: uuid
nullable
ServiceId
string format: uuid
nullable
ProductId
string format: uuid
nullable
BillId
string format: uuid
nullable
InvoiceId
string format: uuid
nullable
AccountingCategoryId
string format: uuid
nullable
CreditCardId
string format: uuid
nullable
Type
string
nullable
SubType
string
nullable
Name
string
nullable
Notes
string
nullable
ConsumptionUtc
string
nullable
ClosedUtc
string
nullable
State
string
nullable
SubState
string
nullable
Amount
Extended amount
object
Currency
required

ISO-4217 code of the Currency.

string format: currency
>= 1 characters
NetValue
required

Net value without taxes.

number format: double
GrossValue
required

Gross value including all taxes.

number format: double
TaxValues
required

The tax values applied.

Array<object>
Tax value
object
Code

Code corresponding to tax type.

string
nullable
Value
required

Amount of tax applied.

number format: double
Breakdown
required
Tax breakdown

Information about individual tax amounts.

object
Items
required

Tax breakdown items per each tax rate applied.

Array<object>
Tax breakdown item
object
TaxRateCode

Tax rate code for the item. null for untaxed amounts.

string
nullable
NetValue
required

The net value that the tax is calculated from.

number format: double
TaxValue
required

The value of the tax.

number format: double
Value
number format: double
nullable
Net
number format: double
nullable
Tax
number format: double
nullable
TaxRate
number format: double
nullable
TaxExemptionReasonCode

Code of tax exemption reason. Restricted! This property is currently intended for Mews’ internal usage and may be subject to change.

string
nullable
OrderItems
required

Order items associated with the reservation.

Array<object>
Order item
object
Id

Unique identifier of the item.

string format: uuid
AccountId

Unique identifier of the account (for example Customer) the item belongs to.

string format: uuid
nullable
OrderId

Unique identifier of the order (or Reservation which is a special type of order) the item belongs to.

string format: uuid
BillId

Unique identifier of the Bill the item is assigned to.

string format: uuid
nullable
AccountingCategoryId

Unique identifier of the Accounting category the item belongs to.

string format: uuid
nullable
UnitCount

Unit count of item, i.e. the number of sub-items or units, if applicable.

integer format: int32
UnitAmount
Amount
object
Currency
required

ISO-4217 code of the Currency.

string format: currency
>= 1 characters
NetValue
required

Net value without taxes.

number format: double
GrossValue
required

Gross value including all taxes.

number format: double
TaxValues
required

The tax values applied.

Array<object>
Tax value
object
Code

Code corresponding to tax type.

string
nullable
Value
required

Amount of tax applied.

number format: double
Breakdown
required
Tax breakdown

Information about individual tax amounts.

object
Items
required

Tax breakdown items per each tax rate applied.

Array<object>
Tax breakdown item
object
TaxRateCode

Tax rate code for the item. null for untaxed amounts.

string
nullable
NetValue
required

The net value that the tax is calculated from.

number format: double
TaxValue
required

The value of the tax.

number format: double
Amount
Extended amount
object
Currency
required

ISO-4217 code of the Currency.

string format: currency
>= 1 characters
NetValue
required

Net value without taxes.

number format: double
GrossValue
required

Gross value including all taxes.

number format: double
TaxValues
required

The tax values applied.

Array<object>
Tax value
object
Code

Code corresponding to tax type.

string
nullable
Value
required

Amount of tax applied.

number format: double
Breakdown
required
Tax breakdown

Information about individual tax amounts.

object
Items
required

Tax breakdown items per each tax rate applied.

Array<object>
Tax breakdown item
object
TaxRateCode

Tax rate code for the item. null for untaxed amounts.

string
nullable
NetValue
required

The net value that the tax is calculated from.

number format: double
TaxValue
required

The value of the tax.

number format: double
Value
number format: double
nullable
Net
number format: double
nullable
Tax
number format: double
nullable
TaxRate
number format: double
nullable
OriginalAmount
Extended amount
object
Currency
required

ISO-4217 code of the Currency.

string format: currency
>= 1 characters
NetValue
required

Net value without taxes.

number format: double
GrossValue
required

Gross value including all taxes.

number format: double
TaxValues
required

The tax values applied.

Array<object>
Tax value
object
Code

Code corresponding to tax type.

string
nullable
Value
required

Amount of tax applied.

number format: double
Breakdown
required
Tax breakdown

Information about individual tax amounts.

object
Items
required

Tax breakdown items per each tax rate applied.

Array<object>
Tax breakdown item
object
TaxRateCode

Tax rate code for the item. null for untaxed amounts.

string
nullable
NetValue
required

The net value that the tax is calculated from.

number format: double
TaxValue
required

The value of the tax.

number format: double
Value
number format: double
nullable
Net
number format: double
nullable
Tax
number format: double
nullable
TaxRate
number format: double
nullable
RevenueType

Revenue type of the item.

string
nullable
CreatorProfileId
string format: uuid
UpdaterProfileId
string format: uuid
CreatedUtc
string format: date
nullable
UpdatedUtc
string format: date
nullable
ConsumedUtc

Date and time of the item consumption in UTC timezone in ISO 8601 format.

string format: date
nullable
CanceledUtc
string format: date
nullable
ClosedUtc

Date and time of the item bill closure in UTC timezone in ISO 8601 format.

string format: date
nullable
StartUtc
string format: date
nullable
AccountingState

Accounting state of the item.

string
nullable
Data
Data

Additional data specific to particular order item.

object
Discriminator
string
Allowed values: CancellationFee Rebate Deposit ExchangeRateDifference CustomItem Surcharge SurchargeDiscount SpaceOrder ProductOrder Other TaxCorrection ResourceUpgradeFee InvoiceFee
Value
One of:
RebateOrderItemData
object
RebatedItemId
string format: uuid
nullable
Example
{
"Reservations": [
{
"ReservationId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b",
"OrderItems": [
{
"Id": "784a29df-6196-4402-96a0-58695a881239",
"AccountId": "d73a087a-00c7-40cf-9372-314d0296334d",
"OrderId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b",
"BillId": "7fdc2957-bc08-44d3-ba2a-1c1760a84894",
"AccountingCategoryId": "0cf7aa90-736f-43e9-a7dc-787704548d86",
"Amount": {
"Currency": "EUR",
"NetValue": 19.38,
"GrossValue": 23.26,
"TaxValues": [
{
"Code": "UK-S",
"Value": 3.88
}
],
"Breakdown": {
"Items": [
{
"TaxRateCode": "UK-S",
"NetValue": 19.38,
"TaxValue": 3.88
}
]
}
},
"RevenueType": "Service",
"ConsumedUtc": "2016-03-10T13:00:00Z",
"ClosedUtc": "2016-04-06T06:41:44Z",
"AccountingState": "Closed",
"Data": {
"Discriminator": "ProductOrder",
"Value": {
"ProductId": "a3f4e006-b3e4-4485-8a00-ad11015ac494"
}
}
}
]
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable