Mews · Schema

Billing automation filter parameters

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.
CompanyIds array Unique identifiers of `Company` associated with the billing automations.
BillingAutomationIds array Unique identifiers of specific `Billing automation` items.
View JSON Schema on GitHub

JSON Schema

mews-billingautomationfilterparameters-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BillingAutomationFilterParameters",
  "title": "Billing automation filter parameters",
  "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
    },
    "CompanyIds": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `Company` associated with the billing automations.",
      "nullable": true
    },
    "BillingAutomationIds": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of specific `Billing automation` items.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "BillingAutomationFilterParameters"
}