openapi: 3.0.4
info:
  title: Mews Connector API — Customers and Companies
  description: General-purpose API that enables partners of Mews to access data and services in Mews Operations This modular spec covers the Customers and Companies domain (39 operations).
  termsOfService: https://www.mews.com/en/terms-conditions/partners
  contact:
    name: Partner success
    email: partnersuccess@mews.com
  version: v1
  x-generated-from: documentation
  x-source-url: https://api.mews.com/Swagger/connector/swagger.json
  x-last-validated: '2026-06-02'
paths:
  /api/connector/v1/addresses/getAll:
    post:
      tags:
      - Addresses
      summary: Mews Get All Addresses
      description: "Returns all addresses associated with the specified accounts within the enterprise. \nNote this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property)."
      operationId: addresses_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddressFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainIds:
              - 1df21f06-0cfc-4960-9c58-a3bf1261663e
              - 5fcd1933-22f2-40b9-84da-7db04cbecec2
              AccountIds:
              - 3db2c989-7d95-42b4-a502-a9f246db1634
              AddressIds:
              - fc7b2df3-de66-48a6-907d-af4600ecd892
              UpdatedUtc:
                StartUtc: '2022-12-10T00:00:00Z'
                EndUtc: '2022-12-17T00:00:00Z'
              ActivityStates:
              - Active
              Limitation:
                Count: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressResultPage'
              example:
                Addresses:
                - Id: fc7b2df3-de66-48a6-907d-af4600ecd892
                  AccountId: 3db2c989-7d95-42b4-a502-a9f246db1634
                  AccountType: Customer
                  Line1: I.P. Pavlova 5
                  Line2:
                  City: Prague
                  PostalCode: '12000'
                  CountryCode: CZ
                  CountrySubdivisionCode:
                  Latitude:
                  Longitude:
                  UpdatedUtc: '2023-11-29T14:49:29.982Z'
                  IsActive: true
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesGetAll400Example:
                  summary: Default addresses_getAll 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesGetAll401Example:
                  summary: Default addresses_getAll 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesGetAll403Example:
                  summary: Default addresses_getAll 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesGetAll408Example:
                  summary: Default addresses_getAll 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesGetAll204Example:
                  summary: Default addresses_getAll 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesGetAll429Example:
                  summary: Default addresses_getAll 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesGetAll500Example:
                  summary: Default addresses_getAll 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: &id001
        delay: 0
        dispatcher: FALLBACK
  /api/connector/v1/addresses/add:
    post:
      tags:
      - Addresses
      summary: Mews Add Addresses
      description: Adds one or more new addresses to the system and assigns them to specified accounts. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
      operationId: addresses_add
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleAddressAddParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
              Addresses:
              - AccountId: 3db2c989-7d95-42b4-a502-a9f246db1634
                Line1: Rheinlanddamm 207-209
                Line2:
                City: Dortmund
                PostalCode: '44137'
                CountryCode: DE
                CountrySubdivisionCode:
                Latitude:
                Longitude:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressResult'
              example:
                Addresses:
                - Id: fc7b2df3-de66-48a6-907d-af4600ecd892
                  AccountId: 3db2c989-7d95-42b4-a502-a9f246db1634
                  AccountType: Customer
                  Line1: I.P. Pavlova 5
                  Line2:
                  City: Prague
                  PostalCode: '12000'
                  CountryCode: CZ
                  CountrySubdivisionCode:
                  Latitude:
                  Longitude:
                  UpdatedUtc: '2023-11-29T14:49:29.982Z'
                  IsActive: true
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesAdd400Example:
                  summary: Default addresses_add 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesAdd401Example:
                  summary: Default addresses_add 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesAdd403Example:
                  summary: Default addresses_add 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesAdd408Example:
                  summary: Default addresses_add 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesAdd204Example:
                  summary: Default addresses_add 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesAdd429Example:
                  summary: Default addresses_add 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesAdd500Example:
                  summary: Default addresses_add 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/addresses/update:
    post:
      tags:
      - Addresses
      summary: Mews Update Addresses
      description: Updates one or more existing addresses in the system, assigned to specified accounts. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
      operationId: addresses_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleAddressUpdateParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
              AddressUpdates:
              - AddressId: fc7b2df3-de66-48a6-907d-af4600ecd892
                AccountId: 3db2c989-7d95-42b4-a502-a9f246db1634
                Line1:
                  Value: I.P. Pavlova 5
                Line2:
                  Value:
                City:
                  Value: Prague
                PostalCode:
                  Value: '12000'
                CountryCode:
                  Value: CZ
                CountrySubdivisionCode:
                  Value:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressResult'
              example:
                Addresses:
                - Id: fc7b2df3-de66-48a6-907d-af4600ecd892
                  AccountId: 3db2c989-7d95-42b4-a502-a9f246db1634
                  AccountType: Customer
                  Line1: I.P. Pavlova 5
                  Line2:
                  City: Prague
                  PostalCode: '12000'
                  CountryCode: CZ
                  CountrySubdivisionCode:
                  Latitude:
                  Longitude:
                  UpdatedUtc: '2023-11-29T14:49:29.982Z'
                  IsActive: true
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesUpdate400Example:
                  summary: Default addresses_update 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesUpdate401Example:
                  summary: Default addresses_update 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesUpdate403Example:
                  summary: Default addresses_update 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesUpdate408Example:
                  summary: Default addresses_update 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesUpdate204Example:
                  summary: Default addresses_update 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesUpdate429Example:
                  summary: Default addresses_update 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesUpdate500Example:
                  summary: Default addresses_update 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/addresses/delete:
    post:
      tags:
      - Addresses
      summary: Mews Delete Addresses
      description: Deletes one or more addresses in the system. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
      operationId: addresses_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddressDeleteParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
              AddressIds:
              - cefa640f-43fa-4a02-8d20-f97f68e19ed5
              - 44108366-8e9b-4007-844b-8ebcca4ac009
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
              examples:
                AddressesDelete200Example:
                  summary: Default addresses_delete 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesDelete400Example:
                  summary: Default addresses_delete 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesDelete401Example:
                  summary: Default addresses_delete 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesDelete403Example:
                  summary: Default addresses_delete 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesDelete408Example:
                  summary: Default addresses_delete 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesDelete204Example:
                  summary: Default addresses_delete 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesDelete429Example:
                  summary: Default addresses_delete 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AddressesDelete500Example:
                  summary: Default addresses_delete 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/ageCategories/getAll:
    post:
      tags:
      - Age categories
      summary: Mews Get All Age Categories
      description: "Returns all age categories filtered by [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service). \nNote this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property)."
      operationId: ageCategories_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgeCategoryParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              EnterpriseIds:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
              - 4d0201db-36f5-428b-8d11-4f0a65e960cc
              ServiceIds:
              - bd26d8db-86da-4f96-9efc-e5a4654a4a94
              AgeCategoryIds:
              - fe568bbd-1ecb-4bb2-bf77-96c3698de20d
              - ab58c939-be30-4a60-8f75-ae1600c60c9f
              UpdatedUtc:
                StartUtc: '2023-10-01T00:00:00Z'
                EndUtc: '2023-10-31T00:00:00Z'
              ActivityStates:
              - Active
              Limitation:
                Count: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgeCategoryResult'
              example:
                AgeCategories:
                - Id: ab58c939-be30-4a60-8f75-ae1600c60c9f
                  ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
                  MinimalAge:
                  MaximalAge:
                  Names:
                    cs-CZ: Dospělí
                    da-DK: Voksne
                    de-CH: Erwachsene
                    de-DE: Erwachsene
                    el-GR: Ενήλικοι
                    en-GB: Adults
                  ShortNames:
                  CreatedUtc: '2023-10-01T11:48:57Z'
                  UpdatedUtc: '2023-10-28T11:48:57Z'
                  Classification: Adult
                  IsActive: false
                  ExternalIdentifier: Adult
                - Id: fe568bbd-1ecb-4bb2-bf77-96c3698de20d
                  ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
                  MinimalAge: 0
                  MaximalAge: 18
                  Names:
                    cs-CZ: Děti
                    da-DK: Børn
                    de-CH: Kinder
                    de-DE: Kinder
                    el-GR: Παιδιά
                    en-GB: Children
                  ShortNames:
                  CreatedUtc: '2023-10-01T11:48:57Z'
                  UpdatedUtc: '2023-10-28T11:48:57Z'
                  Classification: Child
                  IsActive: false
                  ExternalIdentifier:
                Cursor: 0b9560fb-055d-47d3-a6d4-e579c44ca558
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AgeCategoriesGetAll400Example:
                  summary: Default ageCategories_getAll 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AgeCategoriesGetAll401Example:
                  summary: Default ageCategories_getAll 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AgeCategoriesGetAll403Example:
                  summary: Default ageCategories_getAll 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AgeCategoriesGetAll408Example:
                  summary: Default ageCategories_getAll 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AgeCategoriesGetAll204Example:
                  summary: Default ageCategories_getAll 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AgeCategoriesGetAll429Example:
                  summary: Default ageCategories_getAll 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                AgeCategoriesGetAll500Example:
                  summary: Default ageCategories_getAll 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/companies/add:
    post:
      tags:
      - Companies
      summary: Mews Add Company
      description: Adds a new company. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
      operationId: companies_add
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyAddParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
              Name: Mews
              Options:
                Invoiceable: true
                AddFeesToInvoices: true
              MotherCompanyId:
              Identifier:
              TaxIdentifier:
              AdditionalTaxIdentifier:
              BillingCode:
              AccountingCode:
              Address:
              InvoiceDueInterval: P2DT23H
              Telephone: 111-222-333
              ContacPerson: SamplePerson
              Contact: ContactInfo
              Notes: Note1
              Iata: PAO
              Department: Sales
              DunsNumber: '987654321'
              CreditRating:
                Basic: CreditOk
              ExternalIdentifier: '1234'
              ReferenceIdentifier: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
              WebsiteUrl: https://www.mews.com
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyResult'
              example:
                Companies:
                - Id: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
                  ChainId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
                  Name: Sample Company 1
                  IsActive: true
                  Number: 11
                  Identifier:
                  TaxIdentifier:
                  AdditionalTaxIdentifier:
                  ElectronicInvoiceIdentifier:
                  InvoiceDueInterval: P2DT23H
                  AccountingCode:
                  MotherCompanyId:
                  CreatedUtc: '2022-07-11T09:56:54Z'
                  UpdatedUtc: '2022-07-11T09:56:54Z'
                  AddressId: bab7441c-4b82-43bc-8001-ab0400a346ec
                  BillingCode:
                  Iata: PAO
                  Telephone: 111-222-333
                  InvoicingEmail: sample1@mews.com
                  ContacPerson: Sample Person 1
                  Contact: Contact Info 1
                  Notes: Note 1
                  Options:
                    Invoiceable: true
                    AddFeesToInvoices: true
                  Department: Sales
                  DunsNumber: '123456789'
                  CreditRating:
                    Basic: PaymentRequiredUpfront
                  ReferenceIdentifier: da34b396-77e3-495a-bd61-aecf00a3f19d
                  WebsiteUrl: https://www.mewssystems.com
                  ExternalIdentifier: company0001
                - Id: da34b396-41f7-47f6-8847-aecf00a3f19e
                  ChainId: 5fcd1933-22f2-40b9-84da-7db04cbecec2
                  Name: Sample Company 2
                  IsActive: true
                  Number: 12
                  Identifier:
                  TaxIdentifier:
                  AdditionalTaxIdentifier:
                  ElectronicInvoiceIdentifier:
                  InvoiceDueInterval: P2DT23H
                  AccountingCode:
                  MotherCompanyId:
                  CreatedUtc: '2022-07-11T09:56:54Z'
                  UpdatedUtc: '2022-07-11T09:56:54Z'
                  AddressId:
                  BillingCode:
                  Iata: PAO
                  Telephone: 111-222-333
                  InvoicingEmail: sample2@mews.com
                  ContacPerson: Sample Person 2
                  Contact: Contact Info 2
                  Notes: Note 2
                  Options:
                    Invoiceable: true
                    AddFeesToInvoices: false
                  Department: Accounting
                  DunsNumber: '987654321'
                  CreditRating:
                    Basic: CreditOk
                  ReferenceIdentifier: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
                  WebsiteUrl: https://www.mews.com
                  ExternalIdentifier: company0002
                Cursor: da34b396-41f7-47f6-8847-aecf00a3f19e
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesAdd400Example:
                  summary: Default companies_add 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesAdd401Example:
                  summary: Default companies_add 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesAdd403Example:
                  summary: Default companies_add 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesAdd408Example:
                  summary: Default companies_add 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesAdd204Example:
                  summary: Default companies_add 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesAdd429Example:
                  summary: Default companies_add 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesAdd500Example:
                  summary: Default companies_add 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/companies/update:
    post:
      tags:
      - Companies
      summary: Mews Update Company
      description: Updates information of the company. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
      operationId: companies_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyUpdateParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
              CompanyId: 7a1e4d67-d6a2-4a4c-a464-ab1100bea786
              Name:
                Value: Sample company name
              Options:
                Invoiceable:
                  Value: true
                AddFeesToInvoices:
                  Value: false
              MotherCompanyId:
                Value: ff649bce-0c4b-4395-9cdd-02039acb7cb3
              Identifier:
              TaxIdentifier:
              AdditionalTaxIdentifier:
              BillingCode:
              AccountingCode:
              InvoiceDueInterval:
                Value: P2DT23H
              ContactPerson:
                Value: John Snow
              Contact:
                Value: John Snow
              Notes:
                Value: Notes
              Iata:
                Value: PAO
              Department:
                Value: Marketing
              DunsNumber:
                Value: '123456789'
              CreditRating:
                Basic:
                  Value: PaymentRequiredUpfront
              ExternalIdentifier:
                Value: '4321'
              ReferenceIdentifier:
                Value: ff64395-9cdd-4395-9cdd-02039acb7cb3
              WebsiteUrl:
                Value: https://www.mews.com
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyResult'
              example:
                Companies:
                - Id: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
                  ChainId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
                  Name: Sample Company 1
                  IsActive: true
                  Number: 11
                  Identifier:
                  TaxIdentifier:
                  AdditionalTaxIdentifier:
                  ElectronicInvoiceIdentifier:
                  InvoiceDueInterval: P2DT23H
                  AccountingCode:
                  MotherCompanyId:
                  CreatedUtc: '2022-07-11T09:56:54Z'
                  UpdatedUtc: '2022-07-11T09:56:54Z'
                  AddressId: bab7441c-4b82-43bc-8001-ab0400a346ec
                  BillingCode:
                  Iata: PAO
                  Telephone: 111-222-333
                  InvoicingEmail: sample1@mews.com
                  ContacPerson: Sample Person 1
                  Contact: Contact Info 1
                  Notes: Note 1
                  Options:
                    Invoiceable: true
                    AddFeesToInvoices: true
                  Department: Sales
                  DunsNumber: '123456789'
                  CreditRating:
                    Basic: PaymentRequiredUpfront
                  ReferenceIdentifier: da34b396-77e3-495a-bd61-aecf00a3f19d
                  WebsiteUrl: https://www.mewssystems.com
                  ExternalIdentifier: company0001
                - Id: da34b396-41f7-47f6-8847-aecf00a3f19e
                  ChainId: 5fcd1933-22f2-40b9-84da-7db04cbecec2
                  Name: Sample Company 2
                  IsActive: true
                  Number: 12
                  Identifier:
                  TaxIdentifier:
                  AdditionalTaxIdentifier:
                  ElectronicInvoiceIdentifier:
                  InvoiceDueInterval: P2DT23H
                  AccountingCode:
                  MotherCompanyId:
                  CreatedUtc: '2022-07-11T09:56:54Z'
                  UpdatedUtc: '2022-07-11T09:56:54Z'
                  AddressId:
                  BillingCode:
                  Iata: PAO
                  Telephone: 111-222-333
                  InvoicingEmail: sample2@mews.com
                  ContacPerson: Sample Person 2
                  Contact: Contact Info 2
                  Notes: Note 2
                  Options:
                    Invoiceable: true
                    AddFeesToInvoices: false
                  Department: Accounting
                  DunsNumber: '987654321'
                  CreditRating:
                    Basic: CreditOk
                  ReferenceIdentifier: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
                  WebsiteUrl: https://www.mews.com
                  ExternalIdentifier: company0002
                Cursor: da34b396-41f7-47f6-8847-aecf00a3f19e
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesUpdate400Example:
                  summary: Default companies_update 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesUpdate401Example:
                  summary: Default companies_update 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesUpdate403Example:
                  summary: Default companies_update 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesUpdate408Example:
                  summary: Default companies_update 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesUpdate204Example:
                  summary: Default companies_update 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesUpdate429Example:
                  summary: Default companies_update 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesUpdate500Example:
                  summary: Default companies_update 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/companies/getAll:
    post:
      tags:
      - Companies
      summary: Mews Get All Companies
      description: 'Returns all company profiles of the enterprise, possibly filtered by identifiers, names or other filters.

        Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).'
      operationId: companies_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainIds:
              - 1df21f06-0cfc-4960-9c58-a3bf1261663e
              - 5fcd1933-22f2-40b9-84da-7db04cbecec2
              Ids:
              - 3ed9e2f3-4bba-4df6-8d41-ab1b009b6425
              - 8a98965a-7c03-48a1-a28c-ab1b009b53c8
              Names:
              - AC Company
              CreatedUtc:
                StartUtc: '2019-12-05T00:00:00Z'
                EndUtc: '2019-12-10T00:00:00Z'
              UpdatedUtc:
                StartUtc: '2019-12-10T00:00:00Z'
                EndUtc: '2019-12-17T00:00:00Z'
              ExternalIdentifiers:
              - '12345'
              - '4312343'
              Limitation:
                Count: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyResult'
              example:
                Companies:
                - Id: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
                  ChainId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
                  Name: Sample Company 1
                  IsActive: true
                  Number: 11
                  Identifier:
                  TaxIdentifier:
                  AdditionalTaxIdentifier:
                  ElectronicInvoiceIdentifier:
                  InvoiceDueInterval: P2DT23H
                  AccountingCode:
                  MotherCompanyId:
                  CreatedUtc: '2022-07-11T09:56:54Z'
                  UpdatedUtc: '2022-07-11T09:56:54Z'
                  AddressId: bab7441c-4b82-43bc-8001-ab0400a346ec
                  BillingCode:
                  Iata: PAO
                  Telephone: 111-222-333
                  InvoicingEmail: sample1@mews.com
                  ContacPerson: Sample Person 1
                  Contact: Contact Info 1
                  Notes: Note 1
                  Options:
                    Invoiceable: true
                    AddFeesToInvoices: true
                  Department: Sales
                  DunsNumber: '123456789'
                  CreditRating:
                    Basic: PaymentRequiredUpfront
                  ReferenceIdentifier: da34b396-77e3-495a-bd61-aecf00a3f19d
                  WebsiteUrl: https://www.mewssystems.com
                  ExternalIdentifier: company0001
                - Id: da34b396-41f7-47f6-8847-aecf00a3f19e
                  ChainId: 5fcd1933-22f2-40b9-84da-7db04cbecec2
                  Name: Sample Company 2
                  IsActive: true
                  Number: 12
                  Identifier:
                  TaxIdentifier:
                  AdditionalTaxIdentifier:
                  ElectronicInvoiceIdentifier:
                  InvoiceDueInterval: P2DT23H
                  AccountingCode:
                  MotherCompanyId:
                  CreatedUtc: '2022-07-11T09:56:54Z'
                  UpdatedUtc: '2022-07-11T09:56:54Z'
                  AddressId:
                  BillingCode:
                  Iata: PAO
                  Telephone: 111-222-333
                  InvoicingEmail: sample2@mews.com
                  ContacPerson: Sample Person 2
                  Contact: Contact Info 2
                  Notes: Note 2
                  Options:
                    Invoiceable: true
                    AddFeesToInvoices: false
                  Department: Accounting
                  DunsNumber: '987654321'
                  CreditRating:
                    Basic: CreditOk
                  ReferenceIdentifier: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
                  WebsiteUrl: https://www.mews.com
                  ExternalIdentifier: company0002
                Cursor: da34b396-41f7-47f6-8847-aecf00a3f19e
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesGetAll400Example:
                  summary: Default companies_getAll 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesGetAll401Example:
                  summary: Default companies_getAll 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesGetAll403Example:
                  summary: Default companies_getAll 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesGetAll408Example:
                  summary: Default companies_getAll 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesGetAll204Example:
                  summary: Default companies_getAll 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesGetAll429Example:
                  summary: Default companies_getAll 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesGetAll500Example:
                  summary: Default companies_getAll 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/companies/delete:
    post:
      tags:
      - Companies
      summary: Mews Delete Companies
      description: Deletes specified companies.
      operationId: companies_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleCompanyDeleteParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              CompanyIds:
              - eb02cbff-353d-48ec-97da-7def2305a5c5
              - 63551515-1740-49b3-914e-309a8b1429f0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
              examples:
                CompaniesDelete200Example:
                  summary: Default companies_delete 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesDelete400Example:
                  summary: Default companies_delete 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesDelete401Example:
                  summary: Default companies_delete 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesDelete403Example:
                  summary: Default companies_delete 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesDelete408Example:
                  summary: Default companies_delete 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesDelete204Example:
                  summary: Default companies_delete 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesDelete429Example:
                  summary: Default companies_delete 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompaniesDelete500Example:
                  summary: Default companies_delete 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/companionships/getAll:
    post:
      tags:
      - Companionships
      summary: Mews Get All Companionships
      description: 'Returns all companionships based on customers, reservations or reservation groups. One of them must be specified in the request.

        Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).'
      operationId: companionships_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanionshipFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              EnterpriseIds:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
              - 4d0201db-36f5-428b-8d11-4f0a65e960cc
              CompanionshipIds:
              - 72d4b117-1f84-44a3-1f84-8b2c0635ac60
              CustomerIds:
              - 35d4b117-4e60-44a3-9580-c582117eff98
              ReservationIds:
              - bfee2c44-1f84-4326-a862-5289598f6e2d
              ReservationGroupIds:
              - c704dff3-7811-4af7-a3a0-7b2b0635ac59
              UpdatedUtc:
                StartUtc: '2020-02-05T00:00:00Z'
                EndUtc: '2020-02-10T00:00:00Z'
              Limitation:
                Count: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanionshipResult'
              example:
                Companionships:
                - Id: 72d4b117-1f84-44a3-1f84-8b2c0635ac60
                  CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98
                  ReservationGroupId: c704dff3-7811-4af7-a3a0-7b2b0635ac59
                  ReservationId: bfee2c44-1f84-4326-a862-5289598f6e2d
                Customers:
                Reservations:
                ReservationGroups:
                Cursor: 72d4b117-1f84-44a3-1f84-8b2c0635ac60
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanionshipsGetAll400Example:
                  summary: Default companionships_getAll 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanionshipsGetAll401Example:
                  summary: Default companionships_getAll 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanionshipsGetAll403Example:
                  summary: Default companionships_getAll 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanionshipsGetAll408Example:
                  summary: Default companionships_getAll 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanionshipsGetAll204Example:
                  summary: Default companionships_getAll 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanionshipsGetAll429Example:
                  summary: Default companionships_getAll 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanionshipsGetAll500Example:
                  summary: Default companionships_getAll 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/companyContracts/getAll:
    post:
      tags:
      - Company contracts
      summary: Mews Get All Company Contracts
      description: 'Returns all contracts between the enterprise and other companies.

        Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).'
      operationId: companyContracts_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyContractFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              CompanyContractIds:
              - 3396f6f3-6733-443b-92e0-b2a0009a05a7
              CompanyIds:
              - bfd5667b-533f-424f-860d-af150065f4d6
              ServiceIds:
              - c8f88563-dc60-47f3-aca3-af150065d951
              UpdatedUtc:
                StartUtc: '2023-10-01T00:00:00Z'
                EndUtc: '2023-10-31T00:00:00Z'
              ActivityStates:
              - Active
              - Deleted
              EnterpriseIds:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
              - 4d0201db-36f5-428b-8d11-4f0a65e960cc
              Limitation:
                Count: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractResult'
              example:
                TravelAgencyContracts:
                - Id: 0078f370-3787-43dc-a615-af150066bb88
                  ServiceId: c8f88563-dc60-47f3-aca3-af150065d951
                  CompanyId: bfd5667b-533f-424f-860d-af150065f4d6
                  CreatedUtc: '2023-10-01T11:48:57Z'
                  UpdatedUtc: '2023-10-28T11:48:57Z'
                  IsActive: true
                  CommissionIncluded: true
                  Commission: 0.1
                  ChannelManagerAbsoluteAdjustment: 10
                  ChannelManagerRelativeAdjustment: 0.15
                  Options:
                    IncludeCancellationFeeInCommissionEstimate: true
                    SkipAutomaticSettlement: true
                  AccountingCode: P2DT23H
                  InvoiceDueInterval: P0M15DT0H0M0S
                  ChannelManagerBusinessSegmentId: 1289d3c8-3c83-4169-b756-af150066bb87
                  ContactPerson: Sample person
                  ContactEmail: sample-person@email.com
                  AdditionalContactInfo:
                  Notes:
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsGetAll400Example:
                  summary: Default companyContracts_getAll 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsGetAll401Example:
                  summary: Default companyContracts_getAll 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsGetAll403Example:
                  summary: Default companyContracts_getAll 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsGetAll408Example:
                  summary: Default companyContracts_getAll 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsGetAll204Example:
                  summary: Default companyContracts_getAll 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsGetAll429Example:
                  summary: Default companyContracts_getAll 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsGetAll500Example:
                  summary: Default companyContracts_getAll 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/companyContracts/add:
    post:
      tags:
      - Company contracts
      summary: Mews Add Company Contracts
      description: Adds one or more company contracts.
      operationId: companyContracts_add
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleCompanyContractAddParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              TravelAgencyContracts:
              - ServiceId: c8f88563-dc60-47f3-aca3-af150065d951
                CompanyId: 896e9313-477d-4306-9d37-af150065f4d6
                CommissionIncluded: true
                Commission: 0.1
                ChannelManagerAbsoluteAdjustment: 10
                ChannelManagerRelativeAdjustment: 0.15
                Options:
                  IncludeCancellationFeeInCommissionEstimate: false
                  SkipAutomaticSettlement: false
                AccountingCode: P2DT23H
                InvoiceDueInterval: P0M15DT0H0M0S
                ChannelManagerBusinessSegmentId: 1289d3c8-3c83-4169-b756-af150066bb87
                ContactPerson: Sample person
                ContactEmail: sample-person@email.com
                AdditionalContactInfo:
                Notes:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractAdditionResult'
              example:
                TravelAgencyContracts:
                - Id: 0078f370-3787-43dc-a615-af150066bb88
                  ServiceId: c8f88563-dc60-47f3-aca3-af150065d951
                  CompanyId: bfd5667b-533f-424f-860d-af150065f4d6
                  CreatedUtc: '2023-10-01T11:48:57Z'
                  UpdatedUtc: '2023-10-28T11:48:57Z'
                  IsActive: true
                  CommissionIncluded: true
                  Commission: 0.1
                  ChannelManagerAbsoluteAdjustment: 10
                  ChannelManagerRelativeAdjustment: 0.15
                  Options:
                    IncludeCancellationFeeInCommissionEstimate: true
                    SkipAutomaticSettlement: true
                  AccountingCode: P2DT23H
                  InvoiceDueInterval: P0M15DT0H0M0S
                  ChannelManagerBusinessSegmentId: 1289d3c8-3c83-4169-b756-af150066bb87
                  ContactPerson: Sample person
                  ContactEmail: sample-person@email.com
                  AdditionalContactInfo:
                  Notes:
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsAdd400Example:
                  summary: Default companyContracts_add 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsAdd401Example:
                  summary: Default companyContracts_add 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsAdd403Example:
                  summary: Default companyContracts_add 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsAdd408Example:
                  summary: Default companyContracts_add 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsAdd204Example:
                  summary: Default companyContracts_add 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsAdd429Example:
                  summary: Default companyContracts_add 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsAdd500Example:
                  summary: Default companyContracts_add 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/companyContracts/update:
    post:
      tags:
      - Company contracts
      summary: Mews Update Company Contracts
      description: Updates one or more company contracts.
      operationId: companyContracts_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleCompanyContractUpdateParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              TravelAgencyContractUpdates:
              - TravelAgencyContractId: 652d4a22-ac33-42b7-abe7-af1f00820023
                CommissionIncluded:
                  Value: true
                Commission:
                  Value: 0.1
                ChannelManagerAbsoluteAdjustment:
                  Value: 10
                ChannelManagerRelativeAdjustment:
                  Value: 0.15
                Options:
                  IncludeCancellationFeeInCommissionEstimate:
                    Value: true
                  SkipAutomaticSettlement:
                    Value: true
                AccountingCode:
                  Value: P2DT23H
                InvoiceDueInterval:
                  Value: P0M15DT0H0M0S
                ChannelManagerBusinessSegmentId:
                  Value: 1289D3C8-3C83-4169-B756-AF150066BB87
                ContactPerson:
                  Value: Sample person
                ContactEmail:
                  Value: sample-person@email.com
                AdditionalContactInfo:
                Notes:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractUpdateResult'
              example:
                TravelAgencyContracts:
                - Id: 0078f370-3787-43dc-a615-af150066bb88
                  ServiceId: c8f88563-dc60-47f3-aca3-af150065d951
                  CompanyId: bfd5667b-533f-424f-860d-af150065f4d6
                  CreatedUtc: '2023-10-01T11:48:57Z'
                  UpdatedUtc: '2023-10-28T11:48:57Z'
                  IsActive: true
                  CommissionIncluded: true
                  Commission: 0.1
                  ChannelManagerAbsoluteAdjustment: 10
                  ChannelManagerRelativeAdjustment: 0.15
                  Options:
                    IncludeCancellationFeeInCommissionEstimate: true
                    SkipAutomaticSettlement: true
                  AccountingCode: P2DT23H
                  InvoiceDueInterval: P0M15DT0H0M0S
                  ChannelManagerBusinessSegmentId: 1289d3c8-3c83-4169-b756-af150066bb87
                  ContactPerson: Sample person
                  ContactEmail: sample-person@email.com
                  AdditionalContactInfo:
                  Notes:
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsUpdate400Example:
                  summary: Default companyContracts_update 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsUpdate401Example:
                  summary: Default companyContracts_update 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsUpdate403Example:
                  summary: Default companyContracts_update 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsUpdate408Example:
                  summary: Default companyContracts_update 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsUpdate204Example:
                  summary: Default companyContracts_update 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsUpdate429Example:
                  summary: Default companyContracts_update 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsUpdate500Example:
                  summary: Default companyContracts_update 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/companyContracts/delete:
    post:
      tags:
      - Company contracts
      summary: Mews Delete Company Contracts
      description: Deletes one or more company contracts. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: companyContracts_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleCompanyContractDeleteParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              TravelAgencyContractIds:
              - 0078f370-3787-43dc-a615-af150066bb88
              - 652d4a22-ac33-42b7-abe7-af1f00820023
              ServiceIds:
              - a1d6dee8-355b-44c3-b6be-faef1a7eb6c0
              - d5a2aac3-5194-479b-ba05-6c073398e0fd
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
              examples:
                CompanyContractsDelete200Example:
                  summary: Default companyContracts_delete 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsDelete400Example:
                  summary: Default companyContracts_delete 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsDelete401Example:
                  summary: Default companyContracts_delete 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsDelete403Example:
                  summary: Default companyContracts_delete 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsDelete408Example:
                  summary: Default companyContracts_delete 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsDelete204Example:
                  summary: Default companyContracts_delete 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsDelete429Example:
                  summary: Default companyContracts_delete 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CompanyContractsDelete500Example:
                  summary: Default companyContracts_delete 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/customers/getAll:
    post:
      tags:
      - Customers
      summary: Mews Get All Customers
      description: 'Returns all customers filtered by identifiers, emails, names and other filters.

        Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).'
      operationId: customers_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainIds:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
              - 5fcd1933-22f2-40b9-84da-7db04cbecec2
              CreatedUtc:
                StartUtc: '2018-01-01T00:00:00Z'
                EndUtc: '2018-01-30T00:00:00Z'
              UpdatedUtc:
                StartUtc: '2018-01-02T00:00:00Z'
                EndUtc: '2018-01-30T00:00:00Z'
              Extent:
                Customers: true
                Documents: false
                Addresses: false
              ActivityStates:
              - Active
              CustomerIds:
              - fadd5bb6-b428-45d5-94f8-fd0d89fece6d
              CompanyIds:
              - c6f5c82d-621a-4c8a-903b-1b0a9a23b71f
              Emails:
              - j.smith@example.com
              FirstNames:
              - John
              - Jane
              LastNames:
              - Doe
              - Smith
              LoyaltyCodes:
              - LL810213
              Limitation:
                Count: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerResult'
              example:
                Customers:
                - Id: fadd5bb6-b428-45d5-94f8-fd0d89fece6d
                  ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  Number: '12345'
                  Title: Mister
                  Sex: Male
                  FirstName: John
                  LastName: Smith
                  SecondLastName: Williams
                  NationalityCode: US
                  PreferredLanguageCode: en-GB
                  LanguageCode: en-US
                  BirthDate: '1983-12-31'
                  BirthCountryCode:
                  BirthCountrySubdivisionCode:
                  BirthPlace: New York City, NY
                  Occupation: Carpenter
                  Email: j.smith@example.com
                  HasOtaEmail: false
                  Phone: 00420123456789
                  TaxIdentificationNumber: '123456789'
                  LoyaltyCode: LL810213
                  AccountingCode: AC123
                  BillingCode:
                  Notes: ''
                  CarRegistrationNumber: 1A2 3456
                  DietaryRequirements:
                  CreatedUtc: '2018-01-01T00:00:00Z'
                  UpdatedUtc: '2018-01-02T00:00:00Z'
                  Passport:
                  IdentityCard:
                  Visa:
                  DriversLicense:
                  Address:
                    Id: f8495413-bf49-45dd-843c-44be7f365569
                    Line1: Somerford Road Hello House/135
                    Line2:
                    City: Christchurch
                    PostalCode: BH23 3PY
                    CountryCode: GB
                    CountrySubdivisionCode: GB-ENG
                    Latitude:
                    Longitude:
                  AddressId: f8495413-bf49-45dd-843c-44be7f365569
                  Classifications:
                  - Returning
                  Options:
                  - SendMarketingEmails
                  ItalianDestinationCode:
                  ItalianFiscalCode:
                  ItalianLotteryCode:
                  CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f
                  MergeTargetId:
                  ActivityState: Active
                  IsActive: true
                  PreferredSpaceFeatures:
                  - OceanView
                  CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf
                  UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae
                Documents:
                Cursor: fadd5bb6-b428-45d5-94f8-fd0d89fece6d
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetAll400Example:
                  summary: Default customers_getAll 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetAll401Example:
                  summary: Default customers_getAll 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetAll403Example:
                  summary: Default customers_getAll 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetAll408Example:
                  summary: Default customers_getAll 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetAll204Example:
                  summary: Default customers_getAll 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetAll429Example:
                  summary: Default customers_getAll 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetAll500Example:
                  summary: Default customers_getAll 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/customers/search:
    post:
      tags:
      - Customers
      summary: Mews Search Customers
      description: Searches for customers that are active at the moment in the enterprise (e.g. companions of checked-in reservations or paymasters).
      operationId: customers_search
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerSearchParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              Name: Smith
              ResourceId:
              Extent:
                Customers: true
                Documents: false
                Addresses: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerSearchResult'
              example:
                Customers:
                - Customer:
                    Id: fadd5bb6-b428-45d5-94f8-fd0d89fece6d
                    ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                    Number: '12345'
                    Title: Mister
                    Sex: Male
                    FirstName: John
                    LastName: Smith
                    SecondLastName: Williams
                    NationalityCode: US
                    PreferredLanguageCode: en-GB
                    LanguageCode: en-US
                    BirthDate: '1983-12-31'
                    BirthCountryCode:
                    BirthCountrySubdivisionCode:
                    BirthPlace: New York City, NY
                    Occupation: Carpenter
                    Email: j.smith@example.com
                    HasOtaEmail: false
                    Phone: 00420123456789
                    TaxIdentificationNumber: '123456789'
                    LoyaltyCode: LL810213
                    AccountingCode: AC123
                    BillingCode:
                    Notes: ''
                    CarRegistrationNumber: 1A2 3456
                    DietaryRequirements:
                    CreatedUtc: '2018-01-01T00:00:00Z'
                    UpdatedUtc: '2018-01-02T00:00:00Z'
                    Passport:
                    IdentityCard:
                    Visa:
                    DriversLicense:
                    Address:
                      Id: f8495413-bf49-45dd-843c-44be7f365569
                      Line1: Somerford Road Hello House/135
                      Line2:
                      City: Christchurch
                      PostalCode: BH23 3PY
                      CountryCode: GB
                      CountrySubdivisionCode: GB-ENG
                      Latitude:
                      Longitude:
                    AddressId: f8495413-bf49-45dd-843c-44be7f365569
                    Classifications:
                    - Returning
                    Options:
                    - SendMarketingEmails
                    ItalianDestinationCode:
                    ItalianFiscalCode:
                    ItalianLotteryCode:
                    CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f
                    MergeTargetId:
                    ActivityState: Active
                    IsActive: true
                    PreferredSpaceFeatures:
                    - OceanView
                    CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf
                    UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae
                  Reservation:
                Documents:
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersSearch400Example:
                  summary: Default customers_search 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersSearch401Example:
                  summary: Default customers_search 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersSearch403Example:
                  summary: Default customers_search 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersSearch408Example:
                  summary: Default customers_search 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersSearch204Example:
                  summary: Default customers_search 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersSearch429Example:
                  summary: Default customers_search 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersSearch500Example:
                  summary: Default customers_search 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/customers/getOpenItems:
    post:
      tags:
      - Customers
      summary: Mews Get Customers Open Items
      description: Use [Get all payments](https://mews-systems.gitbook.io/connector-api/operations/payments#get-all-payments) and [Get all order items](https://mews-systems.gitbook.io/connector-api/operations/orderitems#get-all-order-items) instead.
      operationId: customers_getOpenItems
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerItemParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              CustomerIds:
              - 2a1a4315-7e6f-4131-af21-402cec59b8b9
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerItemResult'
              example:
                Customers:
                - CustomerId: 2a1a4315-7e6f-4131-af21-402cec59b8b9
                  OrderItems:
                  - Id: 35820535-b988-4d6f-80cf-ecb19cdc3e58
                    AccountId: 2a1a4315-7e6f-4131-af21-402cec59b8b9
                    OrderId: 6645113e-72cc-4f99-ab77-e4452911bf20
                    BillId:
                    AccountingCategoryId: d250149e-a29d-4c70-b607-a1759faf7320
                    Amount:
                      Currency: GBP
                      NetValue: -5
                      GrossValue: -5
                      TaxValues:
                      - Code: UK-Z
                        Value: 0
                      Breakdown:
                        Items:
                        - TaxRateCode: UK-Z
                          NetValue: -5
                          TaxValue: 0
                    RevenueType: Additional
                    ConsumedUtc: '2017-04-04T15:13:39Z'
                    ClosedUtc:
                    AccountingState: Open
                    Data:
                      Discriminator: Rebate
                      Value:
                        RebatedItemId:
                  PaymentItems: []
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetOpenItems400Example:
                  summary: Default customers_getOpenItems 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetOpenItems401Example:
                  summary: Default customers_getOpenItems 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetOpenItems403Example:
                  summary: Default customers_getOpenItems 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetOpenItems408Example:
                  summary: Default customers_getOpenItems 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetOpenItems204Example:
                  summary: Default customers_getOpenItems 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetOpenItems429Example:
                  summary: Default customers_getOpenItems 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetOpenItems500Example:
                  summary: Default customers_getOpenItems 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      deprecated: true
      x-deprecatedMessage: Use [Get all payments](https://mews-systems.gitbook.io/connector-api/operations/payments#get-all-payments) and [Get all order items](https://mews-systems.gitbook.io/connector-api/operations/orderitems#get-all-order-items) instead.
      x-microcks-operation: *id001
  /api/connector/v1/customers/add:
    post:
      tags:
      - Customers
      summary: Mews Add Customer
      description: Adds a new customer to the system and returns details of the added customer. If a customer with the specified email already exists, and `OverwriteExisting` is set to `true`, then the existing customer profile information is overwritten and the existing customer data returned. If `OverwriteExisting` is set to `false`, an error response is returned. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
      operationId: customers_add
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerAddParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              Title: Miss
              FirstName: Thea
              LastName: Carbone
              BirthDate: '1985-09-30'
              BirthPlace: Pescara (BI)
              Occupation: Giornalista
              Email: thea@quotidiano.example
              Phone: +39 06 555 5555
              Notes: Check-in notturno.
              CarRegistrationNumber: AA 111AA
              TaxIdentificationNumber: ZGNZLR17U72P554F
              Address:
                Line1: Via Antimo 474 Piano 5
                City: Liborio laziale
                PostalCode: '30228'
                CountryCode: IT
                CountrySubdivisionCode: IT-65
              Classifications:
              - Media
              - FriendOrFamily
              Options:
              - SendMarketingEmails
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
              OverwriteExisting: false
              ItalianDestinationCode: '7654321'
              ItalianFiscalCode: ZGNZLR17U72P554F
              ItalianLotteryCode: AB12345
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
              example:
                Id: 99b4f0af-9558-463b-8452-07a9bc414708
                ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                Number: '390881'
                Title: Miss
                Sex:
                FirstName: Thea
                LastName: Carbone
                SecondLastName:
                NationalityCode:
                PreferredLanguageCode:
                LanguageCode:
                BirthDate: '1985-09-30'
                BirthCountryCode:
                BirthCountrySubdivisionCode:
                BirthPlace: Pescara (BI)
                Occupation: Giornalista
                Email: thea@quotidiano.example
                HasOtaEmail: false
                Phone: +39 06 555 5555
                TaxIdentificationNumber: ZGNZLR17U72P554F
                LoyaltyCode:
                AccountingCode:
                BillingCode:
                Notes: Check-in notturno.
                CarRegistrationNumber: AA 111AA
                DietaryRequirements:
                CreatedUtc: '2024-09-17T12:22:33Z'
                UpdatedUtc: '2024-10-12T09:45:00Z'
                Passport:
                IdentityCard:
                Visa:
                DriversLicense:
                Address:
                  Id: 81f62f08-26d5-408f-9b0d-d030957dc799
                  Line1: Via Antimo 474 Piano 5
                  Line2:
                  City: Liborio laziale
                  PostalCode: '30228'
                  CountryCode: IT
                  CountrySubdivisionCode: IT-65
                  Latitude: 28.56333
                  Longitude: -121.243143
                AddressId: 81f62f08-26d5-408f-9b0d-d030957dc799
                Classifications:
                - Media
                - FriendOrFamily
                Options: []
                ItalianDestinationCode: '7654321'
                ItalianFiscalCode: ZGNZLR17U72P554F
                ItalianLotteryCode: AB12345
                CompanyId: f3b4f0af-9558-463b-8452-07a9bc414708
                MergeTargetId:
                ActivityState:
                IsActive: true
                PreferredSpaceFeatures:
                - LowerBed
                CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf
                UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAdd400Example:
                  summary: Default customers_add 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAdd401Example:
                  summary: Default customers_add 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAdd403Example:
                  summary: Default customers_add 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAdd408Example:
                  summary: Default customers_add 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAdd204Example:
                  summary: Default customers_add 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAdd429Example:
                  summary: Default customers_add 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAdd500Example:
                  summary: Default customers_add 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/customers/update:
    post:
      tags:
      - Customers
      summary: Mews Update Customer
      description: Updates personal information of a customer. Note that if any of the fields is left blank, it won't clear the field in Mews. The field will be left intact. In case of email update, the email will change in Mews only if there is no other customer profile in the hotel with such email. Otherwise an error response is returned. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
      operationId: customers_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerUpdateParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
              CustomerId: 99b4f0af-9558-463b-8452-07a9bc414708
              Title: Miss
              FirstName: Thea
              LastName: Carbone
              BirthDate: '1985-09-30'
              BirthPlace: Pescara (BI)
              Occupation: Giornalista
              Email: thea@quotidiano.example
              Phone: +39 06 555 5555
              Notes: Check-in notturno.
              CarRegistrationNumber: AA 111AA
              TaxIdentificationNumber: ZGNZLR17U72P554F
              CompanyId: f3b4f0af-9558-463b-8452-07a9bc414708
              Address:
                Line1: Via Antimo 474 Piano 5
                City: Liborio laziale
                PostalCode: '30228'
                CountryCode: IT
                CountrySubdivisionCode: IT-65
              Classifications:
              - Media
              - FriendOrFamily
              Options:
              - SendMarketingEmails
              ItalianDestinationCode:
                Value: '7654321'
              ItalianFiscalCode:
                Value: ZGNZLR17U72P554F
              ItalianLotteryCode:
                Value: AB12345
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
              example:
                Id: 99b4f0af-9558-463b-8452-07a9bc414708
                ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                Number: '390881'
                Title: Miss
                Sex:
                FirstName: Thea
                LastName: Carbone
                SecondLastName:
                NationalityCode:
                PreferredLanguageCode:
                LanguageCode:
                BirthDate: '1985-09-30'
                BirthCountryCode:
                BirthCountrySubdivisionCode:
                BirthPlace: Pescara (BI)
                Occupation: Giornalista
                Email: thea@quotidiano.example
                HasOtaEmail: false
                Phone: +39 06 555 5555
                TaxIdentificationNumber: ZGNZLR17U72P554F
                LoyaltyCode:
                AccountingCode:
                BillingCode:
                Notes: Check-in notturno.
                CarRegistrationNumber: AA 111AA
                DietaryRequirements:
                CreatedUtc: '2024-09-17T12:22:33Z'
                UpdatedUtc: '2024-10-12T09:45:00Z'
                Passport:
                IdentityCard:
                Visa:
                DriversLicense:
                Address:
                  Id: 81f62f08-26d5-408f-9b0d-d030957dc799
                  Line1: Via Antimo 474 Piano 5
                  Line2:
                  City: Liborio laziale
                  PostalCode: '30228'
                  CountryCode: IT
                  CountrySubdivisionCode: IT-65
                  Latitude: 28.56333
                  Longitude: -121.243143
                AddressId: 81f62f08-26d5-408f-9b0d-d030957dc799
                Classifications:
                - Media
                - FriendOrFamily
                Options: []
                ItalianDestinationCode: '7654321'
                ItalianFiscalCode: ZGNZLR17U72P554F
                ItalianLotteryCode: AB12345
                CompanyId: f3b4f0af-9558-463b-8452-07a9bc414708
                MergeTargetId:
                ActivityState:
                IsActive: true
                PreferredSpaceFeatures:
                - LowerBed
                CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf
                UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersUpdate400Example:
                  summary: Default customers_update 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersUpdate401Example:
                  summary: Default customers_update 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersUpdate403Example:
                  summary: Default customers_update 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersUpdate408Example:
                  summary: Default customers_update 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersUpdate204Example:
                  summary: Default customers_update 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersUpdate429Example:
                  summary: Default customers_update 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersUpdate500Example:
                  summary: Default customers_update 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/customers/merge:
    post:
      tags:
      - Customers
      summary: Mews Merge Customers
      description: Use [Merge accounts](https://mews-systems.gitbook.io/connector-api/operations/accounts#merge-accounts) instead.
      operationId: customers_merge
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerMergeParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              SourceCustomerId: e11801ff-4148-4010-87f3-0d111e2893e3
              TargetCustomerId: 35d4b117-4e60-44a3-9580-c582117eff98
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
              examples:
                CustomersMerge200Example:
                  summary: Default customers_merge 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersMerge400Example:
                  summary: Default customers_merge 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersMerge401Example:
                  summary: Default customers_merge 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersMerge403Example:
                  summary: Default customers_merge 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersMerge408Example:
                  summary: Default customers_merge 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersMerge204Example:
                  summary: Default customers_merge 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersMerge429Example:
                  summary: Default customers_merge 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersMerge500Example:
                  summary: Default customers_merge 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      deprecated: true
      x-deprecatedMessage: Use [Merge accounts](https://mews-systems.gitbook.io/connector-api/operations/accounts#merge-accounts) instead.
      x-microcks-operation: *id001
  /api/connector/v1/customers/addFile:
    post:
      tags:
      - Customers
      summary: Mews Add Customer File
      description: "Attaches the specified file to the customer profile. \r\n\r\nAllowed MIME types: `application/pdf`, `image/bmp`, `image/gif`, `image/jpeg`, `image/png`, `image/tiff`.\r\n\r\nNote this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/guidelines/multi-property)."
      operationId: customers_addFile
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerFileParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              CustomerId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
              Name: document.pdf
              Type: application/pdf
              Data: JVBERi0xLjAKMSAwIG9iajw8L1BhZ2VzIDIgMCBSPj5lbmRvYmogMiAwIG9iajw8L0tpZHNbMyAwIFJdL0NvdW50IDE+PmVuZG9iaiAzIDAgb2JqPDwvTWVkaWFCb3hbMCAwIDMgM10+PmVuZG9iagp0cmFpbGVyPDwvUm9vdCAxIDAgUj4+Cg==
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerAddFileResult'
              example:
                FileId: f039f5b4-ff18-4510-9086-92b14a68ed78
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAddFile400Example:
                  summary: Default customers_addFile 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAddFile401Example:
                  summary: Default customers_addFile 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAddFile403Example:
                  summary: Default customers_addFile 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAddFile408Example:
                  summary: Default customers_addFile 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAddFile204Example:
                  summary: Default customers_addFile 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAddFile429Example:
                  summary: Default customers_addFile 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersAddFile500Example:
                  summary: Default customers_addFile 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/customers/getRelationships:
    post:
      tags:
      - Customers
      summary: Mews Get Customers Relationships
      description: Returns relationships between customers (e.g. Spouse, Friend) for the provided unique identifiers of customers.
      operationId: customers_getRelationships
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerRelationshipFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              CustomerIds:
              - fadd5bb6-b428-45d5-94f8-fd0d89fece6d
              - bccdafd1-3e44-439d-861f-341526b597a9
              ChainIds:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
              - 5fcd1933-22f2-40b9-84da-7db04cbecec2
              Limitation:
                Count: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerRelationshipResult'
              example:
                CustomerRelationships:
                - CustomerId: cbe8a32e-3eb7-4226-baf4-69455a0eeaf5
                  RelatedCustomerId: cbe8a32e-3eb7-4226-baf4-69455a0eeaf6
                  Relationship: Other
                - CustomerId: cbe8a32e-3eb7-4226-baf4-69455a0eeaf6
                  RelatedCustomerId: cbe8a32e-3eb7-4226-baf4-69455a0eeaf5
                  Relationship: Other
                Cursor:
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetRelationships400Example:
                  summary: Default customers_getRelationships 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetRelationships401Example:
                  summary: Default customers_getRelationships 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetRelationships403Example:
                  summary: Default customers_getRelationships 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetRelationships408Example:
                  summary: Default customers_getRelationships 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetRelationships204Example:
                  summary: Default customers_getRelationships 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetRelationships429Example:
                  summary: Default customers_getRelationships 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                CustomersGetRelationships500Example:
                  summary: Default customers_getRelationships 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-restricted: true
      x-microcks-operation: *id001
  /api/connector/v1/identityDocuments/getAll:
    post:
      tags:
      - Identity documents
      summary: Mews Get All Identity Documents
      description: Returns all identity documents for the specified customers, with additional filtering options available. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: identityDocuments_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityDocumentFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              IdentityDocumentIds:
              - e8a72a69-c20b-4278-b699-ab0400a32ecc
              - 24a3f051-49ed-411b-9384-78187f9daae6
              CustomerIds:
              - fadd5bb6-b428-45d5-94f8-fd0d89fece6d
              - bccdafd1-3e44-439d-861f-341526b597a9
              ChainIds:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
              - 5fcd1933-22f2-40b9-84da-7db04cbecec2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityDocumentResult'
              example:
                IdentityDocuments:
                - Id: e8a72a69-c20b-4278-b699-ab0400a32ecc
                  CustomerId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d
                  Type: Passport
                  Number: M1234567
                  ExpirationDate: '2040-10-24T00:00:00Z'
                  IssuanceDate: '2024-10-24T00:00:00Z'
                  IssuingCountryCode: CZ
                  IssuingCountrySubdivisionCode:
                  IssuingCity: Prague
                  IdentityDocumentSupportNumber: S-123456
                - Id: cbe8a32e-3eb7-4226-baf4-69455a0eeaf4
                  CustomerId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d
                  Type: IdentityCard
                  Number: ID7654321
                  ExpirationDate: '2040-11-20T00:00:00Z'
                  IssuanceDate: '2024-11-20T00:00:00Z'
                  IssuingCountryCode: CZ
                  IssuingCountrySubdivisionCode:
                  IssuingCity: Brno
                  IdentityDocumentSupportNumber: B-321
                Cursor: cbe8a32e-3eb7-4226-baf4-69455a0eeaf4
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsGetAll400Example:
                  summary: Default identityDocuments_getAll 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsGetAll401Example:
                  summary: Default identityDocuments_getAll 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsGetAll403Example:
                  summary: Default identityDocuments_getAll 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsGetAll408Example:
                  summary: Default identityDocuments_getAll 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsGetAll204Example:
                  summary: Default identityDocuments_getAll 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsGetAll429Example:
                  summary: Default identityDocuments_getAll 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsGetAll500Example:
                  summary: Default identityDocuments_getAll 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/identityDocuments/delete:
    post:
      tags:
      - Identity documents
      summary: Mews Delete Identity Documents
      description: Deletes specified identity documents. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: identityDocuments_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityDocumentDeleteParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              IdentityDocumentIds:
              - e8a72a69-c20b-4278-b699-ab0400a32ecc
              - 2e1c6096-3a28-411d-a375-150a7350b278
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
              examples:
                IdentityDocumentsDelete200Example:
                  summary: Default identityDocuments_delete 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsDelete400Example:
                  summary: Default identityDocuments_delete 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsDelete401Example:
                  summary: Default identityDocuments_delete 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsDelete403Example:
                  summary: Default identityDocuments_delete 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsDelete408Example:
                  summary: Default identityDocuments_delete 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsDelete204Example:
                  summary: Default identityDocuments_delete 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsDelete429Example:
                  summary: Default identityDocuments_delete 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsDelete500Example:
                  summary: Default identityDocuments_delete 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/identityDocuments/clear:
    post:
      tags:
      - Identity documents
      summary: Mews Clear Identity Documents
      description: Deletes all identity documents for the specified customers. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: identityDocuments_clear
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityDocumentClearParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              CustomerIds:
              - fadd5bb6-b428-45d5-94f8-fd0d89fece6d
              - bccdafd1-3e44-439d-861f-341526b597a9
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
              examples:
                IdentityDocumentsClear200Example:
                  summary: Default identityDocuments_clear 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsClear400Example:
                  summary: Default identityDocuments_clear 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsClear401Example:
                  summary: Default identityDocuments_clear 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsClear403Example:
                  summary: Default identityDocuments_clear 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsClear408Example:
                  summary: Default identityDocuments_clear 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsClear204Example:
                  summary: Default identityDocuments_clear 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsClear429Example:
                  summary: Default identityDocuments_clear 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsClear500Example:
                  summary: Default identityDocuments_clear 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/identityDocuments/update:
    post:
      tags:
      - Identity documents
      summary: Mews Update Identity Documents
      description: Updates specified identity documents. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: identityDocuments_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleIdentityDocumentUpdateParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              IdentityDocuments:
              - Id: e8a72a69-c20b-4278-b699-ab0400a32ecc
                Type:
                  Value: Passport
                Number:
                  Value: '123456789'
                ExpirationDate:
                  Value: '2040-11-20T00:00:00Z'
                IssuanceDate:
                  Value: '2020-11-20T00:00:00Z'
                IssuingCountryCode:
                  Value: CZ
                IssuingCity:
                  Value: Prague
                IdentityDocumentSupportNumber:
                  Value: S-123456
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityDocumentWriteResult'
              example:
                IdentityDocuments:
                - Id: e8a72a69-c20b-4278-b699-ab0400a32ecc
                  CustomerId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d
                  Type: Passport
                  Number: M1234567
                  ExpirationDate: '2040-10-24T00:00:00Z'
                  IssuanceDate: '2024-10-24T00:00:00Z'
                  IssuingCountryCode: CZ
                  IssuingCountrySubdivisionCode:
                  IssuingCity: Prague
                  IdentityDocumentSupportNumber: S-123456
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsUpdate400Example:
                  summary: Default identityDocuments_update 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsUpdate401Example:
                  summary: Default identityDocuments_update 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsUpdate403Example:
                  summary: Default identityDocuments_update 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsUpdate408Example:
                  summary: Default identityDocuments_update 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsUpdate204Example:
                  summary: Default identityDocuments_update 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsUpdate429Example:
                  summary: Default identityDocuments_update 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsUpdate500Example:
                  summary: Default identityDocuments_update 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/identityDocuments/add:
    post:
      tags:
      - Identity documents
      summary: Mews Add Identity Documents
      description: Adds identity documents. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: identityDocuments_add
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityDocumentsAddParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              IdentityDocuments:
              - CustomerId: e8a72a69-c20b-4278-b699-ab0400a32ecc
                Type: Passport
                Number: '123456789'
                ExpirationDate: '2040-11-20T00:00:00Z'
                IssuanceDate: '2020-11-20T00:00:00Z'
                IssuingCountryCode: CZ
                IssuingCity: Prague
                IdentityDocumentSupportNumber: S-123456
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityDocumentWriteResult'
              example:
                IdentityDocuments:
                - Id: e8a72a69-c20b-4278-b699-ab0400a32ecc
                  CustomerId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d
                  Type: Passport
                  Number: M1234567
                  ExpirationDate: '2040-10-24T00:00:00Z'
                  IssuanceDate: '2024-10-24T00:00:00Z'
                  IssuingCountryCode: CZ
                  IssuingCountrySubdivisionCode:
                  IssuingCity: Prague
                  IdentityDocumentSupportNumber: S-123456
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsAdd400Example:
                  summary: Default identityDocuments_add 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsAdd401Example:
                  summary: Default identityDocuments_add 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsAdd403Example:
                  summary: Default identityDocuments_add 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsAdd408Example:
                  summary: Default identityDocuments_add 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsAdd204Example:
                  summary: Default identityDocuments_add 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsAdd429Example:
                  summary: Default identityDocuments_add 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                IdentityDocumentsAdd500Example:
                  summary: Default identityDocuments_add 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/loyaltyMemberships/getAll:
    post:
      tags:
      - Loyalty memberships
      summary: Mews Get All Loyalty Memberships
      description: Returns all loyalty memberships of the enterprise, optionally filtered by specific loyalty membership identifiers, activity states, or other filter parameters. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: loyaltyMemberships_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoyaltyMembershipFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainIds:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
              - 5fcd1933-22f2-40b9-84da-7db04cbecec2
              CreatedUtc:
                StartUtc: '2022-10-15T00:00:00Z'
                EndUtc: '2022-10-20T00:00:00Z'
              UpdatedUtc:
                StartUtc: '2022-10-15T00:00:00Z'
                EndUtc: '2022-10-20T00:00:00Z'
              LoyaltyMembershipIds:
              - 905a4489-0960-4ac9-96ec-793f47365c92
              - ac48674e-58a2-43d6-a02b-9ead0b213b17
              AccountIds:
              - fadd5bb6-b428-45d5-94f8-fd0d89fece6d
              - bccdafd1-3e44-439d-861f-341526b597a9
              LoyaltyProgramIds:
              - f701dafb-5765-4cf4-b1dd-1f602a740ae5
              - da34b396-41f7-47f6-8847-aecf00a3f19e
              MembershipStates:
              - Pending
              - Enrolled
              ActivityStates:
              - Active
              MembershipNumbers:
              - MBR-2025-AX49ZT73
              ProviderMembershipIds:
              - PRV-MBR-9842XKLT
              Limitation:
                Count: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoyaltyMembershipResult'
              example:
                LoyaltyMemberships:
                - Id: 905a4489-0960-4ac9-96ec-793f47365c92
                  ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  AccountId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d
                  LoyaltyProgramId: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                  State: New
                  IsPrimary: true
                  ProviderMembershipId: PRV-MBR-9842XKLT
                  Code: MBR-2025-AX49ZT73
                  MembershipNumber: MBR-2025-AX49ZT73
                  Points: 22
                  ExpirationDate: '2029-11-04T13:00:00Z'
                  Url: https://rewards.example.com/member/PRV-MBR-9842XKLT
                  LoyaltyTierId: 69eedfd2-6f25-42fc-b3c8-39df70f85e37
                  CreatorProfile:
                  UpdaterProfile:
                Cursor: 905a4489-0960-4ac9-96ec-793f47365c92
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsGetAll400Example:
                  summary: Default loyaltyMemberships_getAll 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsGetAll401Example:
                  summary: Default loyaltyMemberships_getAll 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsGetAll403Example:
                  summary: Default loyaltyMemberships_getAll 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsGetAll408Example:
                  summary: Default loyaltyMemberships_getAll 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsGetAll204Example:
                  summary: Default loyaltyMemberships_getAll 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsGetAll429Example:
                  summary: Default loyaltyMemberships_getAll 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsGetAll500Example:
                  summary: Default loyaltyMemberships_getAll 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/loyaltyMemberships/add:
    post:
      tags:
      - Loyalty memberships
      summary: Mews Add Loyalty Memberships
      description: Adds loyalty memberships to the enterprise. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: loyaltyMemberships_add
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleLoyaltyMembershipAddParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              LoyaltyMemberships:
              - AccountId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d
                LoyaltyProgramId: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                IsPrimary: true
                State: Enrolled
                MembershipNumber: MBR-2025-AX49ZT73
                Points: 22
                ExpirationDate: '2029-12-24T00:00:00Z'
                Url: https://rewards.example.com/member/PRV-MBR-9842XKLT
                LoyaltyTierId: 69eedfd2-6f25-42fc-b3c8-39df70f85e37
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoyaltyMembershipResult'
              example:
                LoyaltyMemberships:
                - Id: 905a4489-0960-4ac9-96ec-793f47365c92
                  ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  AccountId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d
                  LoyaltyProgramId: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                  State: New
                  IsPrimary: true
                  ProviderMembershipId: PRV-MBR-9842XKLT
                  Code: MBR-2025-AX49ZT73
                  MembershipNumber: MBR-2025-AX49ZT73
                  Points: 22
                  ExpirationDate: '2029-11-04T13:00:00Z'
                  Url: https://rewards.example.com/member/PRV-MBR-9842XKLT
                  LoyaltyTierId: 69eedfd2-6f25-42fc-b3c8-39df70f85e37
                  CreatorProfile:
                  UpdaterProfile:
                Cursor: 905a4489-0960-4ac9-96ec-793f47365c92
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsAdd400Example:
                  summary: Default loyaltyMemberships_add 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsAdd401Example:
                  summary: Default loyaltyMemberships_add 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsAdd403Example:
                  summary: Default loyaltyMemberships_add 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsAdd408Example:
                  summary: Default loyaltyMemberships_add 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsAdd204Example:
                  summary: Default loyaltyMemberships_add 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsAdd429Example:
                  summary: Default loyaltyMemberships_add 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsAdd500Example:
                  summary: Default loyaltyMemberships_add 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/loyaltyMemberships/update:
    post:
      tags:
      - Loyalty memberships
      summary: Mews Update Loyalty Memberships
      description: Updates information about the specified loyalty memberships. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: loyaltyMemberships_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleLoyaltyMembershipUpdateParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              LoyaltyMembershipUpdates:
              - LoyaltyMembershipId: 905a4489-0960-4ac9-96ec-793f47365c92
                LoyaltyProgramId:
                  Value: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                State:
                  Value: Canceled
                IsPrimary:
                  Value: true
                MembershipNumber:
                  Value: MBR-2025-AX49ZT73
                Points:
                  Value: 42
                ExpirationDate:
                  Value: '2038-01-19T03:14:07Z'
                Url:
                  Value: https://final-rewards.example.com/member/PRV-MBR-9842XKLT
                LoyaltyTierId:
                  Value: 69eedfd2-6f25-42fc-b3c8-39df70f85e37
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoyaltyMembershipResult'
              example:
                LoyaltyMemberships:
                - Id: 905a4489-0960-4ac9-96ec-793f47365c92
                  ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  AccountId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d
                  LoyaltyProgramId: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                  State: New
                  IsPrimary: true
                  ProviderMembershipId: PRV-MBR-9842XKLT
                  Code: MBR-2025-AX49ZT73
                  MembershipNumber: MBR-2025-AX49ZT73
                  Points: 22
                  ExpirationDate: '2029-11-04T13:00:00Z'
                  Url: https://rewards.example.com/member/PRV-MBR-9842XKLT
                  LoyaltyTierId: 69eedfd2-6f25-42fc-b3c8-39df70f85e37
                  CreatorProfile:
                  UpdaterProfile:
                Cursor: 905a4489-0960-4ac9-96ec-793f47365c92
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsUpdate400Example:
                  summary: Default loyaltyMemberships_update 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsUpdate401Example:
                  summary: Default loyaltyMemberships_update 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsUpdate403Example:
                  summary: Default loyaltyMemberships_update 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsUpdate408Example:
                  summary: Default loyaltyMemberships_update 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsUpdate204Example:
                  summary: Default loyaltyMemberships_update 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsUpdate429Example:
                  summary: Default loyaltyMemberships_update 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsUpdate500Example:
                  summary: Default loyaltyMemberships_update 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/loyaltyMemberships/delete:
    post:
      tags:
      - Loyalty memberships
      summary: Mews Delete Loyalty Memberships
      description: Deletes loyalty memberships. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: loyaltyMemberships_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoyaltyMembershipDeleteParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              LoyaltyMembershipIds:
              - 905a4489-0960-4ac9-96ec-793f47365c92
              - ac48674e-58a2-43d6-a02b-9ead0b213b17
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
              examples:
                LoyaltyMembershipsDelete200Example:
                  summary: Default loyaltyMemberships_delete 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsDelete400Example:
                  summary: Default loyaltyMemberships_delete 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsDelete401Example:
                  summary: Default loyaltyMemberships_delete 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsDelete403Example:
                  summary: Default loyaltyMemberships_delete 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsDelete408Example:
                  summary: Default loyaltyMemberships_delete 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsDelete204Example:
                  summary: Default loyaltyMemberships_delete 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsDelete429Example:
                  summary: Default loyaltyMemberships_delete 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyMembershipsDelete500Example:
                  summary: Default loyaltyMemberships_delete 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/loyaltyPrograms/getAll:
    post:
      tags:
      - Loyalty programs
      summary: Mews Get All Loyalty Programs
      description: Returns all loyalty programs of the enterprise, optionally filtered by specific loyalty program identifiers, activity states, or other filter parameters. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: loyaltyPrograms_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoyaltyProgramFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainIds:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
              - 5fcd1933-22f2-40b9-84da-7db04cbecec2
              CreatedUtc:
                StartUtc: '2022-10-05T00:00:00Z'
                EndUtc: '2022-10-10T00:00:00Z'
              UpdatedUtc:
                StartUtc: '2022-10-10T00:00:00Z'
                EndUtc: '2022-10-17T00:00:00Z'
              LoyaltyProgramIds:
              - f701dafb-5765-4cf4-b1dd-1f602a740ae5
              - da34b396-41f7-47f6-8847-aecf00a3f19e
              ActivityStates:
              - Active
              Codes:
              - PC01
              - GEC07
              Limitation:
                Count: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoyaltyProgramResult'
              example:
                LoyaltyPrograms:
                - Id: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                  ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  Name: Platinum Club
                  Code: PC01
                  Type: Hotel
                  Subscription: Free
                - Id: da34b396-41f7-47f6-8847-aecf00a3f19e
                  ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  Name: Gold Exclusive Club
                  Code: GEC07
                  Type: ExternalPartner
                  Subscription: Paid
                Cursor: da34b396-41f7-47f6-8847-aecf00a3f19e
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsGetAll400Example:
                  summary: Default loyaltyPrograms_getAll 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsGetAll401Example:
                  summary: Default loyaltyPrograms_getAll 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsGetAll403Example:
                  summary: Default loyaltyPrograms_getAll 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsGetAll408Example:
                  summary: Default loyaltyPrograms_getAll 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsGetAll204Example:
                  summary: Default loyaltyPrograms_getAll 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsGetAll429Example:
                  summary: Default loyaltyPrograms_getAll 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsGetAll500Example:
                  summary: Default loyaltyPrograms_getAll 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/loyaltyPrograms/add:
    post:
      tags:
      - Loyalty programs
      summary: Mews Add Loyalty Programs
      description: Adds loyalty programs to the enterprise. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
      operationId: loyaltyPrograms_add
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleLoyaltyProgramAddParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              LoyaltyPrograms:
              - Name: Platinum Club
                Code: PC01
                Type: Hotel
                Subscription: Free
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoyaltyProgramAdditionResult'
              example:
                LoyaltyPrograms:
                - Id: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                  ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  Name: Platinum Club
                  Code: PC01
                  Type: Hotel
                  Subscription: Free
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsAdd400Example:
                  summary: Default loyaltyPrograms_add 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsAdd401Example:
                  summary: Default loyaltyPrograms_add 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsAdd403Example:
                  summary: Default loyaltyPrograms_add 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsAdd408Example:
                  summary: Default loyaltyPrograms_add 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsAdd204Example:
                  summary: Default loyaltyPrograms_add 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsAdd429Example:
                  summary: Default loyaltyPrograms_add 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsAdd500Example:
                  summary: Default loyaltyPrograms_add 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/loyaltyPrograms/update:
    post:
      tags:
      - Loyalty programs
      summary: Mews Update Loyalty Programs
      description: Updates information about the specified loyalty programs. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
      operationId: loyaltyPrograms_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleLoyaltyProgramUpdateParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              LoyaltyProgramUpdates:
              - LoyaltyProgramId: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                Name:
                  Value: Platinum Club Extra
                Type:
                  Value: Hotel
                Subscription:
                  Value: Free
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoyaltyProgramUpdateResult'
              example:
                LoyaltyPrograms:
                - Id: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                  ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  Name: Platinum Club
                  Code: PC01
                  Type: Hotel
                  Subscription: Free
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsUpdate400Example:
                  summary: Default loyaltyPrograms_update 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsUpdate401Example:
                  summary: Default loyaltyPrograms_update 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsUpdate403Example:
                  summary: Default loyaltyPrograms_update 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsUpdate408Example:
                  summary: Default loyaltyPrograms_update 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsUpdate204Example:
                  summary: Default loyaltyPrograms_update 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsUpdate429Example:
                  summary: Default loyaltyPrograms_update 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsUpdate500Example:
                  summary: Default loyaltyPrograms_update 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/loyaltyPrograms/delete:
    post:
      tags:
      - Loyalty programs
      summary: Mews Delete Loyalty Programs
      description: Deletes loyalty programs. Note that a loyalty program containing active memberships cannot be deleted.
      operationId: loyaltyPrograms_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoyaltyProgramDeleteParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              LoyaltyProgramIds:
              - f701dafb-5765-4cf4-b1dd-1f602a740ae5
              - da34b396-41f7-47f6-8847-aecf00a3f19e
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
              examples:
                LoyaltyProgramsDelete200Example:
                  summary: Default loyaltyPrograms_delete 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsDelete400Example:
                  summary: Default loyaltyPrograms_delete 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsDelete401Example:
                  summary: Default loyaltyPrograms_delete 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsDelete403Example:
                  summary: Default loyaltyPrograms_delete 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsDelete408Example:
                  summary: Default loyaltyPrograms_delete 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsDelete204Example:
                  summary: Default loyaltyPrograms_delete 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsDelete429Example:
                  summary: Default loyaltyPrograms_delete 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyProgramsDelete500Example:
                  summary: Default loyaltyPrograms_delete 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/loyaltyTiers/getAll:
    post:
      tags:
      - Loyalty tiers
      summary: Mews Get All Loyalty Tiers
      description: Returns all loyalty tiers of the chain or chains, filtered by loyalty program identifiers and optionally filtered by specific loyalty tier identifiers, activity states, or other filter parameters. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: loyaltyTiers_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoyaltyTierFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainIds:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
              - 5fcd1933-22f2-40b9-84da-7db04cbecec2
              LoyaltyProgramIds:
              - f701dafb-5765-4cf4-b1dd-1f602a740ae5
              - da34b396-41f7-47f6-8847-aecf00a3f19e
              LoyaltyTierIds:
              - 69eedfd2-6f25-42fc-b3c8-39df70f85e37
              - 3cad97ef-5257-4ced-8599-8e6bbd33331f
              ActivityStates:
              - Active
              UpdatedUtc:
                StartUtc: '2022-10-10T00:00:00Z'
                EndUtc: '2022-10-17T00:00:00Z'
              Limitation:
                Count: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoyaltyTierResult'
              example:
                LoyaltyTiers:
                - Id: 69eedfd2-6f25-42fc-b3c8-39df70f85e37
                  LoyaltyProgramId: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                  Name: Platinum
                  Code: P1
                  Ordering: 1
                - Id: 3cad97ef-5257-4ced-8599-8e6bbd33331f
                  LoyaltyProgramId: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                  Name: Silver
                  Code: S1
                  Ordering: 2
                Cursor: 3cad97ef-5257-4ced-8599-8e6bbd33331f
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersGetAll400Example:
                  summary: Default loyaltyTiers_getAll 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersGetAll401Example:
                  summary: Default loyaltyTiers_getAll 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersGetAll403Example:
                  summary: Default loyaltyTiers_getAll 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersGetAll408Example:
                  summary: Default loyaltyTiers_getAll 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersGetAll204Example:
                  summary: Default loyaltyTiers_getAll 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersGetAll429Example:
                  summary: Default loyaltyTiers_getAll 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersGetAll500Example:
                  summary: Default loyaltyTiers_getAll 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/loyaltyTiers/add:
    post:
      tags:
      - Loyalty tiers
      summary: Mews Add Loyalty Tiers
      description: Adds loyalty tiers to a loyalty program of the enterprise chain. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: loyaltyTiers_add
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleLoyaltyTierAddParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              LoyaltyTiers:
              - LoyaltyProgramId: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                Name: Platinum
                Code: P1
                Ordering: 1
              ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoyaltyTierWriteResult'
              example:
                LoyaltyTiers:
                - Id: 69eedfd2-6f25-42fc-b3c8-39df70f85e37
                  LoyaltyProgramId: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                  Name: Platinum
                  Code: P1
                  Ordering: 1
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersAdd400Example:
                  summary: Default loyaltyTiers_add 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersAdd401Example:
                  summary: Default loyaltyTiers_add 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersAdd403Example:
                  summary: Default loyaltyTiers_add 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersAdd408Example:
                  summary: Default loyaltyTiers_add 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersAdd204Example:
                  summary: Default loyaltyTiers_add 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersAdd429Example:
                  summary: Default loyaltyTiers_add 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersAdd500Example:
                  summary: Default loyaltyTiers_add 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/loyaltyTiers/update:
    post:
      tags:
      - Loyalty tiers
      summary: Mews Update Loyalty Tiers
      description: Updates information about the specified loyalty tiers.
      operationId: loyaltyTiers_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleLoyaltyTierUpdateParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              LoyaltyTierUpdates:
              - LoyaltyTierId: 69eedfd2-6f25-42fc-b3c8-39df70f85e37
                Name:
                  Value: Platinum
                Code:
                  Value: P1
                Ordering:
                  Value: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoyaltyTierWriteResult'
              example:
                LoyaltyTiers:
                - Id: 69eedfd2-6f25-42fc-b3c8-39df70f85e37
                  LoyaltyProgramId: f701dafb-5765-4cf4-b1dd-1f602a740ae5
                  Name: Platinum
                  Code: P1
                  Ordering: 1
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersUpdate400Example:
                  summary: Default loyaltyTiers_update 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersUpdate401Example:
                  summary: Default loyaltyTiers_update 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersUpdate403Example:
                  summary: Default loyaltyTiers_update 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersUpdate408Example:
                  summary: Default loyaltyTiers_update 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersUpdate204Example:
                  summary: Default loyaltyTiers_update 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersUpdate429Example:
                  summary: Default loyaltyTiers_update 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersUpdate500Example:
                  summary: Default loyaltyTiers_update 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
  /api/connector/v1/loyaltyTiers/delete:
    post:
      tags:
      - Loyalty tiers
      summary: Mews Delete Loyalty Tiers
      description: Deletes loyalty tiers.
      operationId: loyaltyTiers_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoyaltyTierDeleteParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              LoyaltyTierIds:
              - 69eedfd2-6f25-42fc-b3c8-39df70f85e37
              - 3cad97ef-5257-4ced-8599-8e6bbd33331f
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
              examples:
                LoyaltyTiersDelete200Example:
                  summary: Default loyaltyTiers_delete 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersDelete400Example:
                  summary: Default loyaltyTiers_delete 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersDelete401Example:
                  summary: Default loyaltyTiers_delete 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersDelete403Example:
                  summary: Default loyaltyTiers_delete 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersDelete408Example:
                  summary: Default loyaltyTiers_delete 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersDelete204Example:
                  summary: Default loyaltyTiers_delete 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersDelete429Example:
                  summary: Default loyaltyTiers_delete 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                LoyaltyTiersDelete500Example:
                  summary: Default loyaltyTiers_delete 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation: *id001
components:
  schemas:
    LoyaltyProgramDeleteParameters:
      title: LoyaltyProgramDeleteParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - LoyaltyProgramIds
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        LoyaltyProgramIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifier of the loyalty programs to be deleted.
      additionalProperties: false
      x-schema-id: LoyaltyProgramDeleteParameters
    CustomerRelationshipTypeEnum:
      title: Customer relationship type
      enum:
      - Spouse
      - Child
      - Parent
      - OtherFamily
      - Friend
      - Colleague
      - Other
      type: string
      description: '


        Spouse


        Child


        Parent


        OtherFamily (Any familial relationship that doesn''t fit for the options provided)


        Friend


        Colleague


        Other'
      x-enumNames:
      - Spouse
      - Child
      - Parent
      - OtherFamily
      - Friend
      - Colleague
      - Other
      x-enumDescriptions:
      - ''
      - ''
      - ''
      - Any familial relationship that doesn't fit for the options provided
      - ''
      - ''
      - ''
      x-extensible: true
    PaymentItemOld:
      title: Payment item
      required:
      - AccountId
      - AccountingState
      - Amount
      - ConsumedUtc
      - Data
      - Id
      - OriginalAmount
      - State
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the item.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountId:
          type: string
          description: Unique identifier of the account (for example `Customer`) the item belongs to.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        BillId:
          type: string
          description: Unique identifier of the `Bill` the item is assigned to.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountingCategoryId:
          type: string
          description: Unique identifier of the `AccountingCategory` the item belongs to.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Amount:
          title: Extended amount
          allOf:
          - $ref: '#/components/schemas/ExtendedAmount'
          description: Item's amount, negative amount represents either rebate or a payment.
          example: string
        OriginalAmount:
          title: Extended amount
          allOf:
          - $ref: '#/components/schemas/ExtendedAmount'
          description: Amount of item; note a negative amount represents a rebate or payment. Contains the earliest known value in conversion chain.
          example: string
        AmountDefault:
          title: Extended amount
          allOf:
          - $ref: '#/components/schemas/ExtendedAmount'
          description: Item's amount in property's default currency, negative amount represents either rebate or a payment.
          nullable: true
          deprecated: true
          example: string
        Notes:
          type: string
          description: Additional notes.
          nullable: true
          example: string
        SettlementId:
          type: string
          description: Identifier of the settled payment from the external system (ApplePay/GooglePay).
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ConsumedUtc:
          minLength: 1
          type: string
          description: Date and time of the item consumption in UTC timezone in ISO 8601 format.
          example: string
        ClosedUtc:
          type: string
          description: Date and time of the item bill closure in UTC timezone in ISO 8601 format.
          nullable: true
          example: string
        AccountingState:
          minLength: 1
          type: string
          description: Accounting state of the item.
          example: string
        State:
          minLength: 1
          type: string
          description: Payment state of the item.
          example: string
        Identifier:
          type: string
          description: External payment identifier.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Data:
          title: Payment item data
          type: object
          properties:
            Discriminator:
              $ref: '#/components/schemas/PaymentType'
            Value:
              oneOf:
              - $ref: '#/components/schemas/PaymentCardPaymentData'
              - $ref: '#/components/schemas/InvoicePaymentData'
              description: Based on payment item data discriminator or `null` for types without any additional data.
              nullable: true
          description: Additional data specific to particular payment item.
          x-coproduct: true
          x-schema-id: PaymentItemOldDataCoproductOfPaymentType
      additionalProperties: false
      description: ''
      x-schema-id: PaymentItemOld
    MultipleLoyaltyTierAddParameters:
      title: MultipleLoyaltyTierAddParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - LoyaltyTiers
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        LoyaltyTiers:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyTierAddParameters'
          description: Loyalty tiers to be added.
      additionalProperties: false
      x-schema-id: MultipleLoyaltyTierAddParameters
    ServiceOrderStateOld:
      title: Service order state (ver 2017-04-12)
      enum:
      - Enquired
      - Confirmed
      - Started
      - Processed
      - Canceled
      - Optional
      - Requested
      type: string
    LoyaltyTierResult:
      title: LoyaltyTierResult
      required:
      - LoyaltyTiers
      type: object
      properties:
        LoyaltyTiers:
          maxItems: 1000
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyTier'
          description: The loyalty tiers of the loyalty program within the chain.
        Cursor:
          type: string
          description: Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: LoyaltyTierResult
    MultipleAddressUpdateParameters:
      title: MultipleAddressUpdateParameters
      required:
      - AccessToken
      - AddressUpdates
      - Client
      - ClientToken
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AddressUpdates:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/AddressUpdateParameters'
          description: Collection of addresses to be updated.
      additionalProperties: false
      x-schema-id: MultipleAddressUpdateParameters
    LoyaltyMembershipUpdateParameters:
      title: Loyalty membership update parameters
      required:
      - LoyaltyMembershipId
      type: object
      properties:
        LoyaltyMembershipId:
          type: string
          description: Unique identifier of the loyalty membership.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        LoyaltyProgramId:
          title: Guid update value
          allOf:
          - $ref: '#/components/schemas/GuidUpdateValue'
          description: Unique identifier of the loyalty program (or `null` if the program should not be updated).
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        State:
          title: Loyalty membership state update value
          allOf:
          - $ref: '#/components/schemas/LoyaltyMembershipStateUpdateValue'
          description: State of the loyalty membership, (or `null` if the state should not be updated).
          nullable: true
          example: string
        IsPrimary:
          title: Boolean update value
          allOf:
          - $ref: '#/components/schemas/BooleanUpdateValue'
          description: Boolean value defining the primary loyalty membership for the account (or `null` if the value should not be updated).
          nullable: true
          example: string
        Code:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Code of the loyalty membership. (or `null` if the code should not be updated).
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use `MembershipNumber` instead.
          example: string
        MembershipNumber:
          title: String update value
          maxLength: 255
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Customer-facing membership numbers, e.g., printed on a loyalty card.
          nullable: true
          example: '1001'
        ProviderMembershipId:
          title: String update value
          maxLength: 100
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Loyalty membership identifier assigned by the external loyalty provider's system (or `null` if the value should not be updated).
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Points:
          title: Int32 update value
          allOf:
          - $ref: '#/components/schemas/Int32NullableUpdateValue'
          description: The loyalty points the account has in the loyalty membership (or `null` if the points should not be updated).
          nullable: true
          example: string
        ExpirationDate:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Expiration date of the loyalty membership in UTC timezone in ISO 8601 format (or `null` if the date should not be updated).
          format: date
          nullable: true
          example: '2026-06-02'
        Url:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: URL of the loyalty membership (or `null` if the URL should not be updated).
          format: uri
          nullable: true
          example: https://api.mews.com/api/connector/v1
        LoyaltyTierId:
          title: Guid update value
          allOf:
          - $ref: '#/components/schemas/GuidNullableUpdateValue'
          description: Unique identifier of the loyalty tier (or `null` if the tier should not be updated).
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: LoyaltyMembershipUpdateParameters
    IdentityDocument:
      title: Identity document
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the document.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CustomerId:
          type: string
          description: Identifier of the `Customer`.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Type:
          title: Document type
          allOf:
          - $ref: '#/components/schemas/IdentityDocumentTypeEnum'
          description: 'Type of the document.


            IdentityCard


            Passport


            Visa


            DriversLicense'
          x-enumNames:
          - IdentityCard
          - Passport
          - Visa
          - DriversLicense
          x-enumDescriptions:
          - ''
          - ''
          - ''
          - ''
          example: string
        Number:
          type: string
          description: Number of the document (e.g. passport number).
          nullable: true
          example: '1001'
        Expiration:
          type: string
          description: Expiration date in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        Issuance:
          type: string
          description: Date of issuance in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        IssuingCountryCode:
          type: string
          description: ISO 3166-1 code of the `Country`.
          nullable: true
          example: string
        IssuingCountrySubdivisionCode:
          type: string
          description: Identifier of the country subdivision where the document was issued (province, state or region).
          nullable: true
          example: string
        IssuingCity:
          type: string
          description: City where the document was issued.
          nullable: true
          example: string
        IdentityDocumentSupportNumber:
          type: string
          description: Identity document support number. Only required for Spanish identity cards in Spanish hotels.
          nullable: true
          example: '1001'
      additionalProperties: false
      x-schema-id: IdentityDocument
    LoyaltyTier:
      title: Loyalty tier
      required:
      - Code
      - Id
      - LoyaltyProgramId
      - Name
      - Ordering
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the loyalty tier.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        LoyaltyProgramId:
          type: string
          description: Unique identifier of the loyalty program of that loyalty tier.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Name:
          maxLength: 50
          minLength: 1
          type: string
          description: Name of the loyalty tier.
          example: Example Name
        Code:
          maxLength: 50
          minLength: 1
          type: string
          description: Code of the loyalty tier.
          example: string
        Ordering:
          type: integer
          description: Ordering of the loyalty tier.
          format: int32
          example: 1
      additionalProperties: false
      x-schema-id: LoyaltyTier
    CustomerAddFileResult:
      title: CustomerAddFileResult
      required:
      - FileId
      type: object
      properties:
        FileId:
          type: string
          description: Unique identifier of the uploaded file.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: CustomerAddFileResult
    ProductOrderItemData:
      title: Product order item data
      required:
      - ProductId
      type: object
      properties:
        ProductId:
          type: string
          description: Unique identifier of the `Product`.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AgeCategoryId:
          type: string
          description: Unique identifier of the `AgeCategory`.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: ProductOrderItemData
    TravelAgencyContractOptions:
      title: Travel agency contract options
      required:
      - IncludeCancellationFeeInCommissionEstimate
      - SkipAutomaticSettlement
      type: object
      properties:
        IncludeCancellationFeeInCommissionEstimate:
          type: boolean
          description: Cancellation fee will be considered when calculating the travel agency commission estimate.
          example: true
        SkipAutomaticSettlement:
          type: boolean
          description: Reservations from travel agencies will not be automatically charged.
          example: true
      additionalProperties: false
      description: ''
      x-schema-id: TravelAgencyContractOptions
    CustomerRelationshipFilterParameters:
      title: CustomerRelationshipFilterParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - CustomerIds
      - Limitation
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        Limitation:
          allOf:
          - $ref: '#/components/schemas/Limitation'
          description: Limitation on the quantity of data returned and optional Cursor for the starting point of data.
          example: string
        ChainIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Chain`. If not specified, the operation returns data for all chains within scope of the Access Token.
          nullable: true
        CustomerIds:
          maxItems: 100
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Customer`.
      additionalProperties: false
      x-schema-id: CustomerRelationshipFilterParameters
    CustomerExtent:
      title: Customer extent
      type: object
      properties:
        Customers:
          type: boolean
          description: Whether the response should contain information about customers.
          nullable: true
          example: true
        Documents:
          type: boolean
          description: Whether the response should contain identity documents of customers.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) instead.
          example: true
        Addresses:
          type: boolean
          description: Whether the response should contain addresses of customers.
          nullable: true
          example: true
      additionalProperties: false
      description: ''
      x-schema-id: CustomerExtent
    IdentityDocumentTypeEnum:
      title: Document type
      enum:
      - IdentityCard
      - Passport
      - Visa
      - DriversLicense
      type: string
      description: '


        IdentityCard


        Passport


        Visa


        DriversLicense'
      x-enumNames:
      - IdentityCard
      - Passport
      - Visa
      - DriversLicense
      x-enumDescriptions:
      - ''
      - ''
      - ''
      - ''
    SexEnum:
      title: Sex
      enum:
      - Male
      - Female
      type: string
      description: '


        Male


        Female'
      x-enumNames:
      - Male
      - Female
      x-enumDescriptions:
      - ''
      - ''
    EnterpriseProfileData:
      title: Enterprise profile data
      required:
      - ProfileId
      type: object
      properties:
        ProfileId:
          type: string
          description: Unique identifier of the profile.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: EnterpriseProfileData
    MultipleIdentityDocumentUpdateParameters:
      title: Multiple identity document update parameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - IdentityDocuments
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        IdentityDocuments:
          maxItems: 10
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/IdentityDocumentUpdateParameters'
          description: Identity documents to be updated.
      additionalProperties: false
      x-schema-id: MultipleIdentityDocumentUpdateParameters
    MultipleLoyaltyProgramAddParameters:
      title: MultipleLoyaltyProgramAddParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - LoyaltyPrograms
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        LoyaltyPrograms:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyProgramAddParameters'
          description: Loyalty programs to be added.
      additionalProperties: false
      x-schema-id: MultipleLoyaltyProgramAddParameters
    LoyaltyProgramUpdateResult:
      title: LoyaltyProgramUpdateResult
      required:
      - LoyaltyPrograms
      type: object
      properties:
        LoyaltyPrograms:
          maxItems: 1000
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyProgram'
          description: Updated loyalty programs.
      additionalProperties: false
      x-schema-id: LoyaltyProgramUpdateResult
    StringUpdateValue:
      title: String update value
      type: object
      properties:
        Value:
          type: string
          description: Value which is to be updated.
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: StringUpdateValue
    CustomerRelationship:
      title: CustomerRelationship
      required:
      - CustomerId
      - RelatedCustomerId
      - Relationship
      type: object
      properties:
        CustomerId:
          type: string
          description: Unique identifier of the customer in the relationship.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        RelatedCustomerId:
          type: string
          description: Unique identifier of the related customer.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Relationship:
          title: Customer relationship type
          allOf:
          - $ref: '#/components/schemas/CustomerRelationshipTypeEnum'
          description: 'Type of relationship between the two customers (e.g. Child = the related customer is the child of this customer).


            Spouse


            Child


            Parent


            OtherFamily (Any familial relationship that doesn''t fit for the options provided)


            Friend


            Colleague


            Other'
          x-enumNames:
          - Spouse
          - Child
          - Parent
          - OtherFamily
          - Friend
          - Colleague
          - Other
          x-enumDescriptions:
          - ''
          - ''
          - ''
          - Any familial relationship that doesn't fit for the options provided
          - ''
          - ''
          - ''
          x-extensible: true
          example: string
      additionalProperties: false
      x-schema-id: CustomerRelationship
    GuidNullableUpdateValue:
      title: Guid update value
      type: object
      properties:
        Value:
          type: string
          description: Value which is to be updated.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: GuidNullableUpdateValue
    CompanyAddParameters:
      title: CompanyAddParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - Name
      - Options
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Name:
          minLength: 1
          type: string
          description: Name of the company.
          example: Example Name
        MotherCompanyId:
          type: string
          description: Unique identifier of the mother company.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        InvoicingEmail:
          type: string
          description: Email for issuing invoices to the company.
          format: email
          nullable: true
          example: partner@example.com
        WebsiteUrl:
          type: string
          description: The website url of the company.
          format: uri
          nullable: true
          example: https://api.mews.com/api/connector/v1
        InvoiceDueInterval:
          type: string
          description: The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
          nullable: true
          example: string
        Options:
          title: Company Options Parameters
          allOf:
          - $ref: '#/components/schemas/CompanyOptionsParameters'
          description: Options of the company.
          example: string
        CreditRating:
          title: Credit rating parameters
          allOf:
          - $ref: '#/components/schemas/CreditRatingParameters'
          description: Credit rating to define creditworthiness of the company.
          nullable: true
          example: string
        Department:
          type: string
          description: The internal segmentation of a company, e.g. sales department.
          nullable: true
          example: string
        DunsNumber:
          type: string
          description: The Dun & Bradstreet unique 9-digit DUNS number.
          nullable: true
          example: '1001'
        ReferenceIdentifier:
          type: string
          description: External system identifier - custom identifier used by an external system such as an external database.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountingCode:
          type: string
          description: Accounting code of the company.
          nullable: true
          example: string
        AdditionalTaxIdentifier:
          type: string
          description: Additional tax identifer of the company.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        BillingCode:
          type: string
          description: Billing code of the company.
          nullable: true
          example: string
        Contact:
          type: string
          description: Other contact details, such as telephone, email or similar.
          nullable: true
          example: string
        ContactPerson:
          type: string
          description: Contact person of the company.
          nullable: true
          example: string
        Identifier:
          type: string
          description: Fiscal or legal identifier of the company.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Iata:
          type: string
          description: Iata of the company.
          nullable: true
          example: string
        Notes:
          type: string
          description: Notes of the company.
          nullable: true
          example: string
        TaxIdentifier:
          type: string
          description: Tax identification number of the company.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Telephone:
          type: string
          description: Contact telephone number.
          format: tel
          nullable: true
          example: string
        Address:
          title: Address parameters
          allOf:
          - $ref: '#/components/schemas/AddressParameters'
          description: New address details.
          nullable: true
          example: string
        ExternalIdentifier:
          maxLength: 255
          type: string
          description: Identifier of the company from external system.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: CompanyAddParameters
    GuidUpdateValue:
      title: Guid update value
      type: object
      properties:
        Value:
          type: string
          description: Value which is to be updated.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: GuidUpdateValue
    IdentityDocumentsAddData:
      title: Identity document parameters
      required:
      - CustomerId
      - Number
      - Type
      type: object
      properties:
        CustomerId:
          type: string
          description: Identifier of the `Customer`.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Type:
          title: Document type
          allOf:
          - $ref: '#/components/schemas/IdentityDocumentTypeEnum'
          description: 'Type of the document.


            IdentityCard


            Passport


            Visa


            DriversLicense'
          x-enumNames:
          - IdentityCard
          - Passport
          - Visa
          - DriversLicense
          x-enumDescriptions:
          - ''
          - ''
          - ''
          - ''
          example: string
        Number:
          minLength: 1
          type: string
          description: Number of the document (e.g. passport number). If the number is not collected in certain regions, such as The Netherlands, use an empty string. In all other cases, a value should be supplied.
          example: '1001'
        ExpirationDate:
          type: string
          description: Expiration date in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        IssuanceDate:
          type: string
          description: Date of issuance in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        IssuingCountryCode:
          type: string
          description: ISO 3166-1 code of the `Country`).
          nullable: true
          example: string
        IssuingCountrySubdivisionCode:
          type: string
          description: Identifier of the country subdivision where the document was issued (province, state or region).
          nullable: true
          example: string
        IssuingCity:
          type: string
          description: City where the document was issued.
          nullable: true
          example: string
        IdentityDocumentSupportNumber:
          type: string
          description: Identity document support number. Only required for Spanish identity cards in Spanish hotels.
          nullable: true
          example: '1001'
      additionalProperties: false
      x-schema-id: IdentityDocumentsAddData
    RebateOrderItemData:
      title: Rebate order item data
      required:
      - RebatedItemId
      type: object
      properties:
        RebatedItemId:
          type: string
          description: Unique identifier of `OrderItem` which has been rebated by current item.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: RebateOrderItemData
    ReservationGroupOld:
      title: Reservation groups (ver 2017-04-12)
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the reservation group.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Name:
          type: string
          description: Name of the reservation group.
          nullable: true
          example: Example Name
      additionalProperties: false
      x-schema-id: ReservationGroupOld
    IdentityDocumentWriteResult:
      title: IdentityDocumentWriteResult
      required:
      - IdentityDocuments
      type: object
      properties:
        IdentityDocuments:
          maxItems: 10
          type: array
          items:
            $ref: '#/components/schemas/IdentityDocumentV20241025'
          description: Modified identity documents.
      additionalProperties: false
      x-schema-id: IdentityDocumentWriteResult
    Sex:
      title: Sex
      enum:
      - Male
      - Female
      type: string
    Customer:
      title: Customer
      required:
      - ChainId
      - Classifications
      - CreatedUtc
      - CreatorProfileId
      - Id
      - IsActive
      - LastName
      - Number
      - Options
      - PreferredSpaceFeatures
      - UpdatedUtc
      - UpdaterProfileId
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the customer.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ChainId:
          type: string
          description: Unique identifier of the chain.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Number:
          maxLength: 19
          minLength: 1
          type: string
          description: Unique number of the customer (max 19 digits).
          example: '1001'
        Title:
          allOf:
          - $ref: '#/components/schemas/Title'
          description: 'Title of the customer.


            Mister (Mr.)


            Miss (Ms.)


            Misses (Mrs.)'
          nullable: true
          example: string
        Sex:
          allOf:
          - $ref: '#/components/schemas/SexEnum'
          description: 'Sex of the customer.


            Male


            Female'
          nullable: true
          example: string
        FirstName:
          type: string
          description: First name of the customer.
          nullable: true
          example: Example Name
        LastName:
          minLength: 1
          type: string
          description: Last name of the customer.
          example: Example Name
        SecondLastName:
          type: string
          description: Second last name of the customer.
          nullable: true
          example: Example Name
        NationalityCode:
          type: string
          description: ISO 3166-1 code of the [Country](https://mews-systems.gitbook.io/connector-api/operations/countries/#country).
          nullable: true
          example: string
        PreferredLanguageCode:
          type: string
          description: 'Language and culture code of the customer''s preferred language, according to their profile. For example: `en-GB`, `fr-CA`.'
          nullable: true
          example: string
        LanguageCode:
          type: string
          description: Language and culture code of the customer's language, based on multiple sources. These sources include the preferred language specified in internal data based on previous bookings, and the preferred language of the customer specified in their profile. If neither of these sources are present, we use the native language based on the customer's nationality. The format is, for example, `en-US` or `fr-FR`.
          nullable: true
          example: string
        BirthDate:
          type: string
          description: Date of birth in ISO 8601 format.
          nullable: true
          example: string
        BirthCountryCode:
          type: string
          description: ISO 3166-1 alpha-2 code of the birth country.
          nullable: true
          example: string
        BirthCountrySubdivisionCode:
          type: string
          description: ISO 3166-2 code of the administrative division, e.g. ES-C.
          nullable: true
          example: string
        BirthPlace:
          type: string
          description: Place of birth.
          nullable: true
          example: string
        Occupation:
          type: string
          description: Occupation of the customer.
          nullable: true
          example: string
        Email:
          type: string
          description: Email address of the customer.
          nullable: true
          example: partner@example.com
        HasOtaEmail:
          type: boolean
          description: Whether the customer's email address is a temporary email address from an OTA. For more details, see the [product documentation](https://help.mews.com/s/article/how-to-maintain-ota-guest-profiles-with-verified-email-addresses-obtained-from-the-guest-portal).
          example: true
        Phone:
          type: string
          description: Phone number of the customer (possibly mobile).
          nullable: true
          example: string
        TaxIdentificationNumber:
          type: string
          description: Tax identification number of the customer.
          nullable: true
          example: '1001'
        LoyaltyCode:
          type: string
          description: Loyalty code of the customer.
          nullable: true
          example: string
        AccountingCode:
          type: string
          description: Accounting code of the customer.
          nullable: true
          example: string
        BillingCode:
          type: string
          description: Billing code of the customer.
          nullable: true
          example: string
        Notes:
          type: string
          description: Internal notes about the customer.
          nullable: true
          example: string
        CarRegistrationNumber:
          maxLength: 255
          type: string
          description: Registration number of the customer's car.
          nullable: true
          example: '1001'
        DietaryRequirements:
          maxLength: 255
          type: string
          description: Customer's dietary requirements, e.g. Vegan, Halal.
          nullable: true
          example: string
        CreatedUtc:
          minLength: 1
          type: string
          description: Creation date and time of the customer in UTC timezone in ISO 8601 format.
          format: date-time
          example: '2026-06-02T14:30:00Z'
        UpdatedUtc:
          minLength: 1
          type: string
          description: Last update date and time of the customer in UTC timezone in ISO 8601 format.
          format: date-time
          example: '2026-06-02T14:30:00Z'
        Passport:
          title: Identity document
          allOf:
          - $ref: '#/components/schemas/IdentityDocument'
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents.
          example: string
        IdentityCard:
          title: Identity document
          allOf:
          - $ref: '#/components/schemas/IdentityDocument'
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents.
          example: string
        Visa:
          title: Identity document
          allOf:
          - $ref: '#/components/schemas/IdentityDocument'
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents.
          example: string
        DriversLicense:
          title: Identity document
          allOf:
          - $ref: '#/components/schemas/IdentityDocument'
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents.
          example: string
        Address:
          title: Address
          allOf:
          - $ref: '#/components/schemas/OldAddress'
          description: ''
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use `AddressId` instead.
          example: string
        AddressId:
          type: string
          description: Unique identifier of the `Address` of the customer.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Classifications:
          type: array
          items:
            $ref: '#/components/schemas/CustomerClassificationEnum'
          description: Classifications of the customer.
        Options:
          type: array
          items:
            $ref: '#/components/schemas/CustomerOptionsEnum'
          description: Options of the customer.
        ItalianDestinationCode:
          type: string
          description: Value of Italian destination code.
          nullable: true
          example: string
        ItalianFiscalCode:
          type: string
          description: Value of Italian fiscal code.
          nullable: true
          example: string
        ItalianLotteryCode:
          type: string
          description: Italian lottery code.
          nullable: true
          example: string
        CompanyId:
          type: string
          description: Unique identifier of [Company](https://mews-systems.gitbook.io/connector-api/operations/companies/#company) the customer is associated with.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        MergeTargetId:
          type: string
          description: Unique identifier of the account ([Customer](https://mews-systems.gitbook.io/connector-api/operations/#customer)) to which this customer is linked.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ActivityState:
          type: string
          description: '[Activity State](https://mews-systems.gitbook.io/connector-api/operations/#activity-state) of customer record, i.e. whether active or deleted.'
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use `IsActive` instead.
          example: string
        IsActive:
          type: boolean
          description: Whether the customer record is still active.
          example: true
        PreferredSpaceFeatures:
          type: array
          items:
            $ref: '#/components/schemas/ResourceFeatureClassification'
          description: A list of room preferences, such as view type, bed type, and amenities.
        CreatorProfileId:
          type: string
          description: Unique identifier of the user who created the customer.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        UpdaterProfileId:
          type: string
          description: Unique identifier of the user who last updated the customer.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: Customer
    Amount:
      title: Amount
      required:
      - Breakdown
      - Currency
      - GrossValue
      - NetValue
      - TaxValues
      type: object
      properties:
        Currency:
          minLength: 1
          type: string
          description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency).
          format: currency
          example: EUR
        NetValue:
          type: number
          description: Net value without taxes.
          format: double
          example: 100.0
        GrossValue:
          type: number
          description: Gross value including all taxes.
          format: double
          example: 100.0
        TaxValues:
          type: array
          items:
            $ref: '#/components/schemas/TaxValue'
          description: The tax values applied.
        Breakdown:
          title: Tax breakdown
          allOf:
          - $ref: '#/components/schemas/TaxBreakdown'
          description: Information about individual tax amounts.
          example: string
      additionalProperties: false
      description: ''
      x-schema-id: Amount
    AddressAddParameters:
      title: Account address parameters
      required:
      - AccountId
      type: object
      properties:
        AccountId:
          type: string
          description: Unique identifier of a Company or a Customer within the enterprise.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Line1:
          maxLength: 255
          type: string
          description: First line of the address.
          nullable: true
          example: string
        Line2:
          maxLength: 255
          type: string
          description: Second line of the address.
          nullable: true
          example: string
        City:
          maxLength: 255
          type: string
          description: The city.
          nullable: true
          example: string
        PostalCode:
          maxLength: 255
          type: string
          description: Postal code.
          format: postal-code
          nullable: true
          example: string
        CountryCode:
          type: string
          description: ISO 3166-1 alpha-2 code of the Country.
          nullable: true
          example: string
        CountrySubdivisionCode:
          type: string
          description: ISO 3166-2 code of the administrative division, e.g. `DE-BW`.
          nullable: true
          example: string
        Latitude:
          maximum: 90
          minimum: -90
          type: number
          description: The latitude in range of -90 to 90.
          format: double
          nullable: true
          example: 100.0
        Longitude:
          maximum: 180
          minimum: -180
          type: number
          description: The longitude in range of -180 to 180.
          format: double
          nullable: true
          example: 100.0
      additionalProperties: false
      x-schema-id: AddressAddParameters
    Title:
      title: Title
      enum:
      - Mister
      - Miss
      - Misses
      type: string
      description: "Type of the title prefix of the customer.\r\n\r\nNote that the value should not be used as-is, but localized. For example, the value `Misses` should be displayed as `Mrs.` in English and `Fr.` in German.\n\nMister (Mr.)\n\nMiss (Ms.)\n\nMisses (Mrs.)"
      x-enumNames:
      - Mister
      - Miss
      - Misses
      x-enumDescriptions:
      - Mr.
      - Ms.
      - Mrs.
      x-schema-id: Title
      x-showDescription: true
    MultipleLoyaltyMembershipUpdateParameters:
      title: MultipleLoyaltyMembershipUpdateParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - LoyaltyMembershipUpdates
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        LoyaltyMembershipUpdates:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyMembershipUpdateParameters'
          description: Loyalty memberships to be updated.
      additionalProperties: false
      x-schema-id: MultipleLoyaltyMembershipUpdateParameters
    LoyaltyProgramResult:
      title: LoyaltyProgramResult
      required:
      - LoyaltyPrograms
      type: object
      properties:
        LoyaltyPrograms:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyProgram'
          description: The loyalty programs of the enterprise.
        Cursor:
          type: string
          description: Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: LoyaltyProgramResult
    CustomerClassificationEnum:
      title: Customer classification
      enum:
      - PaymasterAccount
      - Blacklist
      - Media
      - LoyaltyProgram
      - PreviousComplaint
      - Returning
      - Staff
      - FriendOrFamily
      - TopManagement
      - Important
      - VeryImportant
      - Problematic
      - Cashlist
      - DisabledPerson
      - Military
      - Airline
      - HealthCompliant
      - InRoom
      - WaitingForRoom
      - Student
      - Blocklist
      type: string
      description: '


        PaymasterAccount


        Blacklist (Deprecated, use Blocklist instead.)


        Media


        LoyaltyProgram


        PreviousComplaint


        Returning


        Staff


        FriendOrFamily


        TopManagement


        Important


        VeryImportant


        Problematic


        Cashlist


        DisabledPerson


        Military


        Airline


        HealthCompliant


        InRoom


        WaitingForRoom


        Student


        Blocklist'
      x-enumNames:
      - PaymasterAccount
      - Blacklist
      - Media
      - LoyaltyProgram
      - PreviousComplaint
      - Returning
      - Staff
      - FriendOrFamily
      - TopManagement
      - Important
      - VeryImportant
      - Problematic
      - Cashlist
      - DisabledPerson
      - Military
      - Airline
      - HealthCompliant
      - InRoom
      - WaitingForRoom
      - Student
      - Blocklist
      x-enumDescriptions:
      - ''
      - Deprecated, use Blocklist instead.
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
    CompanionshipResult:
      title: CompanionshipResult
      type: object
      properties:
        Companionships:
          type: array
          items:
            $ref: '#/components/schemas/Companionship'
          description: Companionships.
          nullable: true
        Reservations:
          type: array
          items:
            $ref: '#/components/schemas/ReservationOld'
          description: The accompanied reservations.
          nullable: true
        ReservationGroups:
          type: array
          items:
            $ref: '#/components/schemas/ReservationGroupOld'
          description: The accompanied reservation groups.
          nullable: true
        Customers:
          type: array
          items:
            $ref: '#/components/schemas/Customer'
          description: Customers that belong to the companionships.
          nullable: true
        Cursor:
          type: string
          description: Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: CompanionshipResult
    BooleanNullableUpdateValue:
      title: Boolean update value
      type: object
      properties:
        Value:
          type: boolean
          description: Value which is to be updated.
          nullable: true
          example: true
      additionalProperties: false
      x-schema-id: BooleanNullableUpdateValue
    ContractAdditionResult:
      title: ContractAdditionResult
      required:
      - TravelAgencyContracts
      type: object
      properties:
        TravelAgencyContracts:
          type: array
          items:
            $ref: '#/components/schemas/TravelAgencyContract'
          description: The added travel agency contracts.
      additionalProperties: false
      x-schema-id: ContractAdditionResult
    CompanyFilterParameters:
      title: CompanyFilterParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - Limitation
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        Limitation:
          allOf:
          - $ref: '#/components/schemas/Limitation'
          description: Limitation on the quantity of data returned and optional Cursor for the starting point of data.
          example: string
        ChainIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Chain`. If not specified, the operation returns data for all chains within scope of the Access Token.
          nullable: true
        MotherCompanyIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of mother `Company`.
          nullable: true
        CreatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: Interval in which the companies were created.
          nullable: true
          x-max-interval-in-months: 3
          example: string
        UpdatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: Interval in which the companies were updated.
          nullable: true
          x-max-interval-in-months: 3
          example: string
        TimeFilter:
          anyOf:
          - $ref: '#/components/schemas/CompanyTimeFilter'
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use CreatedUtc or UpdatedUtc instead.
          example: string
        StartUtc:
          type: string
          format: date-time
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use CreatedUtc or UpdatedUtc instead.
          example: '2026-06-02T14:30:00Z'
        EndUtc:
          type: string
          format: date-time
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use CreatedUtc or UpdatedUtc instead.
          example: '2026-06-02T14:30:00Z'
        Ids:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of [Companies](https://mews-systems.gitbook.io/connector-api/operations/#company).
          nullable: true
        ExternalIdentifiers:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
          description: Identifiers of [Company](https://mews-systems.gitbook.io/connector-api/operations/#company) from external system.
          nullable: true
        Names:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
          description: Names of [Companies](https://mews-systems.gitbook.io/connector-api/operations/#company).
          nullable: true
        ActivityStates:
          type: array
          items:
            $ref: '#/components/schemas/ActivityStates'
          description: Whether to return only active, only deleted, or both types of record. If not specified, both active and deleted records will be returned.
          nullable: true
      additionalProperties: false
      x-schema-id: CompanyFilterParameters
    CompanyOptionUpdateParameters:
      title: Company update options
      type: object
      properties:
        Invoiceable:
          title: Boolean update value
          allOf:
          - $ref: '#/components/schemas/BooleanUpdateValue'
          description: Whether the company is invoiceable or not (or `null` if the `Invoiceable` field should not be updated).
          nullable: true
          example: string
        AddFeesToInvoices:
          title: Boolean update value
          allOf:
          - $ref: '#/components/schemas/BooleanUpdateValue'
          description: Whether the company has an additional fee applied for invoicing or not (or `null` if the `AddFeesToInvoices` field should not be updated).
          nullable: true
          example: string
        AddTaxDeductedPaymentToInvoices:
          title: Boolean update value
          allOf:
          - $ref: '#/components/schemas/BooleanUpdateValue'
          description: Whether tax-deducted payments should be automatically added to invoices (or `null` if the `AddTaxDeductedPaymentToInvoices` field should not be updated).
          nullable: true
          example: string
      additionalProperties: false
      description: Options of the company.
      x-schema-id: CompanyOptionUpdateParameters
    ReservationOld:
      title: Reservation (ver 2017-04-12)
      required:
      - AssignedResourceLocked
      - CompanionIds
      - CreatedUtc
      - CustomerId
      - EndUtc
      - GroupId
      - Id
      - Number
      - Options
      - Origin
      - OwnerId
      - PersonCounts
      - RateId
      - RequestedCategoryId
      - ServiceId
      - StartUtc
      - State
      - UpdatedUtc
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the reservation.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ServiceId:
          type: string
          description: Unique identifier of the Service that is reserved.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        GroupId:
          type: string
          description: Unique identifier of the Reservation group.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Number:
          minLength: 1
          type: string
          description: Confirmation number of the reservation in Mews.
          example: '1001'
        ChannelNumber:
          type: string
          description: Number of the reservation within the Channel (i.e. OTA, GDS, CRS, etc) in case the reservation group originates there (e.g. Booking.com confirmation number).
          nullable: true
          example: '1001'
        ChannelManagerNumber:
          type: string
          description: Unique number of the reservation within the reservation group.
          nullable: true
          example: '1001'
        ChannelManagerGroupNumber:
          type: string
          description: Number of the reservation group within a Channel manager that transferred the reservation from Channel to Mews.
          nullable: true
          example: '1001'
        ChannelManager:
          type: string
          description: Name of the Channel manager (e.g. AvailPro, SiteMinder, TravelClick, etc).
          nullable: true
          example: string
        State:
          $ref: '#/components/schemas/ServiceOrderStateOld'
        Origin:
          $ref: '#/components/schemas/ReservationOldOrigin'
        OriginDetails:
          type: string
          description: Details about the reservation origin.
          nullable: true
          example: string
        Purpose:
          anyOf:
          - $ref: '#/components/schemas/ReservationPurpose'
          description: Purpose of the reservation.
          nullable: true
          example: string
        CreatedUtc:
          minLength: 1
          type: string
          description: Creation date and time of the reservation in UTC timezone in ISO 8601 format.
          example: string
        UpdatedUtc:
          minLength: 1
          type: string
          description: Last update date and time of the reservation in UTC timezone in ISO 8601 format.
          example: string
        CancelledUtc:
          type: string
          description: Cancellation date and time in UTC timezone in ISO 8601 format.
          nullable: true
          example: string
        StartUtc:
          minLength: 1
          type: string
          description: Start of the reservation in UTC timezone in ISO 8601 format. This is either the scheduled reservation start time, or the actual customer check-in time if this is earlier than the scheduled start time.
          example: string
        EndUtc:
          minLength: 1
          type: string
          description: End of the reservation (departure) in UTC timezone in ISO 8601 format.
          example: string
        ReleasedUtc:
          type: string
          description: Date when the optional reservation is released in UTC timezone in ISO 8601 format.
          nullable: true
          example: string
        RequestedCategoryId:
          type: string
          description: Identifier of the requested Resource category.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AssignedSpaceId:
          type: string
          description: Identifier of the assigned Space.
          format: uuid
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use `AssignedResourceId` instead.
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AssignedSpaceLocked:
          type: boolean
          description: Whether the reservation is locked to the assigned Space and cannot be moved.
          deprecated: true
          x-deprecatedMessage: Use `AssignedResourceLocked` instead.
          example: true
        AssignedResourceId:
          type: string
          description: Identifier of the assigned Resource.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AssignedResourceLocked:
          type: boolean
          description: Whether the reservation is locked to the assigned Resource and cannot be moved.
          example: true
        BusinessSegmentId:
          type: string
          description: Identifier of the reservation Business segment.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CompanyId:
          type: string
          description: Identifier of the Company on behalf of which the reservation was made.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        TravelAgencyId:
          type: string
          description: Identifier of the Company that mediated the reservation.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AvailabilityBlockId:
          type: string
          description: Unique identifier of the Availability block the reservation is assigned to.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        RateId:
          type: string
          description: Identifier of the reservation Rate.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        VoucherId:
          type: string
          description: Unique identifier of the Voucher that has been used to create reservation.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CreditCardId:
          type: string
          description: Unique identifier of the Credit card.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CancellationReason:
          anyOf:
          - $ref: '#/components/schemas/CancellationReason'
          description: Cancellation reason of the reservation.
          nullable: true
          example: string
        AdultCount:
          type: integer
          description: Count of adults the reservation was booked for.
          format: int32
          deprecated: true
          x-deprecatedMessage: Use `PersonCounts` instead.
          example: 1
        ChildCount:
          type: integer
          description: Count of children the reservation was booked for.
          format: int32
          deprecated: true
          x-deprecatedMessage: Use `PersonCounts` instead.
          example: 1
        PersonCounts:
          type: array
          items:
            $ref: '#/components/schemas/ReservationPersonCount'
          description: Number of people per age category the reservation was booked for.
        OwnerId:
          type: string
          description: Unique identifier of the Customer or Company who owns the reservation.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CustomerId:
          type: string
          description: Unique identifier of the Customer who owns the reservation.
          format: uuid
          deprecated: true
          x-deprecatedMessage: Use `OwnerId` instead.
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        BookerId:
          type: string
          description: Unique identifier of the Customer on whose behalf the reservation was made.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CompanionIds:
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of the `Customer`s that will use the resource.
          deprecated: true
          x-deprecatedMessage: Use `companionships/getAll` instead.
        ChannelManagerId:
          type: string
          description: Channel Manager number.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use `ChannelManagerNumber` instead.
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Options:
          title: Reservation options
          allOf:
          - $ref: '#/components/schemas/ReservationOptions'
          description: Options of the reservation.
          example: string
      additionalProperties: false
      description: ''
      x-schema-id: ReservationOld
    LoyaltyMembershipStateEnum:
      title: Loyalty membership state
      enum:
      - New
      - Pending
      - Enrolled
      - Canceled
      - Declined
      type: string
      description: 'State of the loyalty membership.


        New


        Pending


        Enrolled


        Canceled


        Declined'
      x-enumNames:
      - New
      - Pending
      - Enrolled
      - Canceled
      - Declined
      x-enumDescriptions:
      - ''
      - ''
      - ''
      - ''
      - ''
    IdentityDocumentFilterParameters:
      title: IdentityDocumentFilterParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - CustomerIds
      - Limitation
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        Limitation:
          allOf:
          - $ref: '#/components/schemas/Limitation'
          description: Limitation on the quantity of data returned and optional Cursor for the starting point of data.
          example: string
        ChainIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Chain`. If not specified, the operation returns data for all chains within scope of the Access Token.
          nullable: true
        IdentityDocumentIds:
          maxItems: 100
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Identity document`.
          nullable: true
        CustomerIds:
          maxItems: 100
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Customer`.
        Types:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/IdentityDocumentTypeEnum'
          description: Type of the identity document.
          nullable: true
      additionalProperties: false
      x-schema-id: IdentityDocumentFilterParameters
    PaymentType:
      title: Payment item data discriminator
      enum:
      - CreditCard
      - Invoice
      - Cash
      - Unspecified
      - BadDebts
      - WireTransfer
      - ExchangeRateDifference
      - ExchangeRoundingDifference
      - BankCharges
      - Cheque
      - Other
      type: string
      x-enumDescriptions:
      - '[Credit card payment item data](https://mews-systems.gitbook.io/connector-api/operations/accountingitems#credit-card-payment-item-data)'
      - '[Invoice payment item data](https://mews-systems.gitbook.io/connector-api/operations/accountingitems#invoice-payment-item-data)'
      - No additional data.
      - No additional data.
      - No additional data.
      - No additional data.
      - No additional data.
      - No additional data.
      - No additional data.
      - No additional data.
      - No additional data.
    CustomerItems:
      title: Customer items
      required:
      - CustomerId
      - Items
      - OrderItems
      - PaymentItems
      type: object
      properties:
        CustomerId:
          type: string
          description: Unique identifier of the `Customer`.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Items:
          type: array
          items:
            $ref: '#/components/schemas/AccountingItem'
          deprecated: true
          x-deprecatedMessage: Use `OrderItems` and `PaymentItems` instead.
        OrderItems:
          type: array
          items:
            $ref: '#/components/schemas/OrderItemOld'
          description: The open order items (consumed items such as nights or products).
        PaymentItems:
          type: array
          items:
            $ref: '#/components/schemas/PaymentItemOld'
          description: The open payment items (such as cash, credit card payments or invoices).
      additionalProperties: false
      x-schema-id: CustomerItems
    MultipleCompanyContractUpdateParameters:
      title: MultipleCompanyContractUpdateParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - TravelAgencyContractUpdates
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        TravelAgencyContractUpdates:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/TravelAgencyContractUpdateParameters'
          description: Information about travel agency contracts to be updated.
      additionalProperties: false
      x-schema-id: MultipleCompanyContractUpdateParameters
    CompanyResult:
      title: CompanyResult
      required:
      - Companies
      type: object
      properties:
        Companies:
          type: array
          items:
            $ref: '#/components/schemas/Company'
          description: The company profiles of the enterprise.
        Cursor:
          type: string
          description: Unique identifier of the last and hence oldest company item returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of older companies. If [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) is specified in the request message, then Cursor will always be included in the response message; this is true even when using Extents set to false so that no actual data is returned.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: CompanyResult
    AgeCategoryParameters:
      title: AgeCategoryParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - Limitation
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        Limitation:
          allOf:
          - $ref: '#/components/schemas/Limitation'
          description: Limitation on the quantity of data returned and optional Cursor for the starting point of data.
          example: string
        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
        AgeCategoryIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of [Age categories](https://mews-systems.gitbook.io/connector-api/operations/#age-category).
          nullable: true
        ServiceIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Service` associated with the age categories. If not provided, defaults to all bookable services.
          nullable: true
        UpdatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: Interval in which the age category was updated.
          nullable: true
          x-max-interval-in-months: 3
          example: string
        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: AgeCategoryParameters
    CompanionshipExtent:
      title: Companionship extent
      type: object
      properties:
        Reservations:
          type: boolean
          description: Whether the response should contain reservations.
          nullable: true
          example: true
        ReservationGroups:
          type: boolean
          description: Whether the response should contain reservation groups.
          nullable: true
          example: true
        Customers:
          type: boolean
          description: Whether the response should contain customers.
          nullable: true
          example: true
      additionalProperties: false
      description: ''
      x-schema-id: CompanionshipExtent
    CustomerAddParameters:
      title: CustomerAddParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - LastName
      - OverwriteExisting
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        Title:
          anyOf:
          - $ref: '#/components/schemas/Title'
          description: Title prefix of the customer.
          nullable: true
          example: string
        FirstName:
          type: string
          description: First name of the customer.
          nullable: true
          example: Example Name
        LastName:
          minLength: 1
          type: string
          description: Last name of the customer.
          example: Example Name
        SecondLastName:
          type: string
          description: Second last name of the customer.
          nullable: true
          example: Example Name
        NationalityCode:
          type: string
          description: ISO 3166-1 code of the `Country`.
          nullable: true
          example: string
        PreferredLanguageCode:
          type: string
          description: 'Language and culture code of the customer''s preferred language, according to their profile. For example: `en-GB`, `fr-CA`.'
          nullable: true
          example: string
        Sex:
          anyOf:
          - $ref: '#/components/schemas/Sex'
          description: Sex of the customer.
          nullable: true
          example: string
        BirthDate:
          type: string
          description: Date of birth in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        BirthCountryCode:
          type: string
          description: Country of birth.
          nullable: true
          example: string
        BirthCountrySubdivisionCode:
          type: string
          description: Province of birth.
          nullable: true
          example: string
        BirthPlace:
          type: string
          description: Place of birth.
          nullable: true
          example: string
        Occupation:
          type: string
          description: Occupation of the customer.
          nullable: true
          example: string
        Email:
          type: string
          description: Email address of the customer.
          format: email
          nullable: true
          example: partner@example.com
        Phone:
          type: string
          description: Phone number of the customer (possibly mobile).
          format: tel
          nullable: true
          example: string
        LoyaltyCode:
          type: string
          description: Loyalty code of the customer.
          nullable: true
          example: string
        Notes:
          type: string
          description: Internal notes about the customer.
          nullable: true
          example: string
        CarRegistrationNumber:
          maxLength: 255
          type: string
          description: Registration number of the customer's car.
          nullable: true
          example: '1001'
        DietaryRequirements:
          maxLength: 255
          type: string
          description: Customer's dietary requirements, e.g. Vegan, Halal.
          nullable: true
          example: string
        TaxIdentificationNumber:
          type: string
          description: Tax identification number of the customer.
          nullable: true
          example: '1001'
        CompanyId:
          type: string
          description: Unique identifier of `Company` the customer is associated with.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Address:
          title: Address parameters
          allOf:
          - $ref: '#/components/schemas/AddressParameters'
          description: Address of the customer.
          nullable: true
          example: string
        IdentityCard:
          title: Identity document parameters
          allOf:
          - $ref: '#/components/schemas/DocumentParameters'
          description: Identity card details of the customer.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Add identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#add-identity-documents) to add document.
          example: string
        Passport:
          title: Identity document parameters
          allOf:
          - $ref: '#/components/schemas/DocumentParameters'
          description: Passport details of the customer.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Add identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#add-identity-documents) to add document.
          example: string
        Visa:
          title: Identity document parameters
          allOf:
          - $ref: '#/components/schemas/DocumentParameters'
          description: Visa details of the customer.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Add identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#add-identity-documents) to add document.
          example: string
        DriversLicense:
          title: Identity document parameters
          allOf:
          - $ref: '#/components/schemas/DocumentParameters'
          description: Drivers license details of the customer.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Add identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#add-identity-documents) to add document.
          example: string
        Classifications:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/CustomerClassificationEnum'
          description: Classifications of the customer.
          nullable: true
        Options:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/CustomerOptionEnum'
          description: Options of the customer.
          nullable: true
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using `PortfolioAccessTokens`, ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        OverwriteExisting:
          type: boolean
          description: Whether an existing customer should be overwritten in case of duplicity. This applies only to basic personal information (`Title`, `FirstName`, `LastName`, ...).
          example: true
        ItalianDestinationCode:
          type: string
          description: Value of Italian destination code.
          nullable: true
          example: string
        ItalianFiscalCode:
          type: string
          description: Value of Italian fiscal code.
          nullable: true
          example: string
        ItalianLotteryCode:
          maxLength: 15
          minLength: 2
          type: string
          description: Value of Italian lottery code.
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: CustomerAddParameters
    ContractUpdateResult:
      title: ContractUpdateResult
      required:
      - TravelAgencyContracts
      type: object
      properties:
        TravelAgencyContracts:
          type: array
          items:
            $ref: '#/components/schemas/TravelAgencyContract'
          description: The updated travel agency contracts.
      additionalProperties: false
      x-schema-id: ContractUpdateResult
    IdentityDocumentsAddParameters:
      title: Identity document add parameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - IdentityDocuments
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        IdentityDocuments:
          maxItems: 10
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/IdentityDocumentsAddData'
          description: Identity documents to be added.
      additionalProperties: false
      x-schema-id: IdentityDocumentsAddParameters
    AddressParameters:
      title: Address parameters
      type: object
      properties:
        Line1:
          type: string
          description: First line of the address.
          nullable: true
          example: string
        Line2:
          type: string
          description: Second line of the address.
          nullable: true
          example: string
        City:
          type: string
          description: The city.
          nullable: true
          example: string
        PostalCode:
          type: string
          description: Postal code.
          format: postal-code
          nullable: true
          example: string
        CountryCode:
          type: string
          description: ISO 3166-1 code of the Country.
          nullable: true
          example: string
        CountrySubdivisionCode:
          type: string
          description: ISO 3166-2 code of the administrative division, e.g. DE-BW
          nullable: true
          example: string
      additionalProperties: false
      description: New address details.
      x-schema-id: AddressParameters
    BooleanUpdateValue:
      title: Boolean update value
      type: object
      properties:
        Value:
          type: boolean
          description: Value which is to be updated.
          example: true
      additionalProperties: false
      x-schema-id: BooleanUpdateValue
    ReservationOptions:
      title: Reservation options
      required:
      - AllCompanionsCheckedIn
      - AnyCompanionCheckedIn
      - OwnerCheckedIn
      type: object
      properties:
        OwnerCheckedIn:
          type: boolean
          description: Owner of the reservation checked in.
          example: true
        AllCompanionsCheckedIn:
          type: boolean
          description: All companions of the reservation checked in.
          example: true
        AnyCompanionCheckedIn:
          type: boolean
          description: Any companion of the reservation checked in.
          example: true
      additionalProperties: false
      x-schema-id: ReservationOptions
    MultipleCompanyDeleteParameters:
      title: MultipleCompanyDeleteParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - CompanyIds
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CompanyIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of the companies to be deleted.
      additionalProperties: false
      x-schema-id: MultipleCompanyDeleteParameters
    LoyaltyMembership:
      title: Loyalty membership
      required:
      - AccountId
      - ChainId
      - CreatorProfile
      - Id
      - IsPrimary
      - LoyaltyProgramId
      - State
      - UpdaterProfile
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the loyalty membership.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ChainId:
          type: string
          description: Unique identifier of the chain.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountId:
          type: string
          description: Unique identifier of the account.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        LoyaltyProgramId:
          type: string
          description: Unique identifier of the loyalty program.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        State:
          title: Loyalty membership state
          allOf:
          - $ref: '#/components/schemas/LoyaltyMembershipStateEnum'
          description: 'State of the loyalty membership.


            New


            Pending


            Enrolled


            Canceled


            Declined'
          x-enumNames:
          - New
          - Pending
          - Enrolled
          - Canceled
          - Declined
          x-enumDescriptions:
          - ''
          - ''
          - ''
          - ''
          - ''
          example: string
        IsPrimary:
          type: boolean
          description: Defines the primary loyalty membership.
          example: true
        ProviderMembershipId:
          type: string
          description: Unique identifier for the loyalty membership in the loyalty provider's system.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Code:
          type: string
          description: Code of the loyalty membership.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use `MembershipNumber` instead.
          example: string
        MembershipNumber:
          type: string
          description: Customer-facing membership numbers, e.g., printed on a loyalty card.
          nullable: true
          example: '1001'
        Points:
          type: integer
          description: The loyalty points for the account in that membership.
          format: int32
          nullable: true
          example: 1
        ExpirationDate:
          type: string
          description: Expiration date of the loyalty membership in UTC timezone in ISO 8601 format.
          format: date-time
          nullable: true
          example: '2026-06-02T14:30:00Z'
        Url:
          type: string
          description: Url of the loyalty membership.
          nullable: true
          example: https://api.mews.com/api/connector/v1
        LoyaltyTierId:
          type: string
          description: Unique identifier of the loyalty tier.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CreatorProfile:
          title: Profile data
          allOf:
          - $ref: '#/components/schemas/ProfileData'
          description: The profile data of the user who created or last updated the record.
          example: string
        UpdaterProfile:
          title: Profile data
          allOf:
          - $ref: '#/components/schemas/ProfileData'
          description: The profile data of the user who created or last updated the record.
          example: string
      additionalProperties: false
      x-schema-id: LoyaltyMembership
    LoyaltyMembershipDeleteParameters:
      title: Loyalty membership delete parameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - LoyaltyMembershipIds
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        LoyaltyMembershipIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifier of the loyalty memberships to be deleted.
      additionalProperties: false
      x-schema-id: LoyaltyMembershipDeleteParameters
    OldAddress:
      title: Address
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the address.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Line1:
          type: string
          description: First line of the address.
          nullable: true
          example: string
        Line2:
          type: string
          description: Second line of the address.
          nullable: true
          example: string
        City:
          type: string
          description: The city.
          nullable: true
          example: string
        PostalCode:
          type: string
          description: Postal code.
          nullable: true
          example: string
        CountryCode:
          type: string
          description: ISO 3166-1 code of the `Country`.
          nullable: true
          example: string
        CountrySubdivisionCode:
          type: string
          description: ISO 3166-2 code of the administrative division, e.g. `DE-BW`.
          nullable: true
          example: string
        Latitude:
          type: number
          description: The latitude.
          format: double
          nullable: true
          example: 100.0
        Longitude:
          type: number
          description: The longitude.
          format: double
          nullable: true
          example: 100.0
      additionalProperties: false
      description: ''
      x-schema-id: OldAddress
    MultipleLoyaltyProgramUpdateParameters:
      title: MultipleLoyaltyProgramUpdateParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - LoyaltyProgramUpdates
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        LoyaltyProgramUpdates:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyProgramUpdateParameters'
          description: Loyalty programs to be updated.
      additionalProperties: false
      x-schema-id: MultipleLoyaltyProgramUpdateParameters
    LoyaltyProgramSubscriptionUpdateValue:
      title: Loyalty program subscription update value
      type: object
      properties:
        Value:
          title: Loyalty program subscription
          allOf:
          - $ref: '#/components/schemas/LoyaltyProgramSubscription'
          description: Value which is to be updated.
          x-enumNames:
          - Free
          - Paid
          x-enumDescriptions:
          - ''
          - ''
          x-schema-id: LoyaltyProgramSubscription
          example: string
      additionalProperties: false
      x-schema-id: LoyaltyProgramSubscriptionUpdateValue
    IdentityDocumentClearParameters:
      title: IdentityDocumentClearParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - CustomerIds
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CustomerIds:
          maxItems: 10
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of the `Customer` for whom documents will be deleted.
      additionalProperties: false
      x-schema-id: IdentityDocumentClearParameters
    Limitation:
      title: Limitation
      required:
      - Count
      type: object
      properties:
        Count:
          type: integer
          format: int32
          example: 1
        Cursor:
          type: string
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      description: Limitation on the quantity of data returned.
      x-schema-id: Limitation
    AccountType:
      title: Account type
      enum:
      - Company
      - Customer
      type: string
      description: A discriminator specifying the account type, e.g. `Customer` or `Company`
    CustomerOptionsEnum:
      title: Customer option
      enum:
      - None
      - SendMarketingEmails
      - Invoiceable
      - BillAddressObjection
      - SendMarketingPostalMail
      - SendPartnerMarketingEmails
      - SendPartnerMarketingPostalMail
      - WithdrawCardConsent
      - GuestPhotoConsent
      - IdPhotosConsent
      type: string
      description: '


        None


        SendMarketingEmails


        Invoiceable


        BillAddressObjection


        SendMarketingPostalMail


        SendPartnerMarketingEmails


        SendPartnerMarketingPostalMail


        WithdrawCardConsent


        GuestPhotoConsent


        IdPhotosConsent'
      x-enumNames:
      - None
      - SendMarketingEmails
      - Invoiceable
      - BillAddressObjection
      - SendMarketingPostalMail
      - SendPartnerMarketingEmails
      - SendPartnerMarketingPostalMail
      - WithdrawCardConsent
      - GuestPhotoConsent
      - IdPhotosConsent
      x-enumDescriptions:
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
    CustomerSearchParameters:
      title: CustomerSearchParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        Name:
          type: string
          description: Name to search by (applies to first name, last name, and full name).
          nullable: true
          example: Example Name
        ResourceId:
          type: string
          description: Identifier of [Resource](https://mews-systems.gitbook.io/connector-api/operations/resources/#resource) to search by (members of reservation assigned there will be returned).
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Extent:
          title: Customer extent
          allOf:
          - $ref: '#/components/schemas/CustomerExtent'
          description: Extent of data to be returned.
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: CustomerSearchParameters
    CreditRatingUpdateParameters:
      title: Credit rating update parameters
      type: object
      properties:
        Basic:
          title: Credit rating basic update value
          allOf:
          - $ref: '#/components/schemas/CreditRatingBasicUpdateValue'
          description: Credit status of a company (or `null` if the credit status should not be updated).
          nullable: true
          example: string
      additionalProperties: false
      description: Credit rating to define creditworthiness of the company.
      x-schema-id: CreditRatingUpdateParameters
    IdentityDocumentDeleteParameters:
      title: IdentityDocumentDeleteParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - IdentityDocumentIds
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        IdentityDocumentIds:
          maxItems: 100
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of the identity documents to be deleted.
      additionalProperties: false
      x-schema-id: IdentityDocumentDeleteParameters
    CompanyOptions:
      title: Company Options
      type: object
      properties:
        Invoiceable:
          type: boolean
          description: Whether the company is invoiceable or not.
          example: true
        AddFeesToInvoices:
          type: boolean
          description: Whether the company has an additional fee applied for invoicing or not.
          example: true
        AddTaxDeductedPaymentToInvoices:
          type: boolean
          description: Whether tax-deducted payments should be automatically added to invoices.
          example: true
      additionalProperties: false
      description: Options of the company.
      x-schema-id: CompanyOptions
    MultipleAddressAddParameters:
      title: MultipleAddressAddParameters
      required:
      - AccessToken
      - Addresses
      - Client
      - ClientToken
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Addresses:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/AddressAddParameters'
          description: Collection of addresses to be created.
      additionalProperties: false
      x-schema-id: MultipleAddressAddParameters
    AddressDeleteParameters:
      title: AddressDeleteParameters
      required:
      - AccessToken
      - AddressIds
      - Client
      - ClientToken
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AddressIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of [Addresses](https://mews-systems.gitbook.io/connector-api/operations/#account-address) within the enterprise to be deleted.
      additionalProperties: false
      x-schema-id: AddressDeleteParameters
    Int32UpdateValue:
      title: Int32 update value
      type: object
      properties:
        Value:
          type: integer
          description: Value which is to be updated.
          format: int32
          example: 1
      additionalProperties: false
      x-schema-id: Int32UpdateValue
    TravelAgencyContract:
      title: Travel agency contract
      required:
      - CompanyId
      - CreatedUtc
      - Id
      - IsActive
      - Options
      - ServiceId
      - UpdatedUtc
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the contract.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ServiceId:
          type: string
          description: Unique identifier of the `Service` the contract is related to.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CompanyId:
          type: string
          description: Unique identifier of the contracted `Company`.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        IsActive:
          type: boolean
          description: Whether the contract is still active.
          example: true
        CommissionIncluded:
          type: boolean
          description: Whether commission of the travel agency is included in the rate. When `CommissionIncluded` is not provided in the response, that means commission is unspecified, when set to true it means the the commission is included in the rate and false means the commission in not included in the rate.
          nullable: true
          example: true
        Commission:
          type: number
          description: Commission of the travel agency.
          format: double
          nullable: true
          example: 100.0
        ChannelManagerAbsoluteAdjustment:
          type: number
          description: Flat fee added to (or subtracted from) the reservation price when coming from Channel Managers.
          format: double
          nullable: true
          example: 100.0
        ChannelManagerRelativeAdjustment:
          type: number
          description: Percentage of the reservation price added to (or subtracted from) price when coming from Channel Managers.
          format: double
          nullable: true
          example: 100.0
        Options:
          title: Travel agency contract options
          allOf:
          - $ref: '#/components/schemas/TravelAgencyContractOptions'
          description: Options of the travel agency contract.
          example: string
        AccountingCode:
          type: string
          description: Accounting code of the travel agency contract.
          nullable: true
          example: string
        InvoiceDueInterval:
          type: string
          description: The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
          nullable: true
          example: string
        ChannelManagerBusinessSegmentId:
          type: string
          description: Unique identifier of the `BusinessSegment` used for incoming reservations originating from Channel Managers, for this particular contract.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ContactPerson:
          type: string
          description: Contact person of the travel agency.
          nullable: true
          example: string
        ContactEmail:
          type: string
          description: Contact email of the travel agency.
          format: email
          nullable: true
          example: partner@example.com
        AdditionalContactInfo:
          type: string
          description: Additional contact info of the travel agency.
          nullable: true
          example: string
        Notes:
          type: string
          description: Additional notes of the travel agency contract.
          nullable: true
          example: string
        CreatedUtc:
          minLength: 1
          type: string
          description: Creation date and time of the travel agency contract in UTC timezone in ISO 8601 format.
          format: date-time
          example: '2026-06-02T14:30:00Z'
        UpdatedUtc:
          minLength: 1
          type: string
          description: Last update date and time of the travel agency contract in UTC timezone in ISO 8601 format.
          format: date-time
          example: '2026-06-02T14:30:00Z'
      additionalProperties: false
      x-schema-id: TravelAgencyContract
    CustomerResult:
      title: CustomerResult
      required:
      - Customers
      type: object
      properties:
        Customers:
          type: array
          items:
            $ref: '#/components/schemas/Customer'
          description: The customers.
        Documents:
          type: array
          items:
            $ref: '#/components/schemas/IdentityDocument'
          description: The identity documents of customers.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents.
        Cursor:
          type: string
          description: Unique identifier of the last and hence oldest customer item returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of older customers. If [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) is specified in the request message, then Cursor will always be included in the response message; this is true even when using Extents set to false so that no actual data is returned.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: CustomerResult
    CustomerSearchResult:
      title: CustomerSearchResult
      required:
      - Customers
      type: object
      properties:
        Customers:
          type: array
          items:
            $ref: '#/components/schemas/ChargeableCustomer'
          description: The customer search results.
        Documents:
          type: array
          items:
            $ref: '#/components/schemas/IdentityDocument'
          description: The identity documents of customers.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents.
      additionalProperties: false
      x-schema-id: CustomerSearchResult
    DocumentParameters:
      title: Identity document parameters
      type: object
      properties:
        Number:
          type: string
          description: Number of the document (e.g. passport number).
          nullable: true
          example: '1001'
        Expiration:
          type: string
          description: Expiration date in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        Issuance:
          type: string
          description: Date of issuance in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        IssuingCountryCode:
          type: string
          description: ISO 3166-1 code of the `Country`.
          nullable: true
          example: string
        IssuingCountrySubdivisionCode:
          type: string
          description: Identifier of the country subdivision where the document was issued (province, state or region).
          nullable: true
          example: string
        IssuingCity:
          type: string
          description: City from which document issued
          nullable: true
          example: string
      additionalProperties: false
      description: ''
      x-schema-id: DocumentParameters
    ReservationOldOrigin:
      title: Reservation origin (ver 2017-04-12)
      enum:
      - Distributor
      - ChannelManager
      - Import
      - Connector
      - Navigator
      - CommanderInPerson
      - CommanderChannel
      - CommanderPhone
      - CommanderEmail
      - CommanderWebsite
      - CommanderMessage
      - CommanderCallCenter
      - CommanderRoomingList
      type: string
      x-enumDescriptions:
      - From the Mews Booking Engine or Booking Engine API.
      - From a channel manager.
      - From an import process.
      - From the Mews Connector API.
      - From Mews Guest Services.
      - From Mews Operations, in person.
      - From Mews Operations, via channel.
      - From Mews Operations, via telephone.
      - From Mews Operations, via email.
      - From Mews Operations, via website.
      - From Mews Operations, via message person.
      - From Mews Operations, via call center.
      - From Mews Operations, via rooming list.
    TaxBreakdownItem:
      title: Tax breakdown item
      required:
      - NetValue
      - TaxValue
      type: object
      properties:
        TaxRateCode:
          type: string
          description: Tax rate code for the item. `null` for untaxed amounts.
          nullable: true
          example: string
        NetValue:
          type: number
          description: The net value that the tax is calculated from.
          format: double
          example: 100.0
        TaxValue:
          type: number
          description: The value of the tax.
          format: double
          example: 100.0
      additionalProperties: false
      x-schema-id: TaxBreakdownItem
    MultipleCompanyContractDeleteParameters:
      title: MultipleCompanyContractDeleteParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - ServiceIds
      - TravelAgencyContractIds
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        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
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        TravelAgencyContractIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of the Travel agency contract to delete.
        ServiceIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of the `Service` the travel agency contract belongs to.
      additionalProperties: false
      x-schema-id: MultipleCompanyContractDeleteParameters
    AgeCategory:
      title: Age category
      required:
      - Classification
      - CreatedUtc
      - Id
      - IsActive
      - Names
      - ServiceId
      - UpdatedUtc
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of age category.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ServiceId:
          type: string
          description: Unique identifier of [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service) the age category belongs to.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        MinimalAge:
          type: integer
          description: Minimal age for the age category.
          format: int32
          nullable: true
          example: 1
        MaximalAge:
          type: integer
          description: Maximal age for the age category.
          format: int32
          nullable: true
          example: 1
        Names:
          title: Localized text
          type: object
          additionalProperties:
            type: string
          description: All translations of the name of the age category.
          x-schema-id: LocalizedStrings
        ShortNames:
          title: Localized text
          type: object
          additionalProperties:
            type: string
          description: All translations of the short name of the age category.
          nullable: true
          x-schema-id: LocalizedStrings
        CreatedUtc:
          minLength: 1
          type: string
          description: Creation date and time of the age category in UTC timezone in ISO 8601 format.
          format: date-time
          example: '2026-06-02T14:30:00Z'
        UpdatedUtc:
          minLength: 1
          type: string
          description: Last update date and time of the age category in UTC timezone in ISO 8601 format.
          format: date-time
          example: '2026-06-02T14:30:00Z'
        Classification:
          title: Age category classification
          allOf:
          - $ref: '#/components/schemas/AgeCategoryClassificationEnum'
          description: 'The classification of the age category.


            Adult


            Child'
          x-enumNames:
          - Adult
          - Child
          x-enumDescriptions:
          - ''
          - ''
          example: string
        IsActive:
          type: boolean
          description: Whether the age category is still active.
          example: true
        ExternalIdentifier:
          maxLength: 255
          type: string
          description: Identifier of the age category from external system.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: AgeCategory
    ProfileData:
      title: Profile data
      required:
      - Discriminator
      type: object
      properties:
        Discriminator:
          $ref: '#/components/schemas/ProfileDataDiscriminator'
        EnterpriseProfile:
          title: Enterprise profile data
          allOf:
          - $ref: '#/components/schemas/EnterpriseProfileData'
          description: Enterprise profile data.
          nullable: true
          example: string
      additionalProperties: false
      description: The profile data of the user who created or last updated the record.
      x-schema-id: ProfileData
    IdentityDocumentTypeUpdateValue:
      title: Identity document type update value
      type: object
      properties:
        Value:
          title: Document type
          allOf:
          - $ref: '#/components/schemas/IdentityDocumentTypeEnum'
          description: 'Type of the document (or `null` if the type should not be updated).


            IdentityCard


            Passport


            Visa


            DriversLicense'
          x-enumNames:
          - IdentityCard
          - Passport
          - Visa
          - DriversLicense
          x-enumDescriptions:
          - ''
          - ''
          - ''
          - ''
          example: string
      additionalProperties: false
      description: Has same structure as [String update value](https://mews-systems.gitbook.io/connector-api/operations/_objects#string-update-value).
      x-schema-id: IdentityDocumentTypeUpdateValue
    TimeFilterInterval:
      title: Time interval
      type: object
      properties:
        StartUtc:
          type: string
          format: date-time
          nullable: true
          example: '2026-06-02T14:30:00Z'
        EndUtc:
          type: string
          format: date-time
          nullable: true
          example: '2026-06-02T14:30:00Z'
      additionalProperties: false
      description: "When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply:\r\n\r\n- **Start equals End (equality mode)**  \r\n  If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time:\r\n  \r\n  ```\r\n  CreatedUtc == StartUtc\r\n  ```\r\n  \r\n  This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned.\r\n\r\n- **Start differs from End (interval mode)**  \r\n  If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval:\r\n  \r\n  ```\r\n  StartUtc <= CreatedUtc < EndUtc\r\n  ```\r\n  \r\n  In other words, the start is inclusive and the end is exclusive.\r\n\r\nMake sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted."
      x-schema-id: TimeFilterInterval
    ReservationPersonCount:
      title: Age category parameters
      required:
      - AgeCategoryId
      - Count
      type: object
      properties:
        AgeCategoryId:
          type: string
          description: Unique identifier of the [Age category](https://mews-systems.gitbook.io/connector-api/operations/agecategories#age-category).
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Count:
          type: integer
          description: Number of people of a given age category. Only positive value is accepted.
          format: int32
          example: 1
      additionalProperties: false
      x-schema-id: ReservationPersonCount
    AddressFilterParameters:
      title: AddressFilterParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - Limitation
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        Limitation:
          allOf:
          - $ref: '#/components/schemas/Limitation'
          description: Limitation on the quantity of data returned and optional Cursor for the starting point of data.
          example: string
        ChainIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Chain`. If not specified, the operation returns data for all chains within scope of the Access Token.
          nullable: true
        AccountIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of [Companies](https://mews-systems.gitbook.io/connector-api/operations/companies/#company) or [Customers](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer) within the enterprise. Required if no other filter is provided.
          nullable: true
        AddressIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of [Addresses](https://mews-systems.gitbook.io/connector-api/operations/#account-address) within the enterprise. Use this property if you want to fetch specific addresses. Required if no other filter is provided.
          nullable: true
        UpdatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: Interval of Address last update date and time. Required if no other filter is provided.
          nullable: true
          x-max-interval-in-months: 3
          example: string
        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: AddressFilterParameters
    CompanyUpdateParameters:
      title: CompanyUpdateParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - CompanyId
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CompanyId:
          type: string
          description: Unique identifier of the [Company](https://mews-systems.gitbook.io/connector-api/operations/#company).
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Name:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Name of the company (or `null` if the name should not be updated).
          nullable: true
          example: Example Name
        MotherCompanyId:
          title: Guid update value
          allOf:
          - $ref: '#/components/schemas/GuidNullableUpdateValue'
          description: Unique identifier of the mother company (or `null` if the mother company should not be updated).
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        InvoicingEmail:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Email for issuing invoices to the company  (or `null` if the email for issuing invoices should not be updated).
          format: email
          nullable: true
          example: partner@example.com
        WebsiteUrl:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: The website url of the company (or `null` if the website url should not be updated).
          format: uri
          nullable: true
          example: https://api.mews.com/api/connector/v1
        InvoiceDueInterval:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: The maximum time, when the invoice has to be be paid in ISO 8601 duration format (or `null` if the interval should not be updated).
          nullable: true
          example: string
        Options:
          title: Company update options
          allOf:
          - $ref: '#/components/schemas/CompanyOptionUpdateParameters'
          description: Options of the company (or `null` if the company options should not be updated).
          nullable: true
          example: string
        CreditRating:
          title: Credit rating update parameters
          allOf:
          - $ref: '#/components/schemas/CreditRatingUpdateParameters'
          description: Credit rating to define creditworthiness of the company (or `null` if the credit rating should not be updated).
          nullable: true
          example: string
        Department:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: The internal segmentation of a company, e.g. sales department (or `null` if the department should not be updated).
          nullable: true
          example: string
        DunsNumber:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: The Dun & Bradstreet unique 9-digit DUNS number (or `null` if the Duns number should not be updated).
          nullable: true
          example: '1001'
        ReferenceIdentifier:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: External system identifier - custom identifier used by an external system such as an external database (or `null` if the identifier should not be updated).
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountingCode:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Accounting code of the company (or `null` if the accounting code should not be updated).
          nullable: true
          example: string
        AdditionalTaxIdentifier:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Additional tax identifier of the company (or `null` if the additional tax identifier should not be updated).
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        BillingCode:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Billing code of the company (or `null` if the billing code should not be updated).
          nullable: true
          example: string
        Contact:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Other contact details, such as telephone, email or similar (or `null` if the contact should not be updated).
          nullable: true
          example: string
        ContactPerson:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Contact person of the company (or `null` if the contact person should not be updated).
          nullable: true
          example: string
        Identifier:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Fiscal or legal identifier of the company (or `null` if the identifier should not be updated).
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Iata:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Iata of the company (or `null` if the Iata should not be updated).
          nullable: true
          example: string
        Notes:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Notes of the company (or `null` if the notes should not be updated).
          nullable: true
          example: string
        TaxIdentifier:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Tax identification number of the company (or `null` if the tax identifier should not be updated).
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Telephone:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Contact telephone number (or `null` if the telephone number should not be updated).
          format: tel
          nullable: true
          example: string
        ExternalIdentifier:
          title: String update value
          maxLength: 255
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Identifier of the company from external system (or `null` if the External Identifier should not be updated).
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: CompanyUpdateParameters
    TravelAgencyContractOptionsParameters:
      title: Travel agency contract update options
      required:
      - IncludeCancellationFeeInCommissionEstimate
      - SkipAutomaticSettlement
      type: object
      properties:
        IncludeCancellationFeeInCommissionEstimate:
          title: Boolean update value
          allOf:
          - $ref: '#/components/schemas/BooleanUpdateValue'
          description: Cancellation fee will be considered when calculating the travel agency commission estimate.
          example: string
        SkipAutomaticSettlement:
          title: Boolean update value
          allOf:
          - $ref: '#/components/schemas/BooleanUpdateValue'
          description: Reservations from travel agencies will not be automatically charged.
          example: string
      additionalProperties: false
      x-schema-id: TravelAgencyContractOptionsParameters
    CreditRatingBasicUpdateValue:
      title: Credit rating basic update value
      type: object
      properties:
        Value:
          title: Credit rating basic
          allOf:
          - $ref: '#/components/schemas/CreditRatingBasicEnum'
          description: Value which is to be updated.
          x-enumNames:
          - CreditOk
          - PaymentRequiredUpfront
          - LocalDecisionRequired
          x-enumDescriptions:
          - Company can book services.
          - Company must pay upfront.
          - Requires local approval.
          example: string
      additionalProperties: false
      x-schema-id: CreditRatingBasicUpdateValue
    TravelAgencyContractUpdateParameters:
      title: Travel agency contract update parameters
      required:
      - TravelAgencyContractId
      type: object
      properties:
        TravelAgencyContractId:
          type: string
          description: Unique identifier of the Travel agency contract.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CommissionIncluded:
          title: Boolean update value
          allOf:
          - $ref: '#/components/schemas/BooleanNullableUpdateValue'
          description: Whether commission of the travel agency is included in the rate.
          nullable: true
          example: string
        Commission:
          title: Decimal update value
          allOf:
          - $ref: '#/components/schemas/DecimalNullableUpdateValue'
          description: Commission of the travel agency.
          nullable: true
          example: string
        ChannelManagerBusinessSegmentId:
          title: Guid update value
          allOf:
          - $ref: '#/components/schemas/GuidNullableUpdateValue'
          description: Unique identifier of the `BusinessSegment` used for incoming reservations originating from Channel Managers, for this particular contract.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ChannelManagerAbsoluteAdjustment:
          title: Decimal update value
          allOf:
          - $ref: '#/components/schemas/DecimalNullableUpdateValue'
          description: Flat fee added to (or subtracted from) the reservation price when coming from Channel Managers.
          nullable: true
          example: string
        ChannelManagerRelativeAdjustment:
          title: Decimal update value
          allOf:
          - $ref: '#/components/schemas/DecimalNullableUpdateValue'
          description: Percentage of the reservation price added to (or subtracted from) price when coming from Channel Managers.
          nullable: true
          example: string
        Options:
          title: Travel agency contract update options
          allOf:
          - $ref: '#/components/schemas/TravelAgencyContractOptionsParameters'
          description: Options of the travel agency contract.
          nullable: true
          example: string
        AccountingCode:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Accounting code of the travel agency contract.
          nullable: true
          example: string
        InvoiceDueInterval:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
          nullable: true
          example: string
        ContactPerson:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Contact person of the travel agency.
          nullable: true
          example: string
        ContactEmail:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Contact email of the travel agency.
          format: email
          nullable: true
          example: partner@example.com
        AdditionalContactInfo:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Additional contact info of the travel agency.
          nullable: true
          example: string
        Notes:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Additional notes of the travel agency contract.
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: TravelAgencyContractUpdateParameters
    AgeCategoryResult:
      title: AgeCategoryResult
      required:
      - AgeCategories
      type: object
      properties:
        AgeCategories:
          type: array
          items:
            $ref: '#/components/schemas/AgeCategory'
          description: Age category of the enterprise.
        Cursor:
          type: string
          description: Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: AgeCategoryResult
    LoyaltyProgramFilterParameters:
      title: LoyaltyProgramFilterParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - Limitation
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.
          nullable: true
        CreatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: Interval of `LoyaltyProgram` creation date and time.
          nullable: true
          x-max-interval-in-months: 3
          example: string
        UpdatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: Interval of `LoyaltyProgram` last update date and time.
          nullable: true
          x-max-interval-in-months: 3
          example: string
        LoyaltyProgramIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `LoyaltyProgram`.
          nullable: true
        ActivityStates:
          type: array
          items:
            $ref: '#/components/schemas/ActivityStates'
          description: Whether to return only active, only deleted or both records.
          nullable: true
        Codes:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
          description: Codes of `LoyaltyProgram`.
          nullable: true
        Limitation:
          allOf:
          - $ref: '#/components/schemas/Limitation'
          description: Limitation on the quantity of data returned.
          example: string
      additionalProperties: false
      x-schema-id: LoyaltyProgramFilterParameters
    MultipleLoyaltyTierUpdateParameters:
      title: MultipleLoyaltyTierUpdateParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - LoyaltyTierUpdates
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        LoyaltyTierUpdates:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyTierUpdateParameters'
          description: Loyalty tiers to be updated.
      additionalProperties: false
      x-schema-id: MultipleLoyaltyTierUpdateParameters
    CreditRatingBasicEnum:
      title: Credit rating basic
      enum:
      - CreditOk
      - PaymentRequiredUpfront
      - LocalDecisionRequired
      type: string
      description: '


        CreditOk (Company can book services.)


        PaymentRequiredUpfront (Company must pay upfront.)


        LocalDecisionRequired (Requires local approval.)'
      x-enumNames:
      - CreditOk
      - PaymentRequiredUpfront
      - LocalDecisionRequired
      x-enumDescriptions:
      - Company can book services.
      - Company must pay upfront.
      - Requires local approval.
    CompanyContractFilterParameters:
      title: CompanyContractFilterParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - Limitation
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        Limitation:
          allOf:
          - $ref: '#/components/schemas/Limitation'
          description: Limitation on the quantity of data returned and optional Cursor for the starting point of data.
          example: string
        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
          example: string
        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
    LoyaltyProgram:
      title: Loyalty program
      required:
      - ChainId
      - Code
      - Id
      - Name
      - Subscription
      - Type
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the loyalty program.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ChainId:
          type: string
          description: Unique identifier of the chain.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Name:
          minLength: 1
          type: string
          description: Name of the loyalty program.
          example: Example Name
        Code:
          minLength: 1
          type: string
          description: Code of the loyalty program.
          example: string
        Type:
          $ref: '#/components/schemas/LoyaltyProgramType'
        Subscription:
          $ref: '#/components/schemas/LoyaltyProgramSubscription'
      additionalProperties: false
      x-schema-id: LoyaltyProgram
    CompanyOptionsParameters:
      title: Company Options Parameters
      type: object
      properties:
        Invoiceable:
          type: boolean
          description: Whether the company is invoiceable or not.
          example: true
        AddFeesToInvoices:
          type: boolean
          description: Whether the company has an additional fee applied for invoicing or not.
          example: true
        AddTaxDeductedPaymentToInvoices:
          type: boolean
          description: Whether tax-deducted payments should be automatically added to invoices.
          example: true
      additionalProperties: false
      description: Options of the company.
      x-schema-id: CompanyOptionsParameters
    LoyaltyProgramType:
      title: Loyalty program type
      enum:
      - Hotel
      - ExternalPartner
      - SoftBrand
      - Unknown
      type: string
      description: 'Type of the loyalty program.


        Hotel


        ExternalPartner


        SoftBrand


        Unknown'
      x-enumNames:
      - Hotel
      - ExternalPartner
      - SoftBrand
      - Unknown
      x-enumDescriptions:
      - ''
      - ''
      - ''
      - ''
      x-schema-id: LoyaltyProgramType
    AddressResultPage:
      title: AddressResultPage
      required:
      - Addresses
      type: object
      properties:
        Addresses:
          type: array
          items:
            $ref: '#/components/schemas/AccountAddress'
          description: The collection of Account addresses, containing address and account information.
        Cursor:
          type: string
          description: Unique identifier of the last and hence oldest address item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older Account address.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: AddressResultPage
    CreditRating:
      title: Credit Rating
      type: object
      properties:
        Basic:
          allOf:
          - $ref: '#/components/schemas/CreditRatingBasicEnum'
          description: 'Indicates the credit status of a company.


            CreditOk (Company can book services.)


            PaymentRequiredUpfront (Company must pay upfront.)


            LocalDecisionRequired (Requires local approval.)'
          nullable: true
          example: string
      additionalProperties: false
      description: Credit rating to define creditworthiness of the company.
      x-schema-id: CreditRating
    CancellationReason:
      enum:
      - Other
      - ConfirmationMissed
      - BookedElsewhere
      - ForceMajeure
      - GuestComplaint
      - NoShow
      - PriceTooHigh
      - ServiceNotAvailable
      - InputError
      - InvalidPayment
      - TravelAgency
      - RequestedByGuest
      - Update
      - BookingAbandoned
      - RequestedByBooker
      type: string
    IdentityDocumentUpdateParameters:
      title: Identity document update parameters
      required:
      - Id
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the document.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Type:
          title: Identity document type update value
          allOf:
          - $ref: '#/components/schemas/IdentityDocumentTypeUpdateValue'
          description: Type of the document (or `null` if the type should not be updated).
          nullable: true
          example: string
        Number:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Number of the document (e.g. passport number or `null` if the number should not be updated).
          nullable: true
          example: '1001'
        ExpirationDate:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Expiration date in ISO 8601 format (or `null` if the expiration date should not be updated).
          format: date
          nullable: true
          example: '2026-06-02'
        IssuanceDate:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Date of issuance in ISO 8601 format (or `null` if the issuance date should not be updated).
          format: date
          nullable: true
          example: '2026-06-02'
        IssuingCountryCode:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: ISO 3166-1 code of the `Country` (or `null` if the issuing country code should not be updated).
          nullable: true
          example: string
        IssuingCountrySubdivisionCode:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Identifier of the country subdivision where the document was issued (province, state or region) (or `null` if the value should not be updated).
          nullable: true
          example: string
        IssuingCity:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: City where the document was issued (or `null` if the issuing city should not be updated).
          nullable: true
          example: string
        IdentityDocumentSupportNumber:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Identity document support number. Only required for Spanish identity cards in Spanish hotels.
          nullable: true
          example: '1001'
      additionalProperties: false
      x-schema-id: IdentityDocumentUpdateParameters
    AgeCategoryClassificationEnum:
      title: Age category classification
      enum:
      - Adult
      - Child
      type: string
      description: '


        Adult


        Child'
      x-enumNames:
      - Adult
      - Child
      x-enumDescriptions:
      - ''
      - ''
    LoyaltyProgramTypeUpdateValue:
      title: Loyalty program type update value
      type: object
      properties:
        Value:
          title: Loyalty program type
          allOf:
          - $ref: '#/components/schemas/LoyaltyProgramType'
          description: Value which is to be updated.
          x-enumNames:
          - Hotel
          - ExternalPartner
          - SoftBrand
          - Unknown
          x-enumDescriptions:
          - ''
          - ''
          - ''
          - ''
          x-schema-id: LoyaltyProgramType
          example: string
      additionalProperties: false
      x-schema-id: LoyaltyProgramTypeUpdateValue
    ChargeableCustomer:
      title: Customer search result
      required:
      - Customer
      type: object
      properties:
        Customer:
          allOf:
          - $ref: '#/components/schemas/Customer'
          description: The found customer.
          example: string
        Reservation:
          title: Reservation (ver 2017-04-12)
          allOf:
          - $ref: '#/components/schemas/ReservationOld'
          description: Reservation of the customer in case they are currently staying in the property.
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: ChargeableCustomer
    CustomerUpdateParameters:
      title: CustomerUpdateParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - CustomerId
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using `PortfolioAccessTokens`, ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CustomerId:
          type: string
          description: Unique identifier of the `Customer` to be updated.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Title:
          allOf:
          - $ref: '#/components/schemas/Title'
          description: 'New title.


            Mister (Mr.)


            Miss (Ms.)


            Misses (Mrs.)'
          nullable: true
          example: string
        FirstName:
          type: string
          description: New first name.
          nullable: true
          example: Example Name
        LastName:
          type: string
          description: New last name.
          nullable: true
          example: Example Name
        SecondLastName:
          type: string
          description: New second last name.
          nullable: true
          example: Example Name
        NationalityCode:
          type: string
          description: New nationality code as ISO 3166-1 code of the `Country`.
          nullable: true
          example: string
        PreferredLanguageCode:
          type: string
          description: 'Language and culture code of the customer''s preferred language, according to their profile. For example: `en-GB`, `fr-CA`.'
          nullable: true
          example: string
        Sex:
          allOf:
          - $ref: '#/components/schemas/SexEnum'
          description: 'Sex of the customer.


            Male


            Female'
          nullable: true
          example: string
        BirthDate:
          type: string
          description: New birth date in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        BirthCountryCode:
          type: string
          description: Country of birth.
          nullable: true
          example: string
        BirthCountrySubdivisionCode:
          type: string
          description: Province of birth.
          nullable: true
          example: string
        BirthPlace:
          type: string
          description: New birth place.
          nullable: true
          example: string
        Occupation:
          type: string
          description: Occupation of the customer.
          nullable: true
          example: string
        Email:
          type: string
          description: New email address.
          format: email
          nullable: true
          example: partner@example.com
        Phone:
          type: string
          description: New phone number.
          format: tel
          nullable: true
          example: string
        LoyaltyCode:
          type: string
          description: Loyalty code of the customer.
          nullable: true
          example: string
        Notes:
          type: string
          description: Internal notes about the customer. Old value will be overwritten.
          nullable: true
          example: string
        CarRegistrationNumber:
          maxLength: 255
          type: string
          description: New registration number of the customer's car.
          nullable: true
          example: '1001'
        DietaryRequirements:
          maxLength: 255
          type: string
          description: Customer's dietary requirements, e.g. Vegan, Halal.
          nullable: true
          example: string
        TaxIdentificationNumber:
          type: string
          description: New tax identification number of the customer.
          nullable: true
          example: '1001'
        CompanyId:
          type: string
          description: Unique identifier of `Company` the customer is associated with.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Address:
          title: Address parameters
          allOf:
          - $ref: '#/components/schemas/AddressParameters'
          description: New address details.
          nullable: true
          example: string
        IdentityCard:
          title: Identity document parameters
          allOf:
          - $ref: '#/components/schemas/DocumentParameters'
          description: New identity card details.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Update identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#update-identity-documents) to update document.
          example: string
        Passport:
          title: Identity document parameters
          allOf:
          - $ref: '#/components/schemas/DocumentParameters'
          description: New passport details.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Update identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#update-identity-documents) to update document.
          example: string
        Visa:
          title: Identity document parameters
          allOf:
          - $ref: '#/components/schemas/DocumentParameters'
          description: New visa details.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Update identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#update-identity-documents) to update document.
          example: string
        DriversLicense:
          title: Identity document parameters
          allOf:
          - $ref: '#/components/schemas/DocumentParameters'
          description: New drivers license details.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use [Update identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#update-identity-documents) to update document.
          example: string
        Classifications:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/CustomerClassificationEnum'
          description: New classifications of the customer.
          nullable: true
        Options:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/CustomerOptionEnum'
          description: Options of the customer.
          nullable: true
        ItalianDestinationCode:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: New Italian destination code of customer.
          nullable: true
          example: string
        ItalianFiscalCode:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: New Italian fiscal code of customer.
          nullable: true
          example: string
        ItalianLotteryCode:
          title: String update value
          maxLength: 15
          minLength: 2
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: New Italian lottery code of customer.
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: CustomerUpdateParameters
    CustomerRelationshipResult:
      title: CustomerRelationshipResult
      required:
      - CustomerRelationships
      type: object
      properties:
        CustomerRelationships:
          type: array
          items:
            $ref: '#/components/schemas/CustomerRelationship'
          description: The relationships for the customers.
        Cursor:
          type: string
          description: Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: CustomerRelationshipResult
    LoyaltyProgramUpdateParameters:
      title: Loyalty program update parameters
      required:
      - LoyaltyProgramId
      type: object
      properties:
        LoyaltyProgramId:
          type: string
          description: Unique identifier of the loyalty program.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Name:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Name of the loyalty program (or `null` if the name should not be updated).
          nullable: true
          example: Example Name
        Type:
          title: Loyalty program type update value
          allOf:
          - $ref: '#/components/schemas/LoyaltyProgramTypeUpdateValue'
          description: Type of the loyalty program (or `null` if the type should not be updated).
          nullable: true
          example: string
        Subscription:
          title: Loyalty program subscription update value
          allOf:
          - $ref: '#/components/schemas/LoyaltyProgramSubscriptionUpdateValue'
          description: Subscription of the loyalty program (or `null` if the subscription should not be updated).
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: LoyaltyProgramUpdateParameters
    ConnectorApiExceptionResult:
      title: ConnectorApiExceptionResult
      type: object
      properties:
        Message:
          type: string
          nullable: true
          example: string
        RequestId:
          type: string
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Details:
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: ConnectorApiExceptionResult
    LoyaltyProgramAdditionResult:
      title: LoyaltyProgramAdditionResult
      required:
      - LoyaltyPrograms
      type: object
      properties:
        LoyaltyPrograms:
          maxItems: 1000
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyProgram'
          description: Added loyalty programs.
      additionalProperties: false
      x-schema-id: LoyaltyProgramAdditionResult
    Int32NullableUpdateValue:
      title: Int32 update value
      type: object
      properties:
        Value:
          type: integer
          description: Value which is to be updated.
          format: int32
          nullable: true
          example: 1
      additionalProperties: false
      x-schema-id: Int32NullableUpdateValue
    ProfileDataDiscriminator:
      title: Profile data discriminator
      enum:
      - Personal
      - Enterprise
      - Platform
      - Static
      - Integration
      type: string
    AccountingItem:
      title: Accounting item
      type: object
      properties:
        Id:
          type: string
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountId:
          type: string
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CustomerId:
          type: string
          format: uuid
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use `AccountId` instead.
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        OrderId:
          type: string
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ServiceId:
          type: string
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ProductId:
          type: string
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        BillId:
          type: string
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        InvoiceId:
          type: string
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountingCategoryId:
          type: string
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CreditCardId:
          type: string
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Type:
          type: string
          nullable: true
          example: string
        SubType:
          type: string
          nullable: true
          example: string
        Name:
          type: string
          nullable: true
          example: Example Name
        Notes:
          type: string
          nullable: true
          example: string
        ConsumptionUtc:
          type: string
          nullable: true
          example: string
        ClosedUtc:
          type: string
          nullable: true
          example: string
        State:
          type: string
          nullable: true
          example: string
        SubState:
          type: string
          nullable: true
          example: string
        Amount:
          title: Extended amount
          allOf:
          - $ref: '#/components/schemas/ExtendedAmount'
          description: ''
          nullable: true
          example: string
        TaxExemptionReasonCode:
          type: string
          description: Code of tax exemption reason. **Restricted!** This property is currently intended for Mews' internal usage and may be subject to change.
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: AccountingItem
    MultipleCompanyContractAddParameters:
      title: MultipleCompanyContractAddParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - TravelAgencyContracts
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        TravelAgencyContracts:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/TravelAgencyContractAddParameters'
          description: Information about travel agency contracts to be created.
      additionalProperties: false
      x-schema-id: MultipleCompanyContractAddParameters
    AddressResult:
      title: AddressResult
      required:
      - Addresses
      type: object
      properties:
        Addresses:
          type: array
          items:
            $ref: '#/components/schemas/AccountAddress'
          description: The collection of added or modified Account addresses, containing address and account information.
      additionalProperties: false
      x-schema-id: AddressResult
    LoyaltyTierUpdateParameters:
      title: Loyalty tier update parameters
      required:
      - LoyaltyTierId
      type: object
      properties:
        LoyaltyTierId:
          type: string
          description: Unique identifier of the loyalty tier.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Name:
          title: String update value
          maxLength: 50
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Name of the loyalty tier \(or `null` if the name should not be updated\).
          nullable: true
          example: Example Name
        Code:
          title: String update value
          maxLength: 50
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Code of the loyalty tier, \(or `null` if the code should not be updated\).
          nullable: true
          example: string
        Ordering:
          title: Int32 update value
          allOf:
          - $ref: '#/components/schemas/Int32UpdateValue'
          description: Ordering of the loyalty tier, \(or `null` if the ordering should not be updated\).
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: LoyaltyTierUpdateParameters
    DecimalNullableUpdateValue:
      title: Decimal update value
      type: object
      properties:
        Value:
          type: number
          description: Value which is to be updated.
          format: double
          nullable: true
          example: 100.0
      additionalProperties: false
      x-schema-id: DecimalNullableUpdateValue
    LoyaltyTierDeleteParameters:
      title: LoyaltyTierDeleteParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - LoyaltyTierIds
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        LoyaltyTierIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifier of the loyalty tiers to be deleted.
      additionalProperties: false
      x-schema-id: LoyaltyTierDeleteParameters
    CustomerFilterParameters:
      title: CustomerFilterParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - Extent
      - Limitation
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of the chains. Required when using Portfolio Access Tokens, ignored otherwise.
          nullable: true
        CreatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: Interval in which Customer was created.
          nullable: true
          x-max-interval-in-months: 3
          example: string
        UpdatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: Interval in which Customer was updated.
          nullable: true
          x-max-interval-in-months: 3
          example: string
        Extent:
          title: Customer extent
          allOf:
          - $ref: '#/components/schemas/CustomerExtent'
          description: Extent of data to be returned.
          example: string
        DeletedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: Interval in which Customer was deleted. `ActivityStates` value `Deleted` should be provided with this filter to get expected results.
          nullable: true
          x-max-interval-in-months: 3
          example: string
        ActivityStates:
          type: array
          items:
            $ref: '#/components/schemas/ActivityStates'
          description: Whether to return only active, only deleted or both records.
          nullable: true
        CustomerIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of Customers. Required if no other filter is provided.
          nullable: true
        CompanyIds:
          maxItems: 1
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifier of the Company the customer is associated with.
          nullable: true
        Emails:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
          description: Emails of the [Customers](https://mews-systems.gitbook.io/connector-api/operations/#customer).
          nullable: true
        FirstNames:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
          description: First names of the [Customers](https://mews-systems.gitbook.io/connector-api/operations/#customer).
          nullable: true
        LastNames:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
          description: Last names of the [Customers](https://mews-systems.gitbook.io/connector-api/operations/#customer).
          nullable: true
        LoyaltyCodes:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
          description: Loyalty codes of the [Customers](https://mews-systems.gitbook.io/connector-api/operations/#customer).
          nullable: true
        Limitation:
          allOf:
          - $ref: '#/components/schemas/Limitation'
          description: Limitation on the quantity of data returned.
          example: string
      additionalProperties: false
      x-schema-id: CustomerFilterParameters
    Companionship:
      title: Companionship
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of `Companionship`.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CustomerId:
          type: string
          description: Unique identifier of Customer.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ReservationGroupId:
          type: string
          description: Unique identifier of ReservationGroup.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ReservationId:
          type: string
          description: Unique identifier of reservation.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: Companionship
    LoyaltyProgramSubscription:
      title: Loyalty program subscription
      enum:
      - Free
      - Paid
      type: string
      description: 'Subscription of the loyalty program.


        Free


        Paid'
      x-enumNames:
      - Free
      - Paid
      x-enumDescriptions:
      - ''
      - ''
      x-schema-id: LoyaltyProgramSubscription
    LoyaltyTierAddParameters:
      title: Loyalty tier add parameters
      required:
      - Code
      - LoyaltyProgramId
      - Name
      - Ordering
      type: object
      properties:
        LoyaltyProgramId:
          type: string
          description: Unique identifier of the loyalty program the tier belongs to.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Name:
          maxLength: 50
          minLength: 1
          type: string
          description: Name of the loyalty tier.
          example: Example Name
        Code:
          maxLength: 50
          minLength: 1
          type: string
          description: Code of the loyalty tier.
          example: string
        Ordering:
          type: integer
          description: Ordering of the loyalty tier.
          format: int32
          example: 1
      additionalProperties: false
      x-schema-id: LoyaltyTierAddParameters
    LoyaltyMembershipAddParameters:
      title: Loyalty membership parameters
      required:
      - AccountId
      - IsPrimary
      - LoyaltyProgramId
      type: object
      properties:
        AccountId:
          type: string
          description: Unique identifier of the customer account.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        LoyaltyProgramId:
          type: string
          description: Unique identifier of the loyalty program.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        IsPrimary:
          type: boolean
          description: Defines the primary loyalty membership for the account.
          example: true
        State:
          allOf:
          - $ref: '#/components/schemas/LoyaltyMembershipStateEnum'
          description: 'State of the loyalty membership. The default is `Enrolled`.


            New


            Pending


            Enrolled


            Canceled


            Declined'
          nullable: true
          example: string
        Code:
          maxLength: 255
          type: string
          description: Loyalty membership code, such as an identification number printed on a loyalty card visible to the customer.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use `MembershipNumber` instead.
          example: string
        MembershipNumber:
          maxLength: 255
          type: string
          description: Customer-facing membership numbers, e.g., printed on a loyalty card.
          nullable: true
          example: '1001'
        Points:
          type: integer
          description: The loyalty points for the account in that membership.
          format: int32
          nullable: true
          example: 1
        ExpirationDate:
          type: string
          description: Expiration date of the loyalty membership in UTC timezone in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        Url:
          type: string
          description: URL of the loyalty membership in external loyalty system.
          format: uri
          nullable: true
          example: https://api.mews.com/api/connector/v1
        LoyaltyTierId:
          type: string
          description: Unique identifier of the loyalty tier.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: LoyaltyMembershipAddParameters
    CustomerItemResult:
      title: CustomerItemResult
      type: object
      properties:
        Customers:
          type: array
          items:
            $ref: '#/components/schemas/CustomerItems'
          description: The customers with their items.
          nullable: true
      additionalProperties: false
      x-schema-id: CustomerItemResult
    IdentityDocumentV20241025:
      title: Identity document (ver 2024-10-25)
      required:
      - CustomerId
      - Id
      - Number
      - Type
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the document.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CustomerId:
          type: string
          description: Identifier of the `Customer`.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Type:
          title: Document type
          allOf:
          - $ref: '#/components/schemas/IdentityDocumentTypeEnum'
          description: 'Type of the document.


            IdentityCard


            Passport


            Visa


            DriversLicense'
          x-enumNames:
          - IdentityCard
          - Passport
          - Visa
          - DriversLicense
          x-enumDescriptions:
          - ''
          - ''
          - ''
          - ''
          example: string
        Number:
          minLength: 1
          type: string
          description: Number of the document (e.g. passport number). The value is an empty string when the number is not collected in certain regions, such as The Netherlands.
          example: '1001'
        ExpirationDate:
          type: string
          description: Expiration date in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        IssuanceDate:
          type: string
          description: Date of issuance in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        IssuingCountryCode:
          type: string
          description: ISO 3166-1 code of the `Country`.
          nullable: true
          example: string
        IssuingCountrySubdivisionCode:
          type: string
          description: Identifier of the country subdivision where the document was issued (province, state or region).
          nullable: true
          example: string
        IssuingCity:
          type: string
          description: City where the document was issued.
          nullable: true
          example: string
        IdentityDocumentSupportNumber:
          type: string
          description: Identity document support number. Only required for Spanish identity cards in Spanish hotels.
          nullable: true
          example: '1001'
      additionalProperties: false
      x-schema-id: IdentityDocumentV20241025
    InvoicePaymentData:
      title: Invoice payment item data
      required:
      - InvoiceId
      type: object
      properties:
        InvoiceId:
          type: string
          description: Unique identifier of the invoice `Bill`.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: InvoicePaymentData
    OrderItemOld:
      title: Order item
      required:
      - AccountId
      - AccountingState
      - Amount
      - CreatedUtc
      - CreatorProfileId
      - Data
      - Id
      - OrderId
      - OriginalAmount
      - RevenueType
      - UnitAmount
      - UpdatedUtc
      - UpdaterProfileId
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the item.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountId:
          type: string
          description: Unique identifier of the account (for example `Customer`) the item belongs to.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        OrderId:
          type: string
          description: Unique identifier of the order (or `Reservation` which is a special type of order) the item belongs to.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        BillId:
          type: string
          description: Unique identifier of the `Bill` the item is assigned to.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountingCategoryId:
          type: string
          description: Unique identifier of the `AccountingCategory` the item belongs to.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        UnitCount:
          type: integer
          description: Unit count of item, i.e. the number of sub-items or units, if applicable.
          format: int32
          example: 1
        UnitAmount:
          title: Amount
          allOf:
          - $ref: '#/components/schemas/Amount'
          description: Unit amount of item, i.e. the amount of each individual sub-item or unit, if applicable.
          example: string
        Amount:
          title: Extended amount
          allOf:
          - $ref: '#/components/schemas/ExtendedAmount'
          description: Amount of item; note a negative amount represents a rebate or payment.
          example: string
        OriginalAmount:
          title: Extended amount
          allOf:
          - $ref: '#/components/schemas/ExtendedAmount'
          description: Amount of item; note a negative amount represents a rebate or payment. Contains the earliest known value in conversion chain.
          example: string
        RevenueType:
          minLength: 1
          type: string
          description: Revenue type of the item.
          example: string
        CreatorProfileId:
          type: string
          description: Unique identifier of the user who created the item.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        UpdaterProfileId:
          type: string
          description: Unique identifier of the user who updated the item.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CreatedUtc:
          minLength: 1
          type: string
          description: Creation date and time of the item in UTC timezone in ISO 8601 format.
          format: date
          example: '2026-06-02'
        UpdatedUtc:
          minLength: 1
          type: string
          description: Last update date and time of the item in UTC timezone in ISO 8601 format.
          format: date
          example: '2026-06-02'
        ConsumedUtc:
          type: string
          description: Date and time of the item consumption in UTC timezone in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        CanceledUtc:
          type: string
          description: Cancellation date and time of the item in UTC timezone in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        ClosedUtc:
          type: string
          description: Date and time of the item bill closure in UTC timezone in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        StartUtc:
          type: string
          description: Start date and time of the item in UTC timezone in ISO 8601 format.
          format: date
          nullable: true
          example: '2026-06-02'
        AccountingState:
          minLength: 1
          type: string
          description: Accounting state of the item.
          example: string
        Data:
          title: Order item data
          type: object
          properties:
            Discriminator:
              $ref: '#/components/schemas/OrderItemTypeOld'
            Value:
              oneOf:
              - $ref: '#/components/schemas/RebateOrderItemData'
              - $ref: '#/components/schemas/ProductOrderItemData'
              description: Based on order item discriminator or `null` for types without any additional data.
              nullable: true
          description: Additional data specific to particular order item.
          x-coproduct: true
          x-schema-id: OrderItemOldDataCoproductOfOrderItemTypeOld
      additionalProperties: false
      x-schema-id: OrderItemOld
    AccountAddress:
      title: Account address
      required:
      - AccountType
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the address.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountId:
          type: string
          description: Unique identifier of a [Company](https://mews-systems.gitbook.io/connector-api/operations/companies/#company) or a [Customer](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer) within the enterprise.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ChainId:
          type: string
          description: Unique identifier of the chain.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountType:
          $ref: '#/components/schemas/AccountType'
        Line1:
          maxLength: 1023
          type: string
          description: First line of the address.
          nullable: true
          example: string
        Line2:
          maxLength: 255
          type: string
          description: Second line of the address.
          nullable: true
          example: string
        City:
          maxLength: 255
          type: string
          description: The city.
          nullable: true
          example: string
        PostalCode:
          maxLength: 255
          type: string
          description: Postal code.
          nullable: true
          example: string
        CountryCode:
          type: string
          description: ISO 3166-1 alpha-2 code of the Country.
          nullable: true
          example: string
        CountrySubdivisionCode:
          type: string
          description: ISO 3166-2 code of the administrative division, e.g. DE-BW.
          nullable: true
          example: string
        Latitude:
          type: number
          description: The latitude.
          format: double
          nullable: true
          example: 100.0
        Longitude:
          type: number
          description: The longitude.
          format: double
          nullable: true
          example: 100.0
        UpdatedUtc:
          type: string
          description: Last update date and time of the address in UTC timezone in ISO 8601 format.
          format: date-time
          nullable: true
          example: '2026-06-02T14:30:00Z'
        IsActive:
          type: boolean
          description: Whether the address is still active.
          example: true
      additionalProperties: false
      x-schema-id: AccountAddress
    AddressUpdateParameters:
      title: Account address update parameters
      required:
      - AddressId
      type: object
      properties:
        AddressId:
          type: string
          description: Unique identifier of the address.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Line1:
          title: String update value
          maxLength: 255
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: First line of the address.
          nullable: true
          example: string
        Line2:
          title: String update value
          maxLength: 255
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Second line of the address.
          nullable: true
          example: string
        City:
          title: String update value
          maxLength: 255
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: The city.
          nullable: true
          example: string
        PostalCode:
          title: String update value
          maxLength: 255
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Postal code.
          format: postal-code
          nullable: true
          example: string
        CountryCode:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: ISO 3166-1 alpha-2 code of the Country.
          nullable: true
          example: string
        CountrySubdivisionCode:
          title: String update value
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: ISO 3166-2 code of the administrative division, e.g. `DE-BW`.
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: AddressUpdateParameters
    ReservationPurpose:
      title: Reservation purpose
      enum:
      - Leisure
      - Business
      - Student
      type: string
    ResourceFeatureClassification:
      title: Resource feature classification
      enum:
      - SeaView
      - RiverView
      - OceanView
      - TwinBeds
      - DoubleBed
      - RollawayBed
      - UpperBed
      - LowerBed
      - Balcony
      - AccessibleBathroom
      - AccessibleRoom
      - ElevatorAccess
      - HighFloor
      - Kitchenette
      - AirConditioning
      - PrivateJacuzzi
      - PrivateSauna
      - EnsuiteRoom
      - PrivateBathroom
      - SharedBathroom
      type: string
      description: Classification of `ResourceFeature`.
    CustomerMergeParameters:
      title: CustomerMergeParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - SourceCustomerId
      - TargetCustomerId
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        SourceCustomerId:
          type: string
          description: Unique identifier of the source [Customer](https://mews-systems.gitbook.io/connector-api/operations/#customer).
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        TargetCustomerId:
          type: string
          description: Unique identifier of the target [Customer](https://mews-systems.gitbook.io/connector-api/operations/#customer).
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: CustomerMergeParameters
    Unit:
      type: object
      additionalProperties: false
    LoyaltyMembershipFilterParameters:
      title: Loyalty membership filter parameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - Limitation
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.
          nullable: true
        CreatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: The time interval during which the membership was created.
          nullable: true
          x-max-interval-in-months: 3
          example: string
        UpdatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: The time interval during which the membership was last updated.
          nullable: true
          x-max-interval-in-months: 3
          example: string
        LoyaltyMembershipIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of [Loyalty memberships](https://mews-systems.gitbook.io/connector-api/operations/#loyalty-membership).
          nullable: true
        AccountIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of accounts (for example [Customers](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer) or [Companies](https://mews-systems.gitbook.io/connector-api/operations/companies/#company)) the membership is associated with.
          nullable: true
        LoyaltyProgramIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of [Loyalty programs](https://mews-systems.gitbook.io/connector-api/operations/loyaltyprograms/#loyalty-program).
          nullable: true
        MembershipStates:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyMembershipStateEnum'
          description: States of the loyalty memberships.
          nullable: true
        ActivityStates:
          type: array
          items:
            $ref: '#/components/schemas/ActivityStates'
          description: Whether to return only active, only deleted or both records.
          nullable: true
        Codes:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
          description: List of loyalty membership codes, such as identification numbers printed on loyalty cards visible to the customer.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use `MembershipNumbers` instead.
        MembershipNumbers:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
          description: Customer-facing membership numbers, e.g., printed on a loyalty card.
          nullable: true
        ProviderMembershipIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
          description: List of unique loyalty membership identifiers assigned and managed by the external loyalty provider's system.
          nullable: true
        Limitation:
          allOf:
          - $ref: '#/components/schemas/Limitation'
          description: Limitation on the quantity of data returned.
          example: string
      additionalProperties: false
      x-schema-id: LoyaltyMembershipFilterParameters
    CreditRatingParameters:
      title: Credit rating parameters
      type: object
      properties:
        Basic:
          allOf:
          - $ref: '#/components/schemas/CreditRatingBasicEnum'
          description: 'Indicates the credit status of a company.


            CreditOk (Company can book services.)


            PaymentRequiredUpfront (Company must pay upfront.)


            LocalDecisionRequired (Requires local approval.)'
          nullable: true
          example: string
      additionalProperties: false
      description: Credit rating to define creditworthiness of the company.
      x-schema-id: CreditRatingParameters
    CustomerOptionEnum:
      title: Customer option
      enum:
      - SendMarketingEmails
      - Invoiceable
      - BillAddressObjection
      - SendMarketingPostalMail
      - SendPartnerMarketingEmails
      - SendPartnerMarketingPostalMail
      - WithdrawCardConsent
      - GuestPhotoConsent
      - IdPhotosConsent
      type: string
      description: '


        SendMarketingEmails


        Invoiceable


        BillAddressObjection


        SendMarketingPostalMail


        SendPartnerMarketingEmails


        SendPartnerMarketingPostalMail


        WithdrawCardConsent


        GuestPhotoConsent (Whether to ask for consent to take a guest photo.)


        IdPhotosConsent (Whether to ask for consent to take identity document photos.)'
      x-enumNames:
      - SendMarketingEmails
      - Invoiceable
      - BillAddressObjection
      - SendMarketingPostalMail
      - SendPartnerMarketingEmails
      - SendPartnerMarketingPostalMail
      - WithdrawCardConsent
      - GuestPhotoConsent
      - IdPhotosConsent
      x-enumDescriptions:
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - Whether to ask for consent to take a guest photo.
      - Whether to ask for consent to take identity document photos.
    LoyaltyMembershipResult:
      title: Loyalty membership result
      required:
      - LoyaltyMemberships
      type: object
      properties:
        LoyaltyMemberships:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyMembership'
          description: The loyalty memberships of the enterprise.
        Cursor:
          type: string
          description: Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: LoyaltyMembershipResult
    OrderItemTypeOld:
      title: Order item data discriminator
      enum:
      - CancellationFee
      - Rebate
      - Deposit
      - ExchangeRateDifference
      - CustomItem
      - Surcharge
      - SurchargeDiscount
      - SpaceOrder
      - ProductOrder
      - Other
      - TaxCorrection
      - ResourceUpgradeFee
      - InvoiceFee
      type: string
      x-enumDescriptions:
      - No additional data.
      - '[Rebate order item data](https://mews-systems.gitbook.io/connector-api/operations/accountingitems#rebate-order-item-data)'
      - No additional data.
      - No additional data.
      - No additional data.
      - No additional data.
      - No additional data.
      - No additional data.
      - '[Product order item data](https://mews-systems.gitbook.io/connector-api/operations/accountingitems#product-order-item-data)'
      - No additional data.
      - No additional data.
      - No additional data.
      - No additional data.
    IdentityDocumentResult:
      title: IdentityDocumentResult
      required:
      - IdentityDocuments
      type: object
      properties:
        IdentityDocuments:
          maxItems: 1000
          type: array
          items:
            $ref: '#/components/schemas/IdentityDocumentV20241025'
          description: The identity documents of customers.
        Cursor:
          type: string
          description: Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: IdentityDocumentResult
    TaxValue:
      title: Tax value
      required:
      - Value
      type: object
      properties:
        Code:
          type: string
          description: Code corresponding to tax type.
          nullable: true
          example: string
        Value:
          type: number
          description: Amount of tax applied.
          format: double
          example: 100.0
      additionalProperties: false
      x-schema-id: TaxValue
    LoyaltyProgramAddParameters:
      title: Loyalty program parameters
      required:
      - Code
      - Name
      - Subscription
      - Type
      type: object
      properties:
        Name:
          maxLength: 100
          minLength: 1
          type: string
          description: Name of the loyalty program.
          example: Example Name
        Code:
          maxLength: 50
          minLength: 1
          type: string
          description: Code of the loyalty program.
          example: string
        Type:
          $ref: '#/components/schemas/LoyaltyProgramType'
        Subscription:
          $ref: '#/components/schemas/LoyaltyProgramSubscription'
      additionalProperties: false
      x-schema-id: LoyaltyProgramAddParameters
    ExtendedAmount:
      title: Extended amount
      required:
      - Breakdown
      - Currency
      - GrossValue
      - NetValue
      - TaxValues
      type: object
      properties:
        Currency:
          minLength: 1
          type: string
          description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency).
          format: currency
          example: EUR
        NetValue:
          type: number
          description: Net value without taxes.
          format: double
          example: 100.0
        GrossValue:
          type: number
          description: Gross value including all taxes.
          format: double
          example: 100.0
        TaxValues:
          type: array
          items:
            $ref: '#/components/schemas/TaxValue'
          description: The tax values applied.
        Breakdown:
          title: Tax breakdown
          allOf:
          - $ref: '#/components/schemas/TaxBreakdown'
          description: Information about individual tax amounts.
          example: string
        Value:
          type: number
          format: double
          nullable: true
          example: 100.0
        Net:
          type: number
          format: double
          nullable: true
          example: 100.0
        Tax:
          type: number
          format: double
          nullable: true
          example: 100.0
        TaxRate:
          type: number
          format: double
          nullable: true
          example: 100.0
      additionalProperties: false
      description: ''
      x-schema-id: ExtendedAmount
    CompanyTimeFilter:
      title: Company Time Filter
      enum:
      - Created
      - Updated
      type: string
    TaxBreakdown:
      title: Tax breakdown
      required:
      - Items
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/TaxBreakdownItem'
          description: Tax breakdown items per each tax rate applied.
      additionalProperties: false
      x-schema-id: TaxBreakdown
    PaymentCardPaymentData:
      title: Credit card payment item data
      type: object
      properties:
        PaymentCardId:
          type: string
          description: Unique identifier of the `CreditCard`.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: PaymentCardPaymentData
    CustomerItemParameters:
      title: CustomerItemParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - CustomerIds
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        CustomerIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Customer`.
        Currency:
          type: string
          description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency) the item costs should be converted to.
          format: date-time
          nullable: true
          example: '2026-06-02T14:30:00Z'
      additionalProperties: false
      x-schema-id: CustomerItemParameters
    Company:
      title: Company
      required:
      - ChainId
      - CreditRating
      - Id
      - IsActive
      - Name
      - Number
      - Options
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the company.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ChainId:
          type: string
          description: Unique identifier of the chain.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Name:
          minLength: 1
          type: string
          description: Name of the company.
          example: Example Name
        MotherCompanyId:
          type: string
          description: Unique identifier of mother company.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        InvoicingEmail:
          type: string
          description: Email for issuing invoices to the company.
          format: email
          nullable: true
          example: partner@example.com
        WebsiteUrl:
          type: string
          description: The website url of the company.
          format: uri
          nullable: true
          example: https://api.mews.com/api/connector/v1
        InvoiceDueInterval:
          type: string
          description: The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
          nullable: true
          example: string
        Options:
          title: Company Options
          allOf:
          - $ref: '#/components/schemas/CompanyOptions'
          description: Options of the company.
          example: string
        CreditRating:
          title: Credit Rating
          allOf:
          - $ref: '#/components/schemas/CreditRating'
          description: Credit rating to define creditworthiness of the company.
          example: string
        Department:
          type: string
          description: The internal segmentation of a company, e.g. sales department.
          nullable: true
          example: string
        DunsNumber:
          type: string
          description: The Dun & Bradstreet unique 9-digit DUNS number.
          nullable: true
          example: '1001'
        ReferenceIdentifier:
          type: string
          description: External system identifier - custom identifier used by an external system such as an external database.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountingCode:
          type: string
          description: Accounting code of the company.
          nullable: true
          example: string
        AdditionalTaxIdentifier:
          type: string
          description: Additional tax identifier of the company.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        BillingCode:
          type: string
          description: Billing code of the company.
          nullable: true
          example: string
        Contact:
          type: string
          description: Other contact details, such as telephone, email or similar.
          nullable: true
          example: string
        ContactPerson:
          type: string
          description: Contact person of the company.
          nullable: true
          example: string
        ElectronicInvoiceIdentifier:
          type: string
          description: Electronic invoice identifier of the company.
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use `AdditionalTaxIdentifier` instead.
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Identifier:
          type: string
          description: Fiscal or legal identifier of the company.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Iata:
          type: string
          description: Iata of the company.
          nullable: true
          example: string
        IsActive:
          type: boolean
          description: Whether the company is still active.
          example: true
        Notes:
          type: string
          description: Additional notes.
          nullable: true
          example: string
        Number:
          type: integer
          description: Unique number of the company (max 19 digits).
          format: int64
          example: 1
        TaxIdentifier:
          type: string
          description: Tax identification number of the company.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Telephone:
          type: string
          description: Contact telephone number.
          format: tel
          nullable: true
          example: string
        CreatedUtc:
          type: string
          description: Date of [Company](https://mews-systems.gitbook.io/connector-api/operations/#company) creation date and time.
          format: date-time
          nullable: true
          example: '2026-06-02T14:30:00Z'
        UpdatedUtc:
          type: string
          description: Date of [Company](https://mews-systems.gitbook.io/connector-api/operations/#company) last update date and time.
          format: date-time
          nullable: true
          example: '2026-06-02T14:30:00Z'
        Address:
          title: Address
          allOf:
          - $ref: '#/components/schemas/OldAddress'
          description: ''
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use AddressId instead.
          example: string
        AddressId:
          type: string
          description: Unique identifier of the company [Address](https://mews-systems.gitbook.io/connector-api/operations/addresses/#account-address).
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        MergeTargetId:
          type: string
          description: Unique identifier of the account (Customer) to which this company is linked.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        TaxIdentificationNumber:
          type: string
          nullable: true
          deprecated: true
          x-deprecatedMessage: Use TaxIdentifier instead.
          example: '1001'
        ExternalIdentifier:
          maxLength: 255
          type: string
          description: Identifier of company from external system.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: Company
    ContractResult:
      title: ContractResult
      required:
      - TravelAgencyContracts
      type: object
      properties:
        TravelAgencyContracts:
          type: array
          items:
            $ref: '#/components/schemas/TravelAgencyContract'
          description: The travel agency contracts.
        Cursor:
          type: string
          description: Unique identifier of the last and hence oldest contract returned. This can be used in `Limitation` in a subsequent request to fetch the next batch of older messages.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: ContractResult
    TravelAgencyContractAddParameters:
      title: Travel agency contract parameters
      required:
      - CompanyId
      - Options
      - ServiceId
      type: object
      properties:
        ServiceId:
          type: string
          description: Unique identifier of the `Service` the travel agency contract is created to.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CompanyId:
          type: string
          description: Unique identifier of the `Company` the travel agency contract is issued to.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CommissionIncluded:
          type: boolean
          description: Whether commission of the travel agency is included in the rate.
          nullable: true
          example: true
        Commission:
          type: number
          description: Commission of the travel agency. Value must be between 0 and 1.
          format: double
          nullable: true
          example: 100.0
        ChannelManagerBusinessSegmentId:
          type: string
          description: Unique identifier of the `BusinessSegment` used for incoming reservations originating from Channel Managers, for this particular contract.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ChannelManagerAbsoluteAdjustment:
          type: number
          description: Flat fee added to (or subtracted from) the reservation price when coming from Channel Managers.
          format: double
          nullable: true
          example: 100.0
        ChannelManagerRelativeAdjustment:
          type: number
          description: Percentage of the reservation price added to (or subtracted from) price when coming from Channel Managers. Value must be between -1 and 1.
          format: double
          nullable: true
          example: 100.0
        Options:
          title: Travel agency contract options
          allOf:
          - $ref: '#/components/schemas/TravelAgencyContractOptions'
          description: Options of the travel agency contract.
          example: string
        AccountingCode:
          type: string
          description: Accounting code of the travel agency contract.
          nullable: true
          example: string
        InvoiceDueInterval:
          type: string
          description: The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
          nullable: true
          example: string
        ContactPerson:
          type: string
          description: Contact person of the travel agency.
          nullable: true
          example: string
        ContactEmail:
          type: string
          description: Contact email of the travel agency.
          format: email
          nullable: true
          example: partner@example.com
        AdditionalContactInfo:
          type: string
          description: Additional contact info of the travel agency.
          nullable: true
          example: string
        Notes:
          type: string
          description: Additional notes of the travel agency contract.
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: TravelAgencyContractAddParameters
    LoyaltyMembershipStateUpdateValue:
      title: Loyalty membership state update value
      type: object
      properties:
        Value:
          title: Loyalty membership state
          allOf:
          - $ref: '#/components/schemas/LoyaltyMembershipStateEnum'
          description: Value which is to be updated.
          x-enumNames:
          - New
          - Pending
          - Enrolled
          - Canceled
          - Declined
          x-enumDescriptions:
          - ''
          - ''
          - ''
          - ''
          - ''
          example: string
      additionalProperties: false
      x-schema-id: LoyaltyMembershipStateUpdateValue
    LoyaltyTierWriteResult:
      title: LoyaltyTierWriteResult
      required:
      - LoyaltyTiers
      type: object
      properties:
        LoyaltyTiers:
          maxItems: 1000
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyTier'
          description: The loyalty tiers of the loyalty program within the chain.
      additionalProperties: false
      x-schema-id: LoyaltyTierWriteResult
    ActivityStates:
      title: Activity state
      enum:
      - Deleted
      - Active
      type: string
      description: Activity states used for filtering.
    LoyaltyTierFilterParameters:
      title: LoyaltyTierFilterParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - Limitation
      - LoyaltyProgramIds
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.
          nullable: true
        LoyaltyProgramIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of [Loyalty programs](https://mews-systems.gitbook.io/connector-api/operations/#loyalty-program).
        LoyaltyTierIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of [Loyalty tiers](https://mews-systems.gitbook.io/connector-api/operations/#loyalty-tier).
          nullable: true
        ActivityStates:
          type: array
          items:
            $ref: '#/components/schemas/ActivityStates'
          description: Whether to return only active, only deleted or both records.
          nullable: true
        UpdatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: Interval of `Loyalty tier` last update date and time.
          nullable: true
          x-max-interval-in-months: 3
          example: string
        Limitation:
          allOf:
          - $ref: '#/components/schemas/Limitation'
          description: Limitation on the quantity of data returned.
          example: string
      additionalProperties: false
      x-schema-id: LoyaltyTierFilterParameters
    CustomerFileParameters:
      title: CustomerFileParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - CustomerId
      - Data
      - Name
      - Type
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CustomerId:
          type: string
          description: Unique identifier of the [Customer](https://mews-systems.gitbook.io/connector-api/operations/#customer).
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Name:
          minLength: 1
          type: string
          description: Name of the file.
          example: Example Name
        Type:
          minLength: 1
          type: string
          description: MIME type of the file (e.g. `application/pdf`).
          example: string
        Data:
          minLength: 1
          type: string
          description: Base64-encoded data of the file.
          example: string
      additionalProperties: false
      x-schema-id: CustomerFileParameters
    CompanionshipFilterParameters:
      title: CompanionshipFilterParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - Extent
      - Limitation
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        Limitation:
          allOf:
          - $ref: '#/components/schemas/Limitation'
          description: Limitation on the quantity of data returned and optional Cursor for the starting point of data.
          example: string
        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
        CompanionshipIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Companionship`. Required if no other filter is provided.
          nullable: true
        Extent:
          title: Companionship extent
          allOf:
          - $ref: '#/components/schemas/CompanionshipExtent'
          description: Extent of data to be returned. E.g. it is possible to specify that together with the companionships, customers, reservations, and reservation groups should be also returned.
          example: string
        ReservationIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Reservation`. Required if no other filter is provided.
          nullable: true
        CustomerIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Customer`. Required if no other filter is provided.
          nullable: true
        ReservationGroupIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `ReservationGroup`. Required if no other filter is provided.
          nullable: true
        UpdatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: Interval in which the `Companionship` was updated. Must be used together with at least one another filter.
          nullable: true
          x-max-interval-in-months: 3
          example: string
      additionalProperties: false
      x-schema-id: CompanionshipFilterParameters
    MultipleLoyaltyMembershipAddParameters:
      title: MultipleLoyaltyMembershipAddParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - LoyaltyMemberships
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        ChainId:
          type: string
          description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        LoyaltyMemberships:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyMembershipAddParameters'
          description: Loyalty memberships to be added.
      additionalProperties: false
      x-schema-id: MultipleLoyaltyMembershipAddParameters
  securitySchemes:
    MewsClientToken:
      type: apiKey
      in: header
      name: ClientToken
      description: Mews authentication is performed by supplying ClientToken, AccessToken and Client as fields in the JSON request body (not as HTTP headers). This securityScheme is a tooling-compatible representation of the ClientToken credential. ClientToken is unique to your application and identifies the API client.
    MewsAccessToken:
      type: apiKey
      in: header
      name: AccessToken
      description: Tooling-compatible representation of the AccessToken credential, which is supplied in the JSON request body. AccessToken is unique to the connection with a property (enterprise) and identifies the property or properties whose data and services you can access. Portfolio Access Tokens enable multi-property access with a single token.
servers:
- url: https://api.mews.com
  description: Production
- url: https://api.mews-demo.com
  description: Demo / sandbox
security:
- MewsClientToken: []
  MewsAccessToken: []
tags:
- name: Addresses
- name: Age categories
- name: Companies
- name: Companionships
- name: Company contracts
- name: Customers
- name: Identity documents
- name: Loyalty memberships
- name: Loyalty programs
- name: Loyalty tiers