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

# Update a tax code



## OpenAPI

````yaml /openapi.yaml patch /tax-codes/{id}
openapi: 3.1.0
info:
  title: Arcus ERP Public API
  version: 1.0.0
  description: >
    Arcus ERP public REST API. Designed for external integrations and data
    migration.


    **Authentication.** Bearer token (API key) via the `Authorization` header.

    Format: `Authorization: Bearer ark_live_ent_<code>_<random>` (or
    `ark_test_*` for sandbox).

    API keys are issued per-entity in **Settings > Developers > API Keys**.


    **Entity scoping.** The entity is encoded in the API key prefix; routes are
    flat

    (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform
    endpoints

    (migration, reconciliation, events, webhook endpoints, API keys) use the

    `/v1/entities/{entity_id}/...` form -- those are noted in their tags.


    **Key capabilities.**
      - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource).
      - Cursor-based pagination (`starting_after` / `ending_before` / `limit`).
      - Idempotency via the `Idempotency-Key` header.
      - Webhook events for asynchronous notification.
      - Conditional requests / ETag for cache validation.
servers:
  - url: https://api.arcuserp.com/v1
    description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys)
  - url: https://dev-api.arcuserp.com/v1
    description: >-
      Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev
      RDS)
security: []
paths:
  /tax-codes/{id}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    patch:
      tags:
        - Tax Codes
      summary: Update a tax code
      operationId: updateTaxCodeV1
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                  nullable: true
                taxable:
                  type: boolean
                category:
                  type: string
                  nullable: true
                avatax_tax_code:
                  type: string
                  nullable: true
                is_active:
                  type: boolean
                metadata:
                  type: object
      responses:
        '200':
          description: Updated tax code
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxCode'
        '404':
          $ref: '#/components/responses/Error'
      security:
        - ApiKeyAuth:
            - tax_codes:write
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: |
        Client-generated unique key for idempotent POST/PATCH/DELETE operations.
        Alias for the Idempotency parameter. Max 255 chars. On retry with the
        same key, the original response is returned without re-executing the
        operation. Keys expire after 24 hours.
      schema:
        type: string
        maxLength: 255
  schemas:
    TaxCode:
      type: object
      description: >
        A tax classification code for products (e.g. AvaTax P0000000 generic
        tangible, ND040000 non-taxable digital, etc.). When AvaTax is the active
        jurisdiction provider, `avatax_tax_code` mirrors the canonical AvaTax
        tax code so jurisdiction sourcing flows through. Soft-delete refuses
        with HTTP 409 if any product still references the code (FK guard against
        orphaned product tax classification). Scope: tax_codes:read /
        tax_codes:write / tax_codes:delete.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        object:
          type: string
          example: tax_code
        entity_id:
          type: string
          format: uuid
          readOnly: true
        code:
          type: string
          description: Operator-defined code unique per entity. 1..50 chars.
        name:
          type: string
          description: Human-readable label. 1..150 chars.
        description:
          type: string
          nullable: true
        taxable:
          type: boolean
          default: true
          description: If false, products with this code are exempt from sales tax.
        category:
          type: string
          nullable: true
          description: Optional grouping label (e.g. 'general', 'food', 'digital').
        avatax_tax_code:
          type: string
          nullable: true
          description: Mirrors the AvaTax tax code when AvaTax is the active provider.
        is_active:
          type: boolean
          default: true
        external_source:
          type: string
          nullable: true
        external_id:
          type: string
          nullable: true
        metadata:
          type: object
          description: Free-form caller metadata. Default {}.
        deleted_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    ErrorEnvelope:
      type: object
      description: |
        Canonical error response envelope. All API errors use this shape.
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: Machine-readable error key
          example: not_found
        code:
          type: string
          description: Machine-readable error code (often same as error)
          example: not_found
        type:
          type: string
          enum:
            - validation_error
            - permission_error
            - not_found
            - conflict
            - rate_limit
            - internal
            - expand_error
            - not_implemented
          example: not_found
        hint:
          type: string
          description: Human-readable one-sentence explanation (English)
          example: >-
            The requested order does not exist or does not belong to this
            entity.
        param:
          type: string
          description: The parameter that caused the error, if applicable
          example: expand[0]
        required:
          type: string
          description: The scope required (only on insufficient_scope errors)
          example: accounts:read
        request_id:
          type: string
          description: >-
            Unique request ID for support tracing (maps to CloudWatch log
            stream)
          example: req_abc123
  responses:
    Error:
      description: Error response (400/401/403/404/409/422/429/500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key issued per entity via Settings > Developers > API Keys.
        Each key carries scopes (e.g. orders:read, products:write).
        Bearer token format: Authorization: Bearer ark_live_ent_<code>_<random>
        Test keys use ark_test_ent_<code>_<random>. Both are issued per entity
        via Settings > Developers > API Keys.

````