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

# List Required Additional Tax Fields by Country

> Returns a list of tax-related additionalfields required to run calculations in the specified country



## OpenAPI

````yaml /openapi/global-tax.yaml get /v1/tax/fields
openapi: 3.0.0
info:
  title: Global Tax Engine
  version: 1.0.0
  description: API module for calculating taxes globally
  termsOfService: https://cadanapay.com/terms-and-conditions
  contact:
    email: api@cadanapay.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.cadanapay.com
    description: Prod Server
  - url: https://dev-api.cadanapay.com
    description: Dev Server
security:
  - Authorization: []
tags:
  - name: Tax Calculator
    description: APIs for tax calculations
paths:
  /v1/tax/fields:
    get:
      tags:
        - Tax Calculator
      summary: List Required Additional Tax Fields by Country
      description: >-
        Returns a list of tax-related additionalfields required to run
        calculations in the specified country
      operationId: listCountryTaxFields
      parameters:
        - name: country
          in: query
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/XMultiTenantKey'
      responses:
        '200':
          description: Required tax fields by country
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequiredTaxFieldsResponse'
              example:
                data:
                  - name: maritalStatus
                    required: true
                    type: string
                    enum:
                      - single
                      - married
                      - divorced
                      - widowed
                    description: Marital status for tax deduction eligibility
                  - name: numberOfDependents
                    required: false
                    type: number
                    description: Number of dependents for tax relief
                    default: 0
                  - name: isResident
                    required: false
                    type: boolean
                    description: Whether the worker is a tax resident
                    default: true
                  - name: employerIndustry
                    required: false
                    type: string
                    description: Industry classification used for local tax variations
        '400':
          $ref: '#/components/responses/BadRequestError'
      security:
        - Authorization: []
components:
  parameters:
    XMultiTenantKey:
      name: X-MultiTenantKey
      in: header
      required: false
      schema:
        type: string
      description: >-
        Required when using a Platform API token. The tenant key identifying
        which business to operate on.
  schemas:
    RequiredTaxFieldsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: >-
                  Field key used in `additionalAttributes` on `POST
                  /v1/tax/calculate` or in the person's `taxProfile`.
              description:
                type: string
              type:
                type: string
                description: >-
                  Data type of the field value (e.g. "string", "number",
                  "boolean").
              required:
                type: boolean
              enum:
                type: array
                items:
                  type: string
                description: Allowed values when the field accepts a fixed set of options.
              default:
                description: >-
                  Default value applied by the engine when the field is omitted
                  from the calculation. Present only when the field declares a
                  default. Use it to pre-fill onboarding forms — optional fields
                  that have a default need no user input. The type matches the
                  field's `type` (string, number, or boolean).
              provider:
                type: string
                description: Internal source that surfaces this field. May be omitted.
    BadRequestError:
      description: Bad input provided by client
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            params:
              description: A map for meta data around the error that occurred
              type: object
      example:
        code: invalid_request_body
        message: The request body provided is not valid
        params:
          field: Value is invalid.
    Error:
      type: object
      properties:
        code:
          description: A machine parsable error code
          type: string
          enum:
            - invalid_request_body
            - resource_not_found
            - forbidden
            - internal_error
        message:
          description: A human readable message describing the error
          type: string
  responses:
    BadRequestError:
      description: Bad input provided by client
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      bearerFormat: API_SECRET_KEY

````