Mews Connector API

General-purpose REST API for partners to access Mews Operations data and services. Covers accounts, account notes, accounting items, addresses, age categories, availability, bills, bookings, customers, products, rates, reservations, services, and many more. Publishes OpenAPI 3.0.4 spec; supports Portfolio Access Tokens for multi-property access.

OpenAPI Specification

mews-connector-openapi.yaml Raw ↑
openapi: 3.0.4
info:
  title: Connector API
  description: General-purpose API that enables partners of Mews to access data and services in Mews Operations
  termsOfService: https://www.mews.com/en/terms-conditions/partners
  contact:
    name: Partner success
    email: [email protected]
  version: v1
servers:
  - url: https://api.mews.com
paths:
  /api/connector/v1/accountNotes/getAll:
    post:
      tags:
        - Account notes
      summary: Get all account notes
      description: "Returns all account notes of an account, optionally filtered by activity state, account identifiers, specific account note identifiers or other filter parameters.\nNote this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property)."
      operationId: accountNotes_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountNoteFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainIds:
                - 1df21f06-0cfc-4960-9c58-a3bf1261663e
                - 5fcd1933-22f2-40b9-84da-7db04cbecec2
              AccountNoteIds:
                - 3ed9e2f3-4bba-4df6-8d41-ab1b009b6425
                - 8a98965a-7c03-48a1-a28c-ab1b009b53c8
              AccountIds:
                - a6738390-c241-45b7-8e46-14f47207abe5
                - 435d4d5f-d14f-48dc-a47e-0481fc28ead0
              UpdatedUtc:
                StartUtc: '2022-10-10T00:00:00Z'
                EndUtc: '2022-10-17T00:00:00Z'
              ActivityStates:
                - Active
              Limitation:
                Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7
                Count: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountNoteResult'
              example:
                AccountNotes:
                  - Id: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
                    AccountId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
                    Content: Customer receives a free bottle of champagne during stay
                    AccountType: Customer
                    Classifications:
                      - Gifts
                    IsActive: true
                    CreatorProfile:
                      Discriminator: Enterprise
                      EnterpriseProfile:
                        ProfileId: 52d19c34-b0aa-4635-905d-1326fa8b8e13
                    UpdaterProfile:
                      Discriminator: Integration
                      EnterpriseProfile: 
                  - Id: da34b396-41f7-47f6-8847-aecf00a3f19e
                    AccountId: 5fcd1933-22f2-40b9-84da-7db04cbecec2
                    Content: Lactose intolerant
                    AccountType: Customer
                    Classifications:
                      - FoodAndBeverage
                    IsActive: true
                    CreatorProfile:
                      Discriminator: Enterprise
                      EnterpriseProfile:
                        ProfileId: 52d19c34-b0aa-4635-905d-1326fa8b8e13
                    UpdaterProfile:
                      Discriminator: Integration
                      EnterpriseProfile: 
                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/accountNotes/add:
    post:
      tags:
        - Account notes
      summary: Add account notes
      description: 'Adds account notes to an account of the enterprise chain. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).'
      operationId: accountNotes_add
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleAccountNoteAddParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ChainId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
              AccountNotes:
                - AccountId: 8ddea57b-6a5c-4eec-8c4c-24467dce118e
                  Content: Brother of the CEO
                  Classifications:
                    - FamilyRelations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountNoteAdditionResult'
              example:
                AccountNotes:
                  - Id: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
                    AccountId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
                    Content: Brother of the CEO
                    AccountType: Customer
                    Classifications:
                      - FamilyRelations
                    IsActive: true
                    CreatorProfile:
                      Discriminator: Enterprise
                      EnterpriseProfile:
                        ProfileId: 52d19c34-b0aa-4635-905d-1326fa8b8e13
                    UpdaterProfile:
                      Discriminator: Integration
                      EnterpriseProfile: 
        '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/accountNotes/update:
    post:
      tags:
        - Account notes
      summary: Update account notes
      description: Updates information about the specified account notes.
      operationId: accountNotes_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleAccountNoteUpdateParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              AccountNoteUpdates:
                - AccountNoteId: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
                  Content:
                    Value: The AC in the room doesn't work anymore
                  Classifications:
                    Maintenance:
                      Value: true
                    Housekeeping:
                      Value: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountNoteUpdateResult'
              example:
                AccountNotes:
                  - Id: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
                    AccountId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
                    Content: The AC in the room doesn't work anymore
                    AccountType: Customer
                    Classifications:
                      - Maintenance
                    IsActive: true
                    CreatorProfile:
                      Discriminator: Enterprise
                      EnterpriseProfile:
                        ProfileId: 52d19c34-b0aa-4635-905d-1326fa8b8e13
                    UpdaterProfile:
                      Discriminator: Integration
                      EnterpriseProfile: 
        '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/accountNotes/delete:
    post:
      tags:
        - Account notes
      summary: Delete account notes
      description: Deletes specified account notes.
      operationId: accountNotes_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleAccountNoteDeleteParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              AccountNoteIds:
                - a58ff7cb-77e3-495a-bd61-aecf00a3f19d
                - da34b396-41f7-47f6-8847-aecf00a3f19e
      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'
  /api/connector/v1/accountingCategories/getAll:
    post:
      tags:
        - Accounting categories
      summary: Get all accounting categories
      description: "Returns all accounting categories of the enterprise associated with the connector integration. \nNote this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property)."
      operationId: accountingCategories_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountingCategoryFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              EnterpriseIds:
                - 3fa85f64-5717-4562-b3fc-2c963f66afa6
                - 4d0201db-36f5-428b-8d11-4f0a65e960cc
              AccountingCategoryIds:
                - 0cf7aa90-736f-43e9-a7dc-787704548d86
                - 0b9560fb-055d-47d3-a6d4-e579c44ca558
              UpdatedUtc:
                StartUtc: '2023-10-01T00:00:00Z'
                EndUtc: '2023-10-31T00:00:00Z'
              ActivityStates:
                - Active
              Limitation:
                Count: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingCategoryResult'
              example:
                AccountingCategories:
                  - Classification: Accommodation
                    EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                    Code: '345'
                    CostCenterCode: '2589'
                    ExternalCode: '3010'
                    Id: 0cf7aa90-736f-43e9-a7dc-787704548d86
                    IsActive: true
                    LedgerAccountCode: '311100'
                    Name: Accommodation
                    PostingAccountCode: '602020'
                    CreatedUtc: '2023-10-01T11:48:57Z'
                    UpdatedUtc: '2023-10-28T11:48:57Z'
                  - Classification: 
                    EnterpriseId: 4d0201db-36f5-428b-8d11-4f0a65e960cc
                    Code: '100'
                    CostCenterCode: '2589'
                    ExternalCode: ABVG
                    Id: 0b9560fb-055d-47d3-a6d4-e579c44ca558
                    IsActive: true
                    LedgerAccountCode: '311100'
                    Name: Alcoholic Beverage
                    PostingAccountCode: '602020'
                    CreatedUtc: '2023-10-01T11:48:57Z'
                    UpdatedUtc: '2023-10-28T11:48:57Z'
                Cursor: 0b9560fb-055d-47d3-a6d4-e579c44ca558
        '400':
          description: 'Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
        '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/accountingItems/update:
    post:
      tags:
        - Accounting items
      summary: Update accounting items
      description: "Updates specified accounting items. You can use this operation to assign an accounting item to a different account or bill. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).\r\n\r\n> **State Restrictions**: Only accounting items in specific states can be moved:\r\n> - **Order items**: Must be in `Open` state\r\n> - **Payments**: Must be in `Pending` state\r\n> \r\n> Attempting to move items in other states (e.g., `Closed`, `Inactive`, `Charged`, `Failed`, `Canceled`) will result in an `Invalid AccountingItemId` error."
      operationId: accountingItems_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleAccountingItemsUpdateParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
              AccountingItemUpdates:
                - AccountingItemId: 6c2897de-620a-4f48-af1e-ada8004202bd
                  AccountId:
                    Value: 182a56ee-037d-4da5-b6f8-ada8006e7d5c
                  BillId:
                    Value: 9e3791dc-95c7-439a-aa8a-ada8007de0ca
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingItemUpdateResult'
              example:
                OrderItems:
                  - Id: 6c2897de-620a-4f48-af1e-ada8004202bd
                    AccountId: 182a56ee-037d-4da5-b6f8-ada8006e7d5c
                    OrderId: f9090129-fb49-46d2-9dc5-ad9d015d43b9
                    BillId: 9e3791dc-95c7-439a-aa8a-ada8007de0ca
                    AccountingCategoryId: d250149e-a29d-4c70-b607-a1759faf7320
                    Amount:
                      Currency: GBP
                      NetValue: 95.24
                      GrossValue: 100
                      TaxValues:
                        - Code: UK-2020-R
                          Value: 4.76
                      Breakdown:
                        Items:
                          - TaxRateCode: UK-2020-R
                            NetValue: 95.24
                            TaxValue: 4.76
                    RevenueType: Additional
                    ConsumedUtc: '2021-09-19T04:00:20Z'
                    ClosedUtc: 
                    AccountingState: Open
                    Data:
                      Discriminator: CancellationFee
                      Value: 
                PaymentItems: [ ]
        '400':
          description: 'Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
        '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/accountingItems/getAll:
    post:
      tags:
        - Accounting items
      summary: Get all accounting items
      description: 'Use [Get all payments](https://mews-systems.gitbook.io/connector-api/operations/payments#get-all-payments) and [Get all order items](https://mews-systems.gitbook.io/connector-api/operations/orderitems#get-all-order-items) instead.'
      operationId: accountingItems_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountingItemParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              ConsumedUtc:
                StartUtc: '2020-01-05T00:00:00Z'
                EndUtc: '2020-01-10T00:00:00Z'
              ClosedUtc:
                StartUtc: '2020-01-05T00:00:00Z'
                EndUtc: '2020-01-10T00:00:00Z'
              UpdatedUtc:
                StartUtc: '2020-01-05T00:00:00Z'
                EndUtc: '2020-01-10T00:00:00Z'
              ItemIds:
                - cb643cb7-8b6e-48a6-b67e-ad4c0041f550
                - 44ca12b8-f009-455e-be91-ad4c013fcbc5
              Extent:
                OrderItems: true
                PaymentItems: true
                CreditCardTransactions: false
              States:
                - Open
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingItemResult'
              example: {"OrderItems":[{"Id":"cb643cb7-8b6e-48a6-b67e-ad4c0041f550","AccountId":"77673c9d-0e31-4e90-9228-ad4b00a9fcdc","OrderId":"1103b431-998a-4b78-84de-ad4b00a9fd99","BillId":null,"Accoun

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