---
title: "Update billing automations assignments"
method: POST
path: "/api/connector/v1/billingAutomations/updateAssignments"
tags: ["Billing automations"]
---

# Update billing automations assignments

`POST /api/connector/v1/billingAutomations/updateAssignments`

Add, update or remove billing automation assignments of a specific billing automation.

## Request body

- BillingAutomationAssignmentsUpdateParameters
  - `ClientToken` string, required — Token identifying the client application.
  - `AccessToken` string, required — Access token of the client application.
  - `Client` string, required — Name and version of the client application.
  - `EnterpriseId` string, uuid, nullable — Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
  - `BillingAutomationId` string, uuid, required — Unique identifier of the billing automation.
  - `AssignmentsToAdd` BillingAutomationAssignmentAddParameters[], nullable — Parameters for adding new assignments (or null if not being updated).
    - `ServiceId` string, uuid, required — Unique identifier of the related service.
    - `RoutedItemTypes` BillingAutomationItemTypesParameters, required
      - `SpaceOrder` boolean, required — Space order
      - `CityTax` boolean, required — City tax
      - `AllProducts` boolean, required — All products
      - `Deposits` boolean, required — Deposits
      - `AdditionalExpenses` boolean, required — Additional expenses
      - `AllCustomItems` boolean, required — All custom items
    - `RateIds` string[], nullable — Unique identifiers of `Rates` that will be applied as billing automation condition.
    - `ProductCategoryIds` string[], nullable — Unique identifiers of `Product Categories` that will be applied as billing automation condition.
    - `ProductIds` string[], nullable — Unique identifiers of `Products` that will be applied as billing automation condition.
    - `AccountingCategories` BillingAutomationAccountingCategoryAssignment[], nullable — List of accounting categories that will be applied as billing automation condition.
      - `AccountingCategoryId` string, uuid, required — Unique identifier of the accounting category.
      - `ItemTypes` AccountingCategoryRoutedItemTypes, required
        - `Products` boolean, required — Specifies whether products under the given accounting category are routed.
        - `CustomItems` boolean, required — Specifies whether custom items under the given accounting category are routed.
  - `AssignmentsToUpdate` BillingAutomationAssignmentUpdateParameters[], nullable — List of parameters for updating existing assignments (or null if not being updated).
    - `BillingAutomationAssignmentId` string, uuid, required — Unique identifier of the billing automation assignment.
    - `RoutedItemTypes` BillingAutomationItemTypesUpdateParameters
      - `SpaceOrder` BooleanUpdateValue
        - `Value` boolean — Value which is to be updated.
      - `CityTax` BooleanUpdateValue
        - `Value` boolean — Value which is to be updated.
      - `AllProducts` BooleanUpdateValue
        - `Value` boolean — Value which is to be updated.
      - `Deposits` BooleanUpdateValue
        - `Value` boolean — Value which is to be updated.
      - `AdditionalExpenses` BooleanUpdateValue
        - `Value` boolean — Value which is to be updated.
      - `AllCustomItems` BooleanUpdateValue
        - `Value` boolean — Value which is to be updated.
    - `RateIds` GuidIEnumerableUpdateValue
      - `Value` string[], nullable — Value which is to be updated.
    - `ProductCategoryIds` GuidIEnumerableUpdateValue
      - `Value` string[], nullable — Value which is to be updated.
    - `ProductIds` GuidIEnumerableUpdateValue
      - `Value` string[], nullable — Value which is to be updated.
    - `AccountingCategories` BillingAutomationAccountingCategoryAssignmentIEnumerableUpdateValue
      - `Value` BillingAutomationAccountingCategoryAssignment[], nullable — Value which is to be updated.
        - `AccountingCategoryId` string, uuid, required — Unique identifier of the accounting category.
        - `ItemTypes` AccountingCategoryRoutedItemTypes, required
          - `Products` boolean, required — Specifies whether products under the given accounting category are routed.
          - `CustomItems` boolean, required — Specifies whether custom items under the given accounting category are routed.
  - `AssignmentIdsToRemove` string[], nullable — List of unique identifiers for assignments to be removed (or null if not being updated).

## Response `200`

OK

- BillingAutomationAssignmentsUpdateParameters
  - `ClientToken` string, required — Token identifying the client application.
  - `AccessToken` string, required — Access token of the client application.
  - `Client` string, required — Name and version of the client application.
  - `EnterpriseId` string, uuid, nullable — Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
  - `BillingAutomationId` string, uuid, required — Unique identifier of the billing automation.
  - `AssignmentsToAdd` BillingAutomationAssignmentAddParameters[], nullable — Parameters for adding new assignments (or null if not being updated).
    - `ServiceId` string, uuid, required — Unique identifier of the related service.
    - `RoutedItemTypes` BillingAutomationItemTypesParameters, required
      - `SpaceOrder` boolean, required — Space order
      - `CityTax` boolean, required — City tax
      - `AllProducts` boolean, required — All products
      - `Deposits` boolean, required — Deposits
      - `AdditionalExpenses` boolean, required — Additional expenses
      - `AllCustomItems` boolean, required — All custom items
    - `RateIds` string[], nullable — Unique identifiers of `Rates` that will be applied as billing automation condition.
    - `ProductCategoryIds` string[], nullable — Unique identifiers of `Product Categories` that will be applied as billing automation condition.
    - `ProductIds` string[], nullable — Unique identifiers of `Products` that will be applied as billing automation condition.
    - `AccountingCategories` BillingAutomationAccountingCategoryAssignment[], nullable — List of accounting categories that will be applied as billing automation condition.
      - `AccountingCategoryId` string, uuid, required — Unique identifier of the accounting category.
      - `ItemTypes` AccountingCategoryRoutedItemTypes, required
        - `Products` boolean, required — Specifies whether products under the given accounting category are routed.
        - `CustomItems` boolean, required — Specifies whether custom items under the given accounting category are routed.
  - `AssignmentsToUpdate` BillingAutomationAssignmentUpdateParameters[], nullable — List of parameters for updating existing assignments (or null if not being updated).
    - `BillingAutomationAssignmentId` string, uuid, required — Unique identifier of the billing automation assignment.
    - `RoutedItemTypes` BillingAutomationItemTypesUpdateParameters
      - `SpaceOrder` BooleanUpdateValue
        - `Value` boolean — Value which is to be updated.
      - `CityTax` BooleanUpdateValue
        - `Value` boolean — Value which is to be updated.
      - `AllProducts` BooleanUpdateValue
        - `Value` boolean — Value which is to be updated.
      - `Deposits` BooleanUpdateValue
        - `Value` boolean — Value which is to be updated.
      - `AdditionalExpenses` BooleanUpdateValue
        - `Value` boolean — Value which is to be updated.
      - `AllCustomItems` BooleanUpdateValue
        - `Value` boolean — Value which is to be updated.
    - `RateIds` GuidIEnumerableUpdateValue
      - `Value` string[], nullable — Value which is to be updated.
    - `ProductCategoryIds` GuidIEnumerableUpdateValue
      - `Value` string[], nullable — Value which is to be updated.
    - `ProductIds` GuidIEnumerableUpdateValue
      - `Value` string[], nullable — Value which is to be updated.
    - `AccountingCategories` BillingAutomationAccountingCategoryAssignmentIEnumerableUpdateValue
      - `Value` BillingAutomationAccountingCategoryAssignment[], nullable — Value which is to be updated.
        - `AccountingCategoryId` string, uuid, required — Unique identifier of the accounting category.
        - `ItemTypes` AccountingCategoryRoutedItemTypes, required
          - `Products` boolean, required — Specifies whether products under the given accounting category are routed.
          - `CustomItems` boolean, required — Specifies whether custom items under the given accounting category are routed.
  - `AssignmentIdsToRemove` string[], nullable — List of unique identifiers for assignments to be removed (or null if not being updated).

## Other responses

- `204` — Server has successfully fulfilled the request and there is no additional information to send back.
- `400` — 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).
- `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
- `403` — 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.
- `408` — 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)
- `429` — 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).
- `500` — 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).

---

[API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/versions/81933a8ff730/schema)