Mews · Schema

ReservationCancellationParameters

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.
EnterpriseId string Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
ReservationIds array Unique identifiers of the reservation to cancel.
ReservationId string
PostCancellationFee boolean Whether the cancellation fees should be charged according to rate conditions. The default is `false`.
SendEmail boolean Whether the cancellation email should be sent. The default is `true`.
Notes string Additional notes describing the reason for the cancellation.
View JSON Schema on GitHub

JSON Schema

mews-reservationcancellationparameters-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ReservationCancellationParameters",
  "title": "ReservationCancellationParameters",
  "required": [
    "AccessToken",
    "Client",
    "ClientToken",
    "ReservationIds"
  ],
  "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."
    },
    "EnterpriseId": {
      "type": "string",
      "description": "Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.",
      "format": "uuid",
      "nullable": true
    },
    "ReservationIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the reservation to cancel."
    },
    "ReservationId": {
      "type": "string",
      "format": "uuid",
      "deprecated": true
    },
    "PostCancellationFee": {
      "type": "boolean",
      "description": "Whether the cancellation fees should be charged according to rate conditions. The default is `false`.",
      "nullable": true
    },
    "SendEmail": {
      "type": "boolean",
      "description": "Whether the cancellation email should be sent. The default is `true`.",
      "nullable": true
    },
    "Notes": {
      "type": "string",
      "description": "Additional notes describing the reason for the cancellation."
    }
  },
  "additionalProperties": false,
  "x-schema-id": "ReservationCancellationParameters"
}