Mews Companies API

The Companies API from Mews — 4 operation(s) for companies.

OpenAPI Specification

mews-systems-companies-api-openapi.yml Raw ↑
openapi: 3.0.4
info:
  title: Mews Booking Engine API (Distributor) Account notes Companies 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: Companies
paths:
  /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: null
              Identifier: null
              TaxIdentifier: null
              AdditionalTaxIdentifier: null
              BillingCode: null
              AccountingCode: null
              Address: null
              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: null
                  TaxIdentifier: null
                  AdditionalTaxIdentifier: null
                  ElectronicInvoiceIdentifier: null
                  InvoiceDueInterval: P2DT23H
                  AccountingCode: null
                  MotherCompanyId: null
                  CreatedUtc: '2022-07-11T09:56:54Z'
                  UpdatedUtc: '2022-07-11T09:56:54Z'
                  AddressId: bab7441c-4b82-43bc-8001-ab0400a346ec
                  BillingCode: null
                  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: null
                  TaxIdentifier: null
                  AdditionalTaxIdentifier: null
                  ElectronicInvoiceIdentifier: null
                  InvoiceDueInterval: P2DT23H
                  AccountingCode: null
                  MotherCompanyId: null
                  CreatedUtc: '2022-07-11T09:56:54Z'
                  UpdatedUtc: '2022-07-11T09:56:54Z'
                  AddressId: null
                  BillingCode: null
                  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:
        delay: 0
        dispatcher: FALLBACK
  /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: null
              TaxIdentifier: null
              AdditionalTaxIdentifier: null
              BillingCode: null
              AccountingCode: null
              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: null
                  TaxIdentifier: null
                  AdditionalTaxIdentifier: null
                  ElectronicInvoiceIdentifier: null
                  InvoiceDueInterval: P2DT23H
                  AccountingCode: null
                  MotherCompanyId: null
                  CreatedUtc: '2022-07-11T09:56:54Z'
                  UpdatedUtc: '2022-07-11T09:56:54Z'
                  AddressId: bab7441c-4b82-43bc-8001-ab0400a346ec
                  BillingCode: null
                  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: null
                  TaxIdentifier: null
                  AdditionalTaxIdentifier: null
                  ElectronicInvoiceIdentifier: null
                  InvoiceDueInterval: P2DT23H
                  AccountingCode: null
                  MotherCompanyId: null
                  CreatedUtc: '2022-07-11T09:56:54Z'
                  UpdatedUtc: '2022-07-11T09:56:54Z'
                  AddressId: null
                  BillingCode: null
                  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:
        delay: 0
        dispatcher: FALLBACK
  /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: null
                  TaxIdentifier: null
                  AdditionalTaxIdentifier: null
                  ElectronicInvoiceIdentifier: null
                  InvoiceDueInterval: P2DT23H
                  AccountingCode: null
                  MotherCompanyId: null
                  CreatedUtc: '2022-07-11T09:56:54Z'
                  UpdatedUtc: '2022-07-11T09:56:54Z'
                  AddressId: bab7441c-4b82-43bc-8001-ab0400a346ec
                  BillingCode: null
                  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: null
                  TaxIdentifier: null
                  AdditionalTaxIdentifier: null
                  ElectronicInvoiceIdentifier: null
                  InvoiceDueInterval: P2DT23H
                  AccountingCode: null
                  MotherCompanyId: null
                  CreatedUtc: '2022-07-11T09:56:54Z'
                  UpdatedUtc: '2022-07-11T09:56:54Z'
                  AddressId: null
                  BillingCode: null
                  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:
        delay: 0
        dispatcher: FALLBACK
  /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
                    Detail

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mews-systems/refs/heads/main/openapi/mews-systems-companies-api-openapi.yml