Get customers open items
POST /api/connector/v1/customers/getOpenItems
Use Get all payments and Get all order items instead.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifiers of the Customers.
ISO-4217 code of the Currency the item costs should be converted to.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "CustomerIds": [ "2a1a4315-7e6f-4131-af21-402cec59b8b9" ]}Responses
Section titled “ Responses ”OK
object
The customers with their items.
object
Unique identifier of the Customer.
object
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Code of tax exemption reason. Restricted! This property is currently intended for Mews’ internal usage and may be subject to change.
The open order items (consumed items such as nights or products).
object
Unique identifier of the item.
Unique identifier of the account (for example Customer) the item belongs to.
Unique identifier of the order (or Reservation which is a special type of order) the item belongs to.
Unique identifier of the Bill the item is assigned to.
Unique identifier of the Accounting category the item belongs to.
Unit count of item, i.e. the number of sub-items or units, if applicable.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Revenue type of the item.
Date and time of the item consumption in UTC timezone in ISO 8601 format.
Date and time of the item bill closure in UTC timezone in ISO 8601 format.
Accounting state of the item.
Additional data specific to particular order item.
object
object
object
The open payment items (such as cash, credit card payments or invoices).
Payment item
object
Unique identifier of the item.
Unique identifier of the account (for example Customer) the item belongs to.
Unique identifier of the Bill the item is assigned to.
Unique identifier of the Accounting category the item belongs to.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Additional notes.
Identifier of the settled payment from the external system (ApplePay/GooglePay).
Date and time of the item consumption in UTC timezone in ISO 8601 format.
Date and time of the item bill closure in UTC timezone in ISO 8601 format.
Accounting state of the item.
Payment state of the item.
Additional data specific to particular payment item.
object
object
object
Example
{ "Customers": [ { "CustomerId": "2a1a4315-7e6f-4131-af21-402cec59b8b9", "OrderItems": [ { "Id": "35820535-b988-4d6f-80cf-ecb19cdc3e58", "AccountId": "2a1a4315-7e6f-4131-af21-402cec59b8b9", "OrderId": "6645113e-72cc-4f99-ab77-e4452911bf20", "BillId": null, "AccountingCategoryId": "d250149e-a29d-4c70-b607-a1759faf7320", "Amount": { "Currency": "GBP", "NetValue": -5, "GrossValue": -5, "TaxValues": [ { "Code": "UK-Z", "Value": 0 } ], "Breakdown": { "Items": [ { "TaxRateCode": "UK-Z", "NetValue": -5, "TaxValue": 0 } ] } }, "RevenueType": "Additional", "ConsumedUtc": "2017-04-04T15:13:39Z", "ClosedUtc": null, "AccountingState": "Open", "Data": { "Discriminator": "Rebate", "Value": { "RebatedItemId": null } } } ], "PaymentItems": [] } ]}Server has successfully fulfilled the request and there is no additional information to send back.
object
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).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
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.
object
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
object
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.
object
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.