> ## Documentation Index
> Fetch the complete documentation index at: https://learn.breezing.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Tax Rate API

> Update a Breezing tax rate's name, percentage, or components, or archive it so that it no longer appears in tax rate pickers.



## OpenAPI

````yaml PATCH /taxes/{id}
openapi: 3.1.0
info:
  title: Breezing Public API
  version: 1.0.0
  description: >-
    Crypto accounting API for programmatic access and AI agents. Authenticate
    with an API key using the Authorization header: `Bearer brz_...`
servers:
  - url: https://api.breezing.io/v1
security:
  - BearerAuth: []
paths:
  /taxes/{id}:
    patch:
      tags:
        - Tax Rates
      summary: Update a tax rate
      description: >-
        Partial update (only provided fields change). Renaming re-checks the
        case-insensitive uniqueness (409). Rate mode follows the payload: a
        `rate` clears the components, a `components` stack derives the rate,
        `components: null` flattens. `isArchived` toggles the soft retirement.
        Renaming does NOT rewrite existing transactions or invoices that carry
        the old name (the account-code by-value convention).
      parameters:
        - schema:
            type: string
            description: Tax rate ID
            example: '7'
          required: true
          description: Tax rate ID
          name: id
          in: path
        - schema:
            type: string
            description: >-
              Organization ID. Use GET /v1/companies to discover available
              org/company pairs.
            example: '1'
          required: true
          description: >-
            Organization ID. Use GET /v1/companies to discover available
            org/company pairs.
          name: orgId
          in: query
        - schema:
            type: string
            description: >-
              Company ID. Use GET /v1/companies to discover available companies
              and their access levels.
            example: '1'
          required: true
          description: >-
            Company ID. Use GET /v1/companies to discover available companies
            and their access levels.
          name: companyId
          in: query
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTaxRateBody'
      responses:
        '200':
          description: Tax rate updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      updated:
                        type: integer
                    required:
                      - updated
                required:
                  - success
                  - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '403':
          description: >-
            API key has no access to this company, has read-only access where
            write was required, or the company subscription is inactive
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '404':
          description: Tax rate not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '409':
          description: Name already in use
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
      security:
        - BearerAuth: []
components:
  schemas:
    UpdateTaxRateBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 100
        rate:
          type: string
          minLength: 1
          maxLength: 20
          description: >-
            Switch to (or change) a single rate. Sending a rate clears any
            component stack.
        components:
          type: array
          nullable: true
          items:
            type: object
            properties:
              name:
                type: string
                minLength: 1
                maxLength: 100
                example: State tax
              rate:
                type: string
                minLength: 1
                maxLength: 20
                description: Percentage 0..100 with up to 4 decimals, as a string.
                example: '6.25'
              isCompound:
                type: boolean
                description: >-
                  Compound components apply on the base plus the non-compound
                  tax (the Xero/Quebec model), so component order never matters.
            required:
              - name
              - rate
          minItems: 1
          maxItems: 10
          description: >-
            Replace the component stack (the rate becomes the derived total).
            Null flattens the tax to a single rate at its stored total.
        description:
          type: string
          maxLength: 500
        isArchived:
          type: boolean
          description: >-
            Archive (true) or restore (false). Archived rates stay on existing
            rows but leave the pickers.
        xeroTaxType:
          type: string
          nullable: true
          maxLength: 100
          description: >-
            Xero TaxType code (from the Xero organisation's tax rates). Null
            clears.
        qboTaxCode:
          type: string
          nullable: true
          maxLength: 100
          description: QuickBooks TaxCode id. Null clears.
        vatGlAccount:
          type: string
          nullable: true
          maxLength: 100
          description: >-
            Chart account CODE for the input VAT line: the native invoice
            accrual journal and OUT transaction rows (purchases) naming the
            rate. Null clears. Once the company has a chart of accounts, a rate
            above 0 needs at least one of vatGlAccount / outputVatGlAccount and
            every code must exist in the chart (400 otherwise).
        outputVatGlAccount:
          type: string
          nullable: true
          maxLength: 100
          description: >-
            Chart account CODE for the output VAT line on IN transaction rows
            (sales) naming the rate. Null clears.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.