Mews · Schema

Vouchers update parameters

HospitalityHotelsPMSProperty Management

Properties

Name	Type	Description
VoucherId	string	Unique identifier of the Voucher.
Name	object	Internal name of the voucher (or `null` if the name should not be updated).
Type	object	Type of the voucher e.g. 'Public', 'PartnerCompany' or 'TravelAgency' (or `null` if the type should not be updated).
CompanyId	object	Unique identifier of Company (Company or Travel Agency) the voucher is related to. This is required for Type of `PartnerCompany` or `TravelAgency`. Use `null` if Company should not be updated.
AssignedRateIds	object	Unique identifiers of Rates (or `null` should it not be updated).
OccupiableIntervalStartUtc	object	Start of the interval in which the voucher can be applied (or `null` if the start time should not be updated).
OccupiableIntervalEndUtc	object	End of the interval in which the voucher can be applied (or `null` if the end time should not be updated).
ExternalIdentifier	object	Identifier of the voucher from external system (or `null` if the identifier should not be updated).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VoucherUpdateParameters",
  "title": "Vouchers update parameters",
  "required": [
    "VoucherId"
  ],
  "type": "object",
  "properties": {
    "VoucherId": {
      "type": "string",
      "description": "Unique identifier of the Voucher.",
      "format": "uuid"
    },
    "Name": {
      "title": "String update value",
      "maxLength": 128,
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Internal name of the voucher (or `null` if the name should not be updated).",
      "nullable": true
    },
    "Type": {
      "title": "Voucher Type update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/VoucherTypeUpdateValue"
        }
      ],
      "description": "Type of the voucher e.g. 'Public', 'PartnerCompany' or 'TravelAgency' (or `null` if the type should not be updated).",
      "nullable": true
    },
    "CompanyId": {
      "title": "Guid update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/GuidNullableUpdateValue"
        }
      ],
      "description": "Unique identifier of Company (Company or Travel Agency) the voucher is related to. This is required for Type of `PartnerCompany` or `TravelAgency`. Use `null` if Company should not be updated.",
      "nullable": true
    },
    "AssignedRateIds": {
      "title": "Assigned rate IDs",
      "allOf": [
        {
          "$ref": "#/components/schemas/AssignedRateIds"
        }
      ],
      "description": "Unique identifiers of Rates (or `null` should it not be updated).",
      "nullable": true
    },
    "OccupiableIntervalStartUtc": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Start of the interval in which the voucher can be applied (or `null` if the start time should not be updated).",
      "format": "date-time",
      "nullable": true
    },
    "OccupiableIntervalEndUtc": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "End of the interval in which the voucher can be applied (or `null` if the end time should not be updated).",
      "format": "date-time",
      "nullable": true
    },
    "ExternalIdentifier": {
      "title": "String update value",
      "maxLength": 255,
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Identifier of the voucher from external system (or `null` if the identifier should not be updated).",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "VoucherUpdateParameters"
}