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

# Create a tax rate



## OpenAPI

````yaml /openapi_v4_core.json post /v4/core/companies/{companyId}/tax-rates
openapi: 3.0.0
info:
  title: Commenda Integrations V4 API
  description: Commenda Integrations — unified accounting, commerce, and CRM API.
  version: 4.0.0
  contact: {}
servers:
  - url: https://api.integrations.commenda.io
    description: Production
security:
  - api_key: []
tags: []
paths:
  /v4/core/companies/{companyId}/tax-rates:
    post:
      tags:
        - Accounting
        - Payments
      summary: Create a tax rate
      operationId: create_tax-rates
      parameters:
        - name: companyId
          in: path
          required: true
          description: Commenda company id.
          schema:
            type: integer
        - name: run_async
          in: query
          required: false
          description: >-
            Process the write asynchronously. Required when `data` is an array
            (batch write).
          schema:
            type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  oneOf:
                    - $ref: '#/components/schemas/TaxRateWrite'
                    - type: array
                      items:
                        $ref: '#/components/schemas/TaxRateWrite'
              required:
                - data
      responses:
        '201':
          description: The created tax-rates record (sync) or a sync id (async).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      data:
                        allOf:
                          - $ref: '#/components/schemas/TaxRate'
                        nullable: true
                        description: >-
                          The written record, read back (synchronous writes
                          only).
                      sync_id:
                        type: string
                    required:
                      - sync_id
                  request_id:
                    type: string
                required:
                  - data
                  - request_id
components:
  schemas:
    TaxRateWrite:
      type: object
      properties:
        platform_id:
          type: string
          example: string
        name:
          type: string
          nullable: true
          example: string
        code:
          type: string
          nullable: true
          example: string
        rate:
          type: number
          nullable: true
          example: 0
        tax_type:
          type: string
          nullable: true
          example: string
        effective_tax_rate:
          type: number
          nullable: true
          example: 0
        total_tax_rate:
          type: number
          nullable: true
          example: 0
        components:
          description: Arbitrary JSON (object or array; shape varies by data model).
          nullable: true
          example: {}
        jurisdiction:
          type: string
          nullable: true
          example: string
        status:
          type: string
          enum:
            - ACTIVE
            - ARCHIVED
            - UNKNOWN
          nullable: true
          example: ACTIVE
        created_at:
          type: string
          format: date-time
          nullable: true
          example: '2024-01-01T00:00:00Z'
        updated_at:
          type: string
          format: date-time
          nullable: true
          example: '2024-01-01T00:00:00Z'
      required:
        - platform_id
    TaxRate:
      type: object
      properties:
        rootfi_id:
          type: integer
          description: Unique identifier assigned by Commenda for this tax rate
        rootfi_created_at:
          type: string
          format: date-time
          description: >-
            Timestamp when this record was created in Commenda's system (ISO
            8601)
        rootfi_updated_at:
          type: string
          format: date-time
          description: >-
            Timestamp when this record was last updated in Commenda's system
            (ISO 8601)
        rootfi_integration_type:
          type: string
          enum:
            - BUSY
            - CLEARBOOKS
            - FREEAGENT
            - FRESHBOOKS
            - KASHFLOW
            - MEKARI_JURNAL
            - MS_DYNAMICS_365
            - MS_DYNAMICS_365_FO
            - MYOB_BUSINESS
            - NETSUITE
            - ODOO_ACCOUNTING
            - QOYOD
            - QUICKBOOKS
            - QUICKBOOKS_SANDBOX
            - ROOTFI_SANDBOX
            - SAGE_CLOUD_ACCOUNTING
            - SAGE_ZA_CLOUD_ACCOUNTING
            - SAGE_INTACCT
            - TALLY
            - WAFEQ
            - WAVE
            - XERO
            - ZOHO_BOOKS
            - PUZZLE_SANDBOX
            - PUZZLE
            - RILLET
            - RILLET_SANDBOX
            - AMAZON
            - BIG_COMMERCE
            - SHOPIFY
            - SQUARESPACE
            - WIX
            - WOO_COMMERCE
            - GOOGLE_PLAYSTORE
            - CHARGEBEE
            - MOLLIE
            - PAYPAL
            - PAYPAL_SANDBOX
            - RAZORPAY
            - SQUARE
            - SQUARE_SANDBOX
            - STRIPE
            - STRIPE_TEST
            - STRIPE_SANDBOX
            - ZOHO_INVOICE
            - PADDLE
            - PADDLE_SANDBOX
            - HUBSPOT
            - PIPEDRIVE
            - SALES_FORCE
            - ZOHO_CRM
            - GUSTO
        platform_id:
          type: string
          description: >-
            Unique identifier for this tax rate in the source accounting
            platform
        name:
          type: string
          nullable: true
          description: The display name of the tax rate
        code:
          type: string
          nullable: true
          description: The simple ID or code for the tax rate
        rate:
          type: number
          nullable: true
        tax_type:
          type: string
          nullable: true
          description: The type of tax as mentioned in the accounting platform
        effective_tax_rate:
          type: number
          nullable: true
          description: >-
            The total tax rate after accounting for the compounding effects of
            all tax components
        total_tax_rate:
          type: number
          nullable: true
          description: The sum of all the tax rate components
        components:
          description: The list of tax rate components
          nullable: true
        jurisdiction:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - ACTIVE
            - ARCHIVED
            - UNKNOWN
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
          description: The date and time the tax rate was last updated
      required:
        - rootfi_id
        - rootfi_created_at
        - rootfi_updated_at
        - rootfi_integration_type
        - platform_id
      description: >-
        A Tax Rate is the percentage at which an individual or corporation is
        taxed.
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: api_key
      description: Your Commenda Integrations API key, sent in the `api_key` header.

````