Mews Billing automations API

openapi: 3.2.0
info:
  title: BookingEngineApi Account notes Billing automations API
  version: v1
servers:
- url: https://api.mews.com
tags:
- name: Billing automations
paths:
  /api/connector/v1/billingAutomations/getAll:
    post:
      tags:
      - Billing automations
      summary: Get all billing automations
      description: Returns all billing automations. 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: billingAutomations_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingAutomationFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              CompanyIds:
              - c6f5c82d-621a-4c8a-903b-1b0a9a23b71f
              - 956aa0f0-a090-42c8-bee2-991972d32f80
              BillingAutomationIds:
              - ecd64eec-4423-4c65-b844-814b9199856d
              - 13e6b16e-39bc-4cb1-8610-70ecdb4f91cc
              EnterpriseIds:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
              - 4d0201db-36f5-428b-8d11-4f0a65e960cc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingAutomationResult'
              example:
                BillingAutomations:
                - Id: ecd64eec-4423-4c65-b844-814b9199856d
                  EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  Name: Continuous billing automation for company XYZ
                  Description: Billing Automation for company XYZ with prepayment all, company as owner.
                  CompaniesWithRelations:
                  - CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f
                    CompanyRelations:
                      PartnerCompany: true
                      TravelAgency: false
                  Prepayment: All
                  AssignmentTargetType: CompanyAsOwner
                  TriggerType: Continuous
                  BillAggregationType: AggregateAll
                  CreatedUtc: '2017-01-31T10:58:06Z'
                  UpdatedUtc: '2023-10-28T14:23:00Z'
                  CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf
                  UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae
                  ProcessingStartOffset: null
                  OrderItemConsumptionPeriod: null
                  Assignments:
                  - Id: d6b550e9-9c4b-42dd-9daa-555312b030e6
                    BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d
                    ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
                    RoutedItemTypes:
                      SpaceOrder: true
                      CityTax: true
                      AllProducts: true
                      Deposits: true
                      AdditionalExpenses: false
                      AllCustomItems: false
                    RateIds:
                    - ab3682ba-4493-4eb0-bcdc-8d000f5bad65
                    ProductCategoryIds:
                    - 599c477e-b826-4444-8ded-4fa7276ef0c1
                    ProductIds:
                    - f0184ec2-9f02-4026-9b70-0b2bed2adde7
                    AccountingCategoryAssignments:
                    - AccountingCategoryId: 2e0f5930-605e-4a23-9994-a7701a56b576
                      ItemTypes:
                        Products: true
                        CustomItems: false
                Cursor: 54ec08b6-e6fc-48e9-b8ae-02943e0ac693
        '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/billingAutomations/add:
    post:
      tags:
      - Billing automations
      summary: Add billing automations
      description: Adds billing automations.
      operationId: billingAutomations_add
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleBillingAutomationAddParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              BillingAutomations:
              - Name: Company A billing automation
                Description: Billing automation routing reservations made for Company A to bills where company is an owner, aggregating all reservations onto one bill.
                CompaniesWithRelations:
                - CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f
                  CompanyRelations:
                    PartnerCompany: true
                    TravelAgency: false
                Prepayment: All
                AssignmentTargetType: CompanyAsOwner
                TriggerType: Continuous
                BillAggregationType: AggregateAll
                Assignments:
                - ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
                  RoutedItemTypes:
                    SpaceOrder: true
                    CityTax: true
                    AllProducts: false
                    Deposits: true
                    AdditionalExpenses: true
                    AllCustomItems: false
                  ProductIds:
                  - 507d93e6-9fb5-4734-a6d1-977afc4dfdff
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingAutomationModificationResult'
              example:
                BillingAutomations:
                - Id: ecd64eec-4423-4c65-b844-814b9199856d
                  EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  Name: Continuous billing automation for company XYZ
                  Description: Billing Automation for company XYZ with prepayment all, company as owner.
                  CompaniesWithRelations:
                  - CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f
                    CompanyRelations:
                      PartnerCompany: true
                      TravelAgency: false
                  Prepayment: All
                  AssignmentTargetType: CompanyAsOwner
                  TriggerType: Continuous
                  BillAggregationType: AggregateAll
                  CreatedUtc: '2017-01-31T10:58:06Z'
                  UpdatedUtc: '2023-10-28T14:23:00Z'
                  CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf
                  UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae
                  ProcessingStartOffset: null
                  OrderItemConsumptionPeriod: null
                  Assignments:
                  - Id: d6b550e9-9c4b-42dd-9daa-555312b030e6
                    BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d
                    ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
                    RoutedItemTypes:
                      SpaceOrder: true
                      CityTax: true
                      AllProducts: true
                      Deposits: true
                      AdditionalExpenses: false
                      AllCustomItems: false
                    RateIds:
                    - ab3682ba-4493-4eb0-bcdc-8d000f5bad65
                    ProductCategoryIds:
                    - 599c477e-b826-4444-8ded-4fa7276ef0c1
                    ProductIds:
                    - f0184ec2-9f02-4026-9b70-0b2bed2adde7
                    AccountingCategoryAssignments:
                    - AccountingCategoryId: 2e0f5930-605e-4a23-9994-a7701a56b576
                      ItemTypes:
                        Products: true
                        CustomItems: false
        '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/billingAutomations/update:
    post:
      tags:
      - Billing automations
      summary: Update billing automations
      description: Updates one or more existing billing automations.
      operationId: billingAutomations_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleBillingAutomationUpdateParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              BillingAutomationUpdates:
              - BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d
                Name:
                  Value: New name.
                Description:
                  Value: Billing Automation that has prepayment changed to All, Assignment target to Company as owner and Bill aggregation to aggregate all items into one bill.
                Prepayment:
                  Value: All
                AssignmentTargetType:
                  Value: CompanyAsOwner
                BillAggregationType:
                  Value: AggregateAll
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingAutomationModificationResult'
              example:
                BillingAutomations:
                - Id: ecd64eec-4423-4c65-b844-814b9199856d
                  EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  Name: Continuous billing automation for company XYZ
                  Description: Billing Automation for company XYZ with prepayment all, company as owner.
                  CompaniesWithRelations:
                  - CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f
                    CompanyRelations:
                      PartnerCompany: true
                      TravelAgency: false
                  Prepayment: All
                  AssignmentTargetType: CompanyAsOwner
                  TriggerType: Continuous
                  BillAggregationType: AggregateAll
                  CreatedUtc: '2017-01-31T10:58:06Z'
                  UpdatedUtc: '2023-10-28T14:23:00Z'
                  CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf
                  UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae
                  ProcessingStartOffset: null
                  OrderItemConsumptionPeriod: null
                  Assignments:
                  - Id: d6b550e9-9c4b-42dd-9daa-555312b030e6
                    BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d
                    ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
                    RoutedItemTypes:
                      SpaceOrder: true
                      CityTax: true
                      AllProducts: true
                      Deposits: true
                      AdditionalExpenses: false
                      AllCustomItems: false
                    RateIds:
                    - ab3682ba-4493-4eb0-bcdc-8d000f5bad65
                    ProductCategoryIds:
                    - 599c477e-b826-4444-8ded-4fa7276ef0c1
                    ProductIds:
                    - f0184ec2-9f02-4026-9b70-0b2bed2adde7
                    AccountingCategoryAssignments:
                    - AccountingCategoryId: 2e0f5930-605e-4a23-9994-a7701a56b576
                      ItemTypes:
                        Products: true
                        CustomItems: false
        '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/billingAutomations/updateAssignments:
    post:
      tags:
      - Billing automations
      summary: Update billing automations assignments
      description: Add, update or remove billing automation assignments of a specific billing automation.
      operationId: billingAutomations_updateAssignments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingAutomationAssignmentsUpdateParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d
              AssignmentsToUpdate:
              - BillingAutomationAssignmentId: 00000000-0000-0000-0000-000000000000
                RoutedItemTypes:
                  SpaceOrder:
                    Value: true
                  CityTax:
                    Value: true
                  AllProducts:
                    Value: false
                  Deposits:
                    Value: true
                  AdditionalExpenses:
                    Value: true
                  AllCustomItems:
                    Value: false
                ProductIds:
                  Value:
                  - 507d93e6-9fb5-4734-a6d1-977afc4dfdff
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingAutomationAssignmentsUpdateParameters'
              example:
                BillingAutomations:
                - Id: ecd64eec-4423-4c65-b844-814b9199856d
                  EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  Name: Continuous billing automation for company XYZ
                  Description: Billing Automation for company XYZ with prepayment all, company as owner.
                  CompaniesWithRelations:
                  - CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f
                    CompanyRelations:
                      PartnerCompany: true
                      TravelAgency: false
                  Prepayment: All
                  AssignmentTargetType: CompanyAsOwner
                  TriggerType: Continuous
                  BillAggregationType: AggregateAll
                  CreatedUtc: '2017-01-31T10:58:06Z'
                  UpdatedUtc: '2023-10-28T14:23:00Z'
                  CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf
                  UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae
                  ProcessingStartOffset: null
                  OrderItemConsumptionPeriod: null
                  Assignments:
                  - Id: d6b550e9-9c4b-42dd-9daa-555312b030e6
                    BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d
                    ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
                    RoutedItemTypes:
                      SpaceOrder: true
                      CityTax: true
                      AllProducts: true
                      Deposits: true
                      AdditionalExpenses: false
                      AllCustomItems: false
                    RateIds:
                    - ab3682ba-4493-4eb0-bcdc-8d000f5bad65
                    ProductCategoryIds:
                    - 599c477e-b826-4444-8ded-4fa7276ef0c1
                    ProductIds:
                    - f0184ec2-9f02-4026-9b70-0b2bed2adde7
                    AccountingCategoryAssignments:
                    - AccountingCategoryId: 2e0f5930-605e-4a23-9994-a7701a56b576
                      ItemTypes:
                        Products: true
                        CustomItems: false
        '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/billingAutomations/delete:
    post:
      tags:
      - Billing automations
      summary: Delete billing automations
      description: Deletes specified billing automations.
      operationId: billingAutomations_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingAutomationDeleteParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              BillingAutomationIds:
              - ecd64eec-4423-4c65-b844-814b9199856d
              - 13e6b16e-39bc-4cb1-8610-70ecdb4f91cc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
              example: {}
        '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:
    BillingAutomationAssignment:
      title: Billing automation assignment
      required:
      - BillingAutomationId
      - Id
      - RoutedItemTypes
      - ServiceId
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the billing automation assignment.
          format: uuid
        BillingAutomationId:
          type: string
          description: Unique identifier of the billing automation.
          format: uuid
        ServiceId:
          type: string
          description: Unique identifier of the related service.
          format: uuid
        RoutedItemTypes:
          title: Billing automation item types parameters
          allOf:
          - $ref: '#/components/schemas/BillingAutomationItemTypesParameters'
          description: Type of items that are going to be routed.
        RateIds:
          maxItems: 100
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Rates` used in billing automation conditions.
        ProductCategoryIds:
          maxItems: 100
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Product Categories` used in billing automation conditions.
        ProductIds:
          maxItems: 100
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Products` used in billing automation conditions.
        AccountingCategoryAssignments:
          maxItems: 100
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BillingAutomationAccountingCategoryAssignment'
          description: List of accounting category assignments used in billing automation conditions.
      additionalProperties: false
      x-schema-id: BillingAutomationAssignment
    BillingAutomationUpdateParameters:
      title: Billing automation update parameters
      required:
      - BillingAutomationId
      type: object
      properties:
        BillingAutomationId:
          type: string
          description: Unique identifier of the billing automation.
          format: uuid
        Name:
          title: String update value
          maxLength: 255
          allOf:
          - $ref: '#/components/schemas/StringUpdateValue'
          description: Name of the billin

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