openapi: 3.0.4
info:
  title: Mews Booking Engine API (Distributor) Account notes Company contracts API
  version: v1
  description: The Mews Booking Engine API (historically the Distributor API, served from /api/distributor/v1) lets developers build guest-facing booking engines that create reservations directly in Mews. It exposes enterprise configuration, availability, pricing, products, vouchers, payment cards, and reservation group creation for front-end client consumption.
  x-generated-from: documentation
  x-source-url: https://api.mews.com/Swagger/distributor/swagger.json
  x-last-validated: '2026-06-02'
servers:
- url: https://api.mews.com
  description: Production
- url: https://api.mews-demo.com
  description: Demo / sandbox
security:
- MewsClientToken: []
  MewsAccessToken: []
tags:
- name: Company contracts
paths:
  /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: null
                  Notes: null
        '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:
        delay: 0
        dispatcher: FALLBACK
  /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: null
                Notes: null
      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: null
                  Notes: null
        '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:
        delay: 0
        dispatcher: FALLBACK
  /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: null
                Notes: null
      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: null
                  Notes: null
        '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:
        delay: 0
        dispatcher: FALLBACK
  /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:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    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
    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
    Unit:
      type: object
      additionalProperties: false
    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
    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
    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
    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
    ActivityStates:
      title: Activity state
      enum:
      - Deleted
      - Active
      type: string
      description: Activity states used for filtering.
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
  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.