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

# Retrieve miscellaneous parameter definitions for benefit types

> Given one or more benefit types and a pay date, returns the date-effective miscellaneous parameter definitions for each type — including name, data type, default value, validation pattern, pick-list values, and help text. This is the benefit analog of /v1/jurisdictionData and is purely informational.



## OpenAPI

````yaml /ste/api-reference/ste-hosted-api.yaml post /v2/benefitParameterData
openapi: 3.0.3
info:
  title: STE Hosted API
  description: Symmetry Tax Engine Hosted API
  version: all
  termsOfService: https://www.symmetry.com/terms
  contact:
    name: Symmetry Website
    url: https://www.symmetry.com/
servers:
  - url: https://ste.symmetry.com/ste-hosted
security:
  - apiKey: []
tags:
  - name: Account Information and Schema
    description: Account information and schema retrieval endpoints
  - name: Benefits
    description: Employee benefits status and information
  - name: Location Code
    description: Location code lookup
  - name: Location Tax Information
    description: Location-based tax information and configuration
  - name: Payroll Calculations
    description: Payroll tax calculation endpoints
  - name: Tax Information
    description: Tax ID and reference information
  - name: Documentation
    description: API documentation and specification
  - name: STEVersions
    description: Installed STE database version discovery
paths:
  /v2/benefitParameterData:
    post:
      tags:
        - Benefits
      summary: Retrieve miscellaneous parameter definitions for benefit types
      description: >-
        Given one or more benefit types and a pay date, returns the
        date-effective miscellaneous parameter definitions for each type —
        including name, data type, default value, validation pattern, pick-list
        values, and help text. This is the benefit analog of
        /v1/jurisdictionData and is purely informational.
      operationId: benefitParameterData
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                BenefitParameterDataRequest:
                  $ref: '#/components/schemas/BenefitParameterDataRequest'
            example:
              BenefitParameterDataRequest:
                benefitType:
                  - BenefitSimpleIRA
                payDate: '2026-03-24'
          application/xml:
            schema:
              type: object
              properties:
                BenefitParameterDataRequest:
                  $ref: '#/components/schemas/BenefitParameterDataRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BenefitParameterDataResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/BenefitParameterDataResponse'
components:
  schemas:
    BenefitParameterDataRequest:
      type: object
      properties:
        benefitType:
          type: array
          items:
            $ref: '#/components/schemas/benefitTypeValues'
          description: >-
            The benefit type identifier. Must be an integer 100 or greater;
            integers 99 and lower are reserved for default benefit types in the
            engine.
        payDate:
          $ref: '#/components/schemas/date'
    BenefitParameterDataResponse:
      type: object
      properties:
        errorStatus:
          $ref: '#/components/schemas/errorType'
        transactionStamp:
          $ref: '#/components/schemas/transactionStampType'
        benefitCollection:
          type: array
          items:
            type: object
            properties:
              benefitParameterData:
                type: array
                items:
                  $ref: '#/components/schemas/benefitParameterDataType'
    benefitTypeValues:
      type: string
      enum:
        - Benefit125
        - Benefit401K
        - Benefit403B
        - Benefit457
        - BenefitCustom
        - BenefitRoth401K
        - BenefitRoth403B
        - BenefitFSA
        - BenefitHSA
        - BenefitSimpleIRA
        - BenefitRoth457
        - BenefitFSADependentCare
        - BenefitSimpleIRANonelective
        - BenefitRothSimpleIRA
        - BenefitRothSimpleIRANonelective
        - BenefitStarter401K
        - BenefitRothStarter401K
        - BenefitEHTCashBenefit
        - BenefitHSFCashBenefitQuebec
        - BenefitEHTNonCashBenefit
        - BenefitHSFNonCashBenefitQuebec
        - BenefitEHTEarnings
        - BenefitHSFEarningsQuebec
        - BenefitEHTPayInLieu
        - BenefitDependentCustodialAccount
        - BenefitEducationalAssistance
        - BenefitEducationalAssistanceLoanRepayment
    date:
      type: string
    errorType:
      type: object
      properties:
        errorCode:
          type: integer
        errorMessage:
          type: string
    transactionStampType:
      type: object
      properties:
        calcDateTime:
          $ref: '#/components/schemas/dateTime'
        failedTransactions:
          type: integer
        schemaVersion:
          type: string
        steVersion:
          type: string
        totalTransactions:
          type: integer
        transactionType:
          type: string
          enum:
            - PayCalc
            - LocationCode
            - JurisdictionData
            - SetTaxList
            - BenefitStatus
            - BenefitInfo
            - TaxIDList
            - GrossUp
            - GetSchema
            - AccountInfo
            - STEVersions
    benefitParameterDataType:
      type: object
      properties:
        benefitType:
          $ref: '#/components/schemas/benefitTypeValues'
        parameterName:
          type: string
          description: The name of the miscellaneous parameter.
        description:
          type: string
          description: A human-readable description.
        regex:
          type: string
          description: The regular expression used to validate the parameter value.
        regexType:
          allOf:
            - $ref: '#/components/schemas/regexTypeValues'
          description: >-
            How the value is validated: SingleValue (matched against the regular
            expression) or PickList (must be one of the listValues).
        regexDescription:
          type: string
          description: >-
            A human-readable explanation of the validation applied to the
            parameter value.
        listValues:
          nullable: true
          type: string
          description: For a PickList parameter, the set of allowed values.
        defaultValue:
          type: string
          description: The value used when the parameter is not supplied.
        helpText:
          nullable: true
          type: string
          description: Additional guidance describing how to use the parameter.
        dataType:
          $ref: '#/components/schemas/dataTypeValues'
        isOptional:
          type: boolean
          description: Whether the parameter is optional.
        taxEffectiveDate:
          nullable: true
          type: string
          description: The date on which this parameter definition becomes effective.
    dateTime:
      type: string
    regexTypeValues:
      type: string
      enum:
        - SingleValue
        - PickList
    dataTypeValues:
      type: string
      enum:
        - Integer
        - Dollar
        - Boolean
        - String
        - Percentage
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key for authentication. Provide the raw key as the value of the
        Authorization header (no "Bearer" prefix).

````