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

# List taxes

> Rates for dropdowns and for `tax_uuid` / `withholding_tax_uuid` on line items. By default this returns sales taxes only. Pass `is_deduction=1` for withholding taxes, or `all=1` for both.



## OpenAPI

````yaml /openapi/adam-v1.json get /taxes
openapi: 3.0.3
info:
  title: Tyms Developer API
  version: 1.0.0
  description: >-
    REST API for Tyms — the AI-Native Accounting Platform for small and
    medium-sized businesses across service, consulting, retail, and
    manufacturing. Paths are appended to the server URL.


    **Business key** (`tyms_sk_...`): all routes except partner distributor
    routes and OAuth authorization steps that document their own auth. **Partner
    key** (`adam_partner_sk_...` or equivalent): `POST /register-business`, `GET
    /referred-businesses`, billing status, and seat/credit grants on referred
    businesses. **OAuth**: integration apps use `tyms_pk_...` / `tyms_sk_...`
    plus user Bearer tokens — see the OAuth guide.


    Financial reports match what you see in the Tyms app. On invoices, bills,
    expenses, income, journals, quotes, and purchase orders you can attach a
    file by URL (`attachments`, `file_url`, `file_urls`, or `evidence`). A bank
    transaction accepts one URL on `attachment`. A body that includes `prompt`
    is an AI create and does not also save that file as a receipt. See the
    Attachments page.


    Validation failures return HTTP 400 with a readable `message`, an `errors`
    list, and the field map in `data`.
servers:
  - url: https://staging-api.tyms.io/v1/adam
    description: Sandbox (pre-production). Request credentials at developer@tyms.io.
  - url: https://api.tyms.io/v1/adam
    description: Production
security:
  - apiKey: []
tags:
  - name: Partners
    description: >-
      Referral partner (distributor) flows — partner API key only. Register
      businesses, list referrals, read billing, and grant Plus seats or AI
      credits from partner holding.
  - name: Authentication
    description: Validate a business Developer API key.
  - name: OAuth
    description: >-
      Third-party integration authorization — connect Tyms users to your app
      without sharing their business secret keys.
  - name: Chart of accounts
    description: COA and bank-linked accounts.
  - name: Taxes
    description: Sales tax and withholding tax rates for line items and dropdowns.
  - name: Invoices
    description: Invoice CRUD, payments, and void.
  - name: Bills
    description: Bill CRUD, payments, and void.
  - name: Expenses
    description: Expense CRUD and void.
  - name: Income
    description: Income record CRUD and void.
  - name: Journals
    description: Journal entry CRUD and void.
  - name: Contacts
    description: Contact CRUD.
  - name: Banks
    description: >-
      Bank accounts. Optional chart_of_account_uuid groups a new bank under an
      existing bank asset account.
  - name: Bank transactions
    description: Statement lines, categorization, AI-assisted upload, and void.
  - name: Reports
    description: Financial statements (aligned with in-app reports).
  - name: Inventory
    description: >-
      Product and service catalog; stock tracking, sell, restock, and void of
      adjustments, production orders, and opening stock.
  - name: Fixed Assets
    description: Capital asset acquisition, tracking, and void.
  - name: Quotes
    description: >-
      Sales proposals that can be converted to invoices, income, or prepaid
      income.
  - name: Purchase Orders
    description: Vendor buying commitments that convert to inventory restocks.
  - name: Departments
    description: Reporting dimension for cost/profit allocation within a branch.
  - name: Projects
    description: Job costing and project tracking dimension attached to transactions.
  - name: Branches
    description: Multi-location dimension; reports and lists can filter by branch.
paths:
  /taxes:
    get:
      tags:
        - Taxes
      summary: List taxes
      description: >-
        Rates for dropdowns and for `tax_uuid` / `withholding_tax_uuid` on line
        items. By default this returns sales taxes only. Pass `is_deduction=1`
        for withholding taxes, or `all=1` for both.
      operationId: listTaxes
      parameters:
        - name: search
          in: query
          schema:
            type: string
          description: Filter by name.
        - name: currency
          in: query
          schema:
            type: string
          description: Filter by currency code.
        - name: is_deduction
          in: query
          schema:
            type: integer
            enum:
              - 0
              - 1
          description: '`1` returns withholding taxes. `0` or omit returns sales taxes.'
        - name: all
          in: query
          schema:
            type: integer
            enum:
              - 1
          description: Pass `1` to return sales taxes and withholding taxes together.
        - name: list
          in: query
          schema:
            type: integer
            enum:
              - 1
          description: >-
            Pass `1` to return only `data` without the `status`/`message`
            wrapper.
      responses:
        '200':
          description: Tax list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdamSuccessResponse'
              example:
                status: success
                message: Taxes retrieved successfully
                data:
                  - id: a1b2c3d4e5f6478990abcdef12345678
                    uuid: a1b2c3d4e5f6478990abcdef12345678
                    name: VAT
                    label: VAT (7.5%)
                    percentage: 7.5
                    currency: NGN
                    is_deduction: false
                    payable_account: VAT Payable
                    receivable_account: VAT Receivable
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AdamSuccessResponse:
      type: object
      required:
        - status
        - message
      properties:
        status:
          type: string
          example: success
        message:
          type: string
        data:
          description: >-
            Single resource, array of resources, statement sections, or async
            job metadata — see each operation's example.
        meta:
          type: object
          additionalProperties: true
          description: >-
            Pagination (`page`, `limit`, `total`) and/or report range (`from`,
            `to`). Cash flow may include `previous_period_end`.
    ErrorResponse:
      type: object
      description: >-
        Failed calls. On validation errors, `message` is the field messages
        joined into sentences so an automation can show it directly.
      properties:
        status:
          type: string
          example: failed
        message:
          type: string
          description: >-
            Human-readable error. For validation, field messages joined with a
            space.
        errors:
          type: array
          description: Present on validation failures. One entry per field message.
          items:
            type: object
            required:
              - field
              - message
            properties:
              field:
                type: string
                example: date
              message:
                type: string
                example: The date field is required.
        data:
          description: >-
            On validation failures, a map of field name to a list of messages.
            Other failures may omit `data` or use a different shape.
          oneOf:
            - type: object
              additionalProperties:
                type: array
                items:
                  type: string
            - type: array
            - type: object
      example:
        status: failed
        message: The date field is required. The currency field is required.
        errors:
          - field: date
            message: The date field is required.
          - field: currency
            message: The currency field is required.
        data:
          date:
            - The date field is required.
          currency:
            - The currency field is required.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Business secret `tyms_sk_...` for business-scoped routes. Partner secret
        for register-business and referred-business distributor routes.
      x-default: your_tyms_sk_or_partner_key

````

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