---
title: "Get bill PDF"
method: POST
path: "/api/connector/v1/bills/getPdf"
tags: ["Bills"]
---

# Get bill PDF

`POST /api/connector/v1/bills/getPdf`

Generates a PDF document of the specified bill. If the PDF cannot be returned immediately, retry the call later with the unique event identifier returned by the first invocation as `BillPrintEventId`.

This operation is subject to the [Mews Operations quota](https://help.mews.com/s/article/Quotas-in-Mews-Operations) "Property Financial Document Print Event Weekly Count". Each bill can be printed or previewed up to 30 times within 7 days. Requests that include an existing `BillPrintEventId` do not count against this quota.

## Request body

- BillPdfParameters
  - `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.
  - `BillId` string, uuid, required — Unique identifier of the [Bill](https://mews-systems.gitbook.io/connector-api/operations/#bill) to be printed.
  - `BillPrintEventId` string, uuid, nullable — Identifier of an existing bill print event returned by a previous call. Provide this value to retry retrieval of a pending PDF without consuming its "Property Financial Document Print Event Weekly Count" quota.
  - `PdfTemplate` 'Detailed' | 'Consumption' | 'Reservation' | 'OrderItem' | 'Guest' — 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.)
  - `PrintReason` string, nullable — The reason for reprinting the bill with different template. Required for France LE.

## Response `200`

OK

- BillPdfResult
  - `BillId` string, uuid — Unique identifier of the printed bill.
  - `Result` object, required — The result of operation.
    - `Discriminator` 'BillPdfFile' | 'BillPrintEvent'
    - `Value` union
      - BillPdfFile
        - `Base64Data` string, required — Base64 encoded PDF file.
      - BillPrintEvent
        - `BillPrintEventId` string, uuid — Unique identifier of print event. Must be used in retry calls to retrieve the PDF.

## Other responses

- `204` — Server has successfully fulfilled the request and there is no additional information to send back.
- `400` — 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).
- `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
- `403` — 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.
- `408` — 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
- `429` — 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
- `500` — 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](https://github.com/MewsSystems/gitbook-connector-api).

---

[API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/revisions/f37f136ed35a/schema)