Mews · Schema

BillPdfParameters

HospitalityHotelsPMSProperty Management

Properties

Name Type Description
ClientToken string Token identifying the client application.
AccessToken string Access token of the client application.
Client string Name and version of the client application.
BillId string Unique identifier of the [Bill](https://mews-systems.gitbook.io/connector-api/operations/#bill) to be printed.
BillPrintEventId string Unique identifier of the [Bill print event](https://mews-systems.gitbook.io/connector-api/operations/#bill-print-event) returned by previous invocation.
PdfTemplate object 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 (Over
PrintReason string The reason for reprinting the bill with different template. Required for France LE.
View JSON Schema on GitHub

JSON Schema

mews-billpdfparameters-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BillPdfParameters",
  "title": "BillPdfParameters",
  "required": [
    "AccessToken",
    "BillId",
    "Client",
    "ClientToken"
  ],
  "type": "object",
  "properties": {
    "ClientToken": {
      "minLength": 1,
      "type": "string",
      "description": "Token identifying the client application."
    },
    "AccessToken": {
      "minLength": 1,
      "type": "string",
      "description": "Access token of the client application."
    },
    "Client": {
      "minLength": 1,
      "type": "string",
      "description": "Name and version of the client application."
    },
    "BillId": {
      "type": "string",
      "description": "Unique identifier of the [Bill](https://mews-systems.gitbook.io/connector-api/operations/#bill) to be printed.",
      "format": "uuid"
    },
    "BillPrintEventId": {
      "type": "string",
      "description": "Unique identifier of the [Bill print event](https://mews-systems.gitbook.io/connector-api/operations/#bill-print-event) returned by previous invocation.",
      "format": "uuid",
      "nullable": true
    },
    "PdfTemplate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FinancialDocumentPdfTemplateTypeEnum"
        }
      ],
      "description": "Bill PDF template type. If not specified, the default template is used.\n\nDetailed (Detailed overview. Items are grouped by the reservation, item type and price, and consumption date.)\n\nConsumption (Overview by date (no reservation details). Items of the same type and price are grouped by consumption date.)\n\nReservation (Overview by reservation (no date). Items of the same type and price are grouped by reservation.)\n\nOrderItem (Consumption overview (not fiscal document). Items are grouped by the item type and price without reservation details and consumption date.)\n\nGuest (Overview by guest. Items are grouped by guest, reservation, consumption date, and item type.)",
      "nullable": true
    },
    "PrintReason": {
      "maxLength": 255,
      "type": "string",
      "description": "The reason for reprinting the bill with different template. Required for France LE.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "BillPdfParameters"
}