Mews

Mews Companies API

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

Documentation GitHub OpenAPI

Operations 4

POST /api/connector/v1/companies/add Add company #

POST /api/connector/v1/companies/update Update company #

POST /api/connector/v1/companies/getAll Get all companies #

POST /api/connector/v1/companies/delete Delete companies #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/mews-com-companies-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: BookingEngineApi Account notes Companies API
  version: v1
servers:
- url: https://api.mews.com
tags:
- name: Companies
paths:
  /api/connector/v1/companies/add:
    post:
      tags:
      - Companies
      summary: 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'
        '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'
        '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'
        '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'
        '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'
        '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'
        '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'
  /api/connector/v1/companies/update:
    post:
      tags:
      - Companies
      summary: 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'
        '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'
        '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'
        '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'
        '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'
        '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'
        '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'
  /api/connector/v1/companies/getAll:
    post:
      tags:
      - Companies
      summary: 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'
        '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'
        '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'
        '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'
        '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'
        '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'
        '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'
  /api/connector/v1/companies/delete:
    post:
      tags:
      - Companies
      summary: 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'
        '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'
        '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'
        '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'
        '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'
        '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'
        '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'
        '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'
components:
  schemas:
    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.)'
      additionalProperties: false
      description: Credit rating to define creditworthiness of the company.
      x-schema-id: CreditRatingParameters
    CompanyOptionsParameters:
      title: Company Options Parameters
      type: object
      properties:
        Invoiceable:
          type: boolean
          description: Whether the company is invoiceable or not.
        AddFeesToInvoices:
          type: boolean
          description: Whether the company has an additional fee applied for invoicing or not.
        AddTaxDeductedPaymentToInvoices:
          type: boolean
          description: Whether tax-deducted payments should be automatically added to invoices.
      additionalProperties: false
      description: Options of the company.
      x-schema-id: CompanyOptionsParameters
    Unit:
      type: object
      additionalProperties: false
    ConnectorApiExceptionResult:
      title: ConnectorApiExceptionResult
      type: object
      properties:
        Message:
          type:
          - string
          - 'null'
        RequestId:
          type:
          - string
          - 'null'
        Details: {}
      additionalProperties: false
      x-schema-id: ConnectorApiExceptionResult
    CompanyOptions:
      title: Company Options
      type: object
      properties:
        Invoiceable:
          type: boolean
          description: Whether the company is invoiceable or not.
        AddFeesToInvoices:
          type: boolean
          description: Whether the company has an additional fee applied for invoicing or not.
        AddTaxDeductedPaymentToInvoices:
          type: boolean
          description: Whether tax-deducted payments should be automatically added to invoices.
      additionalProperties: false
      description: Options of the company.
      x-schema-id: CompanyOptions
    TimeFilterInterval:
      title: Time interval
      type: object
      properties:
        StartUtc:
          type:
          - string
          - 'null'
          format: date-time
        EndUtc:
          type:
          - string
          - 'null'
          format: date-time
      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:\n\n- **Start equals End (equality mode)**  \n  If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time:\n  \n  ```\n  CreatedUtc == StartUtc\n  ```\n  \n  This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned.\n\n- **Start differs from End (interval mode)**  \n  If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval:\n  \n  ```\n  StartUtc <= CreatedUtc < EndUtc\n  ```\n  \n  In other words, the start is inclusive and the end is exclusive.\n\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
    MultipleCompanyDeleteParameters:
      title: MultipleCompanyDeleteParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - CompanyIds
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
        ChainId:
          type:
          - string
          - 'null'
          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
        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
    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
        ChainId:
          type: string
          description: Unique identifier of the chain.
          format: uuid
        Name:
          minLength: 1
          type: string
          description: Name of the company.
        MotherCompanyId:
          type:
          - string
          - 'null'
          description: Unique identifier of mother company.
          format: uuid
        InvoicingEmail:
          type:
          - string
          - 'null'
          description: Email for issuing invoices to the company.
          format: email
        WebsiteUrl:
          type:
          - string
          - 'null'
          description: The website url of the company.
          format: uri
        InvoiceDueInterval:
          type:
          - string
          - 'null'
          description: The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
        Options:
          title: Company Options
          allOf:
          - $ref: '#/components/schemas/CompanyOptions'
          description: Options of the co

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

Mews Companies API

Operations 4

Documentation

Specifications

Schemas & Data

Other Resources