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

# Generate Employee Tax Parameter Definitions

> Retrieve all tax parameters used for withholding calculations.



## OpenAPI

````yaml openapi/zeal-api.json post /employees/getTaxParameterDefinitions
openapi: 3.1.0
info:
  title: zeal-api
  version: '1.0'
servers:
  - url: https://api.zeal.com
security:
  - sec0: []
paths:
  /employees/getTaxParameterDefinitions:
    post:
      summary: Generate Employee Tax Parameter Definitions
      description: Retrieve all tax parameters used for withholding calculations.
      operationId: get-employee-tax-parameter-definitions
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - jurisdictions
              properties:
                jurisdictions:
                  type: array
                  description: '"US" for federal or a US State (2 letter abbreviation)'
                  items:
                    type: string
            examples:
              Request Example:
                value:
                  jurisdictions:
                    - CA
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    success: true
                    data:
                      US:
                        - code: FILINGSTATUS
                          label: Filing Status
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                          type: options
                          options:
                            - code: S
                              name: Single or Married filing separately
                              effectiveDate: 2020
                            - code: M
                              name: Married filing jointly
                              effectiveDate: 2020
                            - code: H
                              name: Head of Household
                              effectiveDate: 2020
                          defaults:
                            - effectiveDate: 2020
                              code: S
                        - code: IS_NON_RESIDENT_ALIEN
                          label: Nonresident Alien
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                          type: boolean
                          defaults:
                            - effectiveDate: 2020
                              value: false
                        - code: TWO_JOBS
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                          label: Two Jobs
                          type: boolean
                          defaults:
                            - effectiveDate: 2020
                              value: false
                        - code: DEPENDENTS_AMOUNT
                          label: Dependents Amount
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                          type: dollars
                          constraints:
                            - min: 0
                              max: null
                              effectiveDate: 2020
                          defaults:
                            - effectiveDate: 2020
                              value: 0
                        - code: OTHER_INCOME
                          label: Other Income
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                          type: dollars
                          constraints:
                            - min: 0
                              max: null
                              effectiveDate: 2020
                          defaults:
                            - effectiveDate: 2020
                              value: 0
                        - code: EXTRA_WH
                          label: Extra Withholding
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                          type: dollars
                          constraints:
                            - min: 0
                              max: null
                              effectiveDate: 2020
                          defaults:
                            - effectiveDate: 2020
                              value: 0
                        - code: DEDUCTIONS
                          label: Deductions
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                          type: dollars
                          constraints:
                            - min: 0
                              max: null
                              effectiveDate: 2020
                          defaults:
                            - effectiveDate: 2020
                              value: 0
                        - code: EXEMPT
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                          type: boolean
                          defaults:
                            - effectiveDate: 2020
                              value: false
                          label: Exempt from withholding
                        - code: SUBJECT
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                          type: boolean
                          defaults:
                            - effectiveDate: 2020
                              value: true
                          label: Subject to tax
                        - type: options
                          code: FICA_SocialSecurity_EE_EXEMPT
                          label: FICA Social Security Employee Exempt
                          scope: FICA_SocialSecurity_EE
                          options:
                            - code: NOT_EXEMPT
                              name: Not exempt
                              effectiveDate: 2020
                            - code: NO_REPORTING
                              name: No reporting
                              effectiveDate: 2020
                            - code: NO_WITHHOLDING
                              name: No withholding
                              effectiveDate: 2020
                          defaults:
                            - code: NOT_EXEMPT
                              effectiveDate: 2020
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                        - type: options
                          code: FICA_Medicare_EE_EXEMPT
                          label: FICA Medicare Employee Exempt
                          scope: FICA_Medicare_EE
                          options:
                            - code: NOT_EXEMPT
                              name: Not exempt
                              effectiveDate: 2020
                            - code: NO_REPORTING
                              name: No reporting
                              effectiveDate: 2020
                            - code: NO_WITHHOLDING
                              name: No withholding
                              effectiveDate: 2020
                          defaults:
                            - code: NOT_EXEMPT
                              effectiveDate: 2020
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                        - type: options
                          code: FICA_Medicare_ER_EXEMPT
                          label: FICA Medicare Employer Exempt
                          scope: FICA_Medicare_ER
                          options:
                            - code: NOT_EXEMPT
                              name: Not exempt
                              effectiveDate: 2020
                            - code: NO_REPORTING
                              name: No reporting
                              effectiveDate: 2020
                            - code: NO_WITHHOLDING
                              name: No withholding
                              effectiveDate: 2020
                          defaults:
                            - code: NOT_EXEMPT
                              effectiveDate: 2020
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                        - type: options
                          code: FICA_SocialSecurity_ER_EXEMPT
                          label: FICA Social Security Employer Exempt
                          scope: FICA_SocialSecurity_ER
                          options:
                            - code: NOT_EXEMPT
                              name: Not exempt
                              effectiveDate: 2020
                            - code: NO_REPORTING
                              name: No reporting
                              effectiveDate: 2020
                            - code: NO_WITHHOLDING
                              name: No withholding
                              effectiveDate: 2020
                          defaults:
                            - code: NOT_EXEMPT
                              effectiveDate: 2020
                          effectiveDate: '2020-01-01T00:00:00.000Z'
                        - type: options
                          code: FUTA_EXEMPT
                          label: FUTA Exempt
                          scope: FUTA
                          options:
                            - code: NOT_EXEMPT
                              name: Not exempt
                              effectiveDate: 2020
                            - code: NO_REPORTING
                              name: No reporting
                              effectiveDate: 2020
                            - code: NO_WITHHOLDING
                              name: No withholding
                              effectiveDate: 2020
                          defaults:
                            - code: NOT_EXEMPT
                              effectiveDate: 2020
                          effectiveDate: '2020-01-01T00:00:00.000Z'
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    default: true
                  data:
                    type: object
                    properties:
                      US:
                        type: array
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              example: FILINGSTATUS
                            label:
                              type: string
                              example: Filing Status
                            effectiveDate:
                              type: string
                              example: '2020-01-01T00:00:00.000Z'
                            type:
                              type: string
                              example: options
                            options:
                              type: array
                              items:
                                type: object
                                properties:
                                  code:
                                    type: string
                                    example: S
                                  name:
                                    type: string
                                    example: Single or Married filing separately
                                  effectiveDate:
                                    type: integer
                                    example: 2020
                                    default: 0
                            defaults:
                              type: array
                              items:
                                type: object
                                properties:
                                  effectiveDate:
                                    type: integer
                                    example: 2020
                                    default: 0
                                  code:
                                    type: string
                                    example: S
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value:
                    success: false
                    errors:
                      - message: Invalid tax parameter jurisdiction
                        code: 91
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                    default: true
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Invalid tax parameter jurisdiction
                        code:
                          type: integer
                          example: 91
                          default: 0
      deprecated: false
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: bearer

````