> ## 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 state-specific parameters

> Returns all possible state parameters for the given state and calculator type. Used to help build out CBS-Widgets UI and calculate paychecks with the STE. Different states have different required fields and validations.



## OpenAPI

````yaml /cbs/api-reference/cbs-api.yaml get /stateparms
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:
  /stateparms:
    get:
      tags:
        - State Parameters
      summary: Get state-specific parameters
      description: >-
        Returns all possible state parameters for the given state and calculator
        type. Used to help build out CBS-Widgets UI and calculate paychecks with
        the STE. Different states have different required fields and
        validations.
      operationId: getStateParms
      parameters:
        - description: Two-letter state or US territory abbreviation
          example: AZ
          in: query
          name: state
          required: false
          schema:
            type: string
        - description: >-
            Epoch time format. 0 (default) gets changed into today's date. Date
            of when to look for active state params
          example: 0
          in: query
          name: date
          required: false
          schema:
            default: 0
            type: number
        - description: The calculator type to get state params for
          example: salary
          in: query
          name: calculator
          required: false
          schema:
            enum:
              - 401k
              - 403b
              - '457'
              - agbonus
              - finalpay
              - flatbonus
              - grossup
              - hourly
              - salary
              - stockoption
              - taxtip
              - tuition
            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:
                Arizona Salary Parameters:
                  description: Arizona Salary Parameters
                  summary: State parameters for Arizona salary calculator
                  value:
                    _links:
                      self:
                        href: >-
                          https://calculators.symmetry.com/api/stateparms?state=Arizona&date=1676042017451&calculator=salary&format=model
                    content:
                      parms:
                        - name: PERCENTSTATE
                          value: '2.0'
                        - name: stateExemption
                          value: false
                        - name: additionalStateWithholding
                          value: '0'
                Unsupported State/Calculator:
                  description: Unsupported State/Calculator
                  summary: Response when state doesn't support calculator type
                  value:
                    _links:
                      self:
                        href: >-
                          https://calculators.symmetry.com/api/stateparms?state=Arizona&calculator=flatbonus&format=model
                    content: >-
                      Arizona does not support this type of calculation. Please
                      select a different state.
          description: >-
            State parameters retrieved successfully (or unsupported
            state/calculator combination message)
        '400':
          content:
            application/json:
              example:
                content: Invalid request parameter state=badstate
          description: Invalid state, calculator, 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/stateparms/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

````