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

# Get deduction object

> Returns the deduction object for a specified deduction type. Supports custom, HSA, and 401k deduction types. Response format can be controlled via the format parameter (model, fields, or schema).



## OpenAPI

````yaml /cbs/api-reference/cbs-api.yaml get /deductions
openapi: 3.1.0
info:
  contact:
    name: Symmetry Software
    url: https://www.symmetry.com
  description: CBS API Documentation for Calculators by Symmetry
  license:
    name: Terms of service
    url: https://www.symmetry.com/terms
  title: CBS API
  version: 1.201.1
servers:
  - url: https://calculators.symmetry.com/api
security: []
tags:
  - description: List of available paycheck calculators
    name: Calculators
  - description: Salary-based paycheck calculations
    name: Salary Calculator
  - description: Hourly-based paycheck calculations
    name: Hourly Calculator
  - description: Reverse paycheck calculations
    name: Grossup Calculator
  - description: 401k retirement contribution calculations
    name: 401k Calculator
  - description: 403b retirement contribution calculations
    name: 403b Calculator
  - description: Final paycheck calculations
    name: Final Pay Calculator
  - description: Stock option exercise income calculations
    name: Stock Option Calculator
  - description: Tuition reimbursement calculations
    name: Tuition Calculator
  - description: Hourly with tips calculations
    name: Tax Tip Calculator
  - description: Flat bonus calculations
    name: Flat Bonus Calculator
  - description: Aggregate bonus calculations
    name: Aggregate Bonus Calculator
  - description: Batch processing and API data objects
    name: Data
  - description: Deduction configuration
    name: Deductions
  - description: PDF report generation
    name: Print
  - description: State-specific tax parameters
    name: State Parameters
  - description: API documentation
    name: Documentation
  - description: Postman collection and environment
    name: Postman
paths:
  /deductions:
    get:
      tags:
        - Deductions
      summary: Get deduction object
      description: >-
        Returns the deduction object for a specified deduction type. Supports
        custom, HSA, and 401k deduction types. Response format can be controlled
        via the format parameter (model, fields, or schema).
      operationId: getDeductions
      parameters:
        - description: The deduction type to retrieve
          example: _custom
          in: query
          name: type
          required: false
          schema:
            enum:
              - 401k
              - _custom
              - hsa
            type: string
        - description: The response data format
          example: model
          in: query
          name: format
          required: false
          schema:
            enum:
              - fields
              - model
              - schema
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                401k Deduction:
                  description: 401k Deduction
                  summary: 401k deduction model
                  value:
                    _links:
                      self:
                        href: >-
                          https://calculators.symmetry.com/api/deductions?type=401k&format=model
                    content:
                      benefitType: _401K
                      deductionAmount: 0
                      deductionMethodType: PERCENT_OF_GROSS
                      deductionName: 401k
                Custom Deduction:
                  description: Custom Deduction
                  summary: Custom deduction model with tax exemption options
                  value:
                    _links:
                      self:
                        href: >-
                          https://calculators.symmetry.com/api/deductions?type=_custom&format=model
                    content:
                      benefitType: _Custom
                      deductionAmount: 0
                      deductionMethodType: PERCENT_OF_GROSS
                      deductionName: Custom
                      exemptFederal: false
                      exemptFica: false
                      exemptLocal: false
                      exemptState: false
                HSA Deduction:
                  description: HSA Deduction
                  summary: HSA deduction model
                  value:
                    _links:
                      self:
                        href: >-
                          https://calculators.symmetry.com/api/deductions?type=hsa&format=model
                    content:
                      benefitType: _HSA
                      deductionAmount: 0
                      deductionMethodType: FIXED_AMOUNT
                      deductionName: Hsa
          description: Deduction object retrieved successfully
        '400':
          content:
            application/json:
              example:
                content: Invalid request parameter type=badtype
          description: Invalid type or format parameter
        '401':
          content:
            application/json:
              example:
                message: No api key found
          description: No API key provided
        '403':
          content:
            application/json:
              example:
                message: Invalid api key
          description: Invalid API key
        '404':
          content:
            application/json:
              example:
                error: Not Found
                path: /api/deductions/badpath
                status: 404
                timestamp: 1641573466465
          description: Invalid endpoint path
        '422':
          description: Unprocessable Entity
        '500':
          description: Internal Server Error
      security:
        - pcc-api-key: []
components:
  securitySchemes:
    pcc-api-key:
      description: API key for CBS API authentication
      in: header
      name: pcc-api-key
      type: apiKey

````