PaymentFilterParameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentFilterParameters",
  "title": "PaymentFilterParameters",
  "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
    },
    "PaymentIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of specific `Payment` items. Required if no other filter is provided.",
      "nullable": true
    },
    "AccountIds": {
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of specific `Accounts` to which payments belong. Required if no other filter is provided.",
      "nullable": true
    },
    "BillIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of specific `Bill` items to which payments are assigned. Required if no other filter is provided.",
      "nullable": true
    },
    "ReservationIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of specific `Reservations` to which payments belong. Required if no other filter is provided.",
      "nullable": true
    },
    "CreatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Time interval during which the `Payment` was created. Required if no other filter is provided.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "UpdatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Time interval during which the `Payment` was updated. Required if no other filter is provided.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "ChargedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Time interval during which the `Payment` was charged. Required if no other filter is provided.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "ClosedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Time interval during which the `Payment` was closed. Required if no other filter is provided.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "SettlementUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the `Payments` were settled.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "Currency": {
      "type": "string",
      "description": "ISO-4217 code of the `Currency` the item costs should be converted to.",
      "format": "currency",
      "nullable": true
    },
    "AccountingStates": {
      "minItems": 1,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AccountingState"
      },
      "description": "Accounting state of the item.",
      "nullable": true
    },
    "States": {
      "minItems": 1,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentState"
      },
      "description": "Payment state of the item.",
      "nullable": true
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaymentDiscriminatorEnum"
        }
      ],
      "description": "Payment state of the item.\n\nPayment\n\nCreditCardPayment\n\nAlternativePayment\n\nCashPayment\n\nInvoicePayment\n\nExternalPayment\n\nGhostPayment\n\nTaxDeductedPayment",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "PaymentFilterParameters"
}