Mews · Schema

CompanyContractFilterParameters

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.
Limitation	object	Limitation on the quantity of data returned and optional Cursor for the starting point of data.
EnterpriseIds	array	Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
CompanyContractIds	array	Unique identifier of the Travel agency contracts to fetch.
CompanyIds	array	Unique identifiers of `Company` assigned with Travel agency contracts.
ServiceIds	array	Unique identifiers of `Service` where the Travel agency contracts belong to.
UpdatedUtc	object	Interval in which the Travel agency contracts were updated.
ActivityStates	array	Whether to return only active, only deleted or both records.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CompanyContractFilterParameters",
  "title": "CompanyContractFilterParameters",
  "required": [
    "AccessToken",
    "Client",
    "ClientToken",
    "Limitation"
  ],
  "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."
    },
    "Limitation": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Limitation"
        }
      ],
      "description": "Limitation on the quantity of data returned and optional Cursor for the starting point of data."
    },
    "EnterpriseIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.",
      "nullable": true
    },
    "CompanyContractIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifier of the Travel agency contracts to fetch.",
      "nullable": true
    },
    "CompanyIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `Company` assigned with Travel agency contracts.",
      "nullable": true
    },
    "ServiceIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `Service` where the Travel agency contracts belong to.",
      "nullable": true
    },
    "UpdatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the Travel agency contracts were updated.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "ActivityStates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ActivityStates"
      },
      "description": "Whether to return only active, only deleted or both records.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "CompanyContractFilterParameters"
}