Skip to content

Get bill PDF

POST
/api/connector/v1/bills/getPdf

Creates a PDF version of the specified bill. In case it’s not possible to return PDF immediately, you must retry the call later while providing the unique event identifier that is returned from the first invocation.

BillPdfParameters
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
BillId
required

Unique identifier of the Bill to be printed.

string format: uuid
BillPrintEventId

Unique identifier of the Bill print event returned by previous invocation.

string format: uuid
nullable
PdfTemplate

Bill PDF template type. If not specified, the default template is used.

Detailed (Detailed overview. Items are grouped by the reservation, item type and price, and consumption date.)

Consumption (Overview by date (no reservation details). Items of the same type and price are grouped by consumption date.)

Reservation (Overview by reservation (no date). Items of the same type and price are grouped by reservation.)

OrderItem (Consumption overview (not fiscal document). Items are grouped by the item type and price without reservation details and consumption date.)

Guest (Overview by guest. Items are grouped by guest, reservation, consumption date, and item type.)

string
Allowed values: Detailed Consumption Reservation OrderItem Guest
PrintReason

The reason for reprinting the bill with different template. Required for France LE.

string
nullable <= 255 characters
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"BillId": "44eba542-193e-47c7-8077-abd7008eb206",
"PdfTemplate": "Detailed"
}

OK

BillPdfResult
object
BillId

Unique identifier of the printed bill.

string format: uuid
Result
Bill PDF result discriminator
object
Discriminator
Bill PDF result discriminator

The result of operation.

string
Allowed values: BillPdfFile BillPrintEvent
Value
One of:
Bill PDF file
object
Base64Data
required

Base64 encoded PDF file.

string
>= 1 characters
Example
{
"BillId": "44eba542-193e-47c7-8077-abd7008eb206",
"Result": {
"Discriminator": "BillPdfFile",
"Value": {
"Base64Data": "JVBERi0xLj..."
}
}
}

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