> ## 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.

# Return SPF-to-STE tax parameter mappings

> Returns the mapping from SPF tax parameters to their STE equivalents, resolved for the given effective date. Each parameter entry reflects the most recent mapping version with an effectiveDate on or before the requested date. If no effectiveDate is supplied, today's date is used.



## OpenAPI

````yaml /spf/api-reference/payroll-forms-api.yaml get /steMapping
openapi: 3.0.1
info:
  title: SPF Api
  contact:
    name: Symmetry Software
    url: https://www.symmetry.com
    email: support@symmetry.com
  license:
    name: Symmetry Software/Subscription & Service Agreement
    url: http://www.symmetry.com/software-subscription-license
  version: 1.94.0
  x-release-name:
    value: 2026.7.1
  x-endpoint-versions:
    fill_pdf_post_version: 1.95.0
    forms_version: 1.95.0
    form_questions_version: 1.95.0
    docs_version: 1.93.0
    guided_flows_version: 1.95.0
    flow_questions_version: 1.95.0
    getPdf_version: 1.95.0
    ste_mapping_version: 1.1.0
    fill_pdf_get_version: 1.95.0
    /v2/forms_version: 1.95.0
    form_ids_version: 1.95.0
    form_catalog_version: 1.87.0
servers:
  - url: https://api.symmetry.com/spf
    description: prod2
security: []
tags:
  - name: Forms
    description: Determine all applicable forms and retrieve information for each
  - name: Questions
    description: Retrieve form and guide flow questions
  - name: PDF and Tax Parameters
    description: Retrieve pdf and tax parameter schemas and generate filled documents
  - name: Documentation
    description: Retrieve OpenApi configuration yaml and use it to generate a client api
  - name: Postman
    description: Resources for Postman
  - name: STE Mapping
    description: Retrieve SPF-to-STE tax parameter mappings
paths:
  /steMapping:
    get:
      tags:
        - STE Mapping
      summary: Return SPF-to-STE tax parameter mappings
      description: >-
        Returns the mapping from SPF tax parameters to their STE equivalents,
        resolved for the given effective date. Each parameter entry reflects the
        most recent mapping version with an effectiveDate on or before the
        requested date. If no effectiveDate is supplied, today's date is used.
      operationId: getSteMapping
      parameters:
        - name: effectiveDate
          in: query
          description: >-
            ISO-8601 date (yyyy-MM-dd). Returns the mapping active as of this
            date. Defaults to today if omitted. Returns 400 if the format is
            invalid.
          required: false
          schema:
            type: string
            format: date
          example: '2026-01-01'
        - name: formId
          in: query
          description: >-
            Restrict the response to a single form. Returns an empty forms array
            for unknown form IDs.
          required: false
          schema:
            type: string
          example: W4101
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SteMapping'
              examples:
                Single form, single parameter:
                  summary: W-4 filing status mapping as of 2026-01-01
                  description: Single form, single parameter
                  value:
                    spfRelease: 2026.7.1
                    steRelease: 2026.6.2
                    asOf: '2026-01-01'
                    forms:
                      - formId: W4101
                        formName: 'Form W-4: Employee''s Withholding Certificate'
                        parameters:
                          - spfTaxParameter: FED.filingStatus
                            steMiscellaneousParameter: FILINGSTATUS
                            correspondingSteUniqueTaxIds:
                              - 00-000-0000-FIT-000
                            effectiveDate: '2026-01-01'
        '400':
          description: effectiveDate is present but not a valid ISO-8601 date (yyyy-MM-dd)
          content: {}
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - jwtToken: []
components:
  schemas:
    SteMapping:
      type: object
      properties:
        spfRelease:
          type: string
          description: The SPF release these mappings correspond to
          example: 2026.7.1
        steRelease:
          type: string
          description: The STE release these mappings correspond to
          example: 2026.6.2
        asOf:
          type: string
          description: The date for which the mappings were resolved
          example: '2026-06-15'
        forms:
          type: array
          description: The form-level mappings
          items:
            $ref: '#/components/schemas/SteMappingForm'
      description: SPF to STE tax parameter mapping
    ApiError:
      type: object
      properties:
        path:
          type: string
        status:
          type: string
        statusCode:
          type: integer
          format: int32
        timestamp:
          type: string
          format: date-time
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
        errorCount:
          type: integer
          format: int32
    SteMappingForm:
      type: object
      properties:
        formId:
          type: string
          description: The SPF form ID
          example: W4101
        formName:
          type: string
          description: The full form name
          example: 'Form W-4: Employee''s Withholding Certificate'
        parameters:
          type: array
          description: The tax parameter mappings for this form
          items:
            $ref: '#/components/schemas/SteMappingParameter'
      description: SPF-to-STE tax parameter mappings for a single form
    ValidationError:
      type: object
      properties:
        field:
          type: string
        message:
          type: string
        rejectedValue:
          type: string
    SteMappingParameter:
      type: object
      properties:
        spfTaxParameter:
          type: string
          description: The SPF tax parameter name
          example: FED.dependentsAmt
        steMiscellaneousParameter:
          type: string
          description: The STE miscellaneous parameter name, if applicable
          example: DEPENDENTS_AMT
        steStandardParameter:
          type: string
          description: The STE standard parameter name, if applicable
          example: additionalWH
        correspondingSteUniqueTaxIds:
          type: array
          description: The STE unique tax IDs this parameter applies to
          example:
            - 00-000-0000-FIT-000
          items:
            type: string
            description: The STE unique tax IDs this parameter applies to
            example: '["00-000-0000-FIT-000"]'
        notes:
          type: string
          description: Additional mapping notes
          example: FED.nonResidentAlien = true; FILINGSTATUS = "NRA"
        effectiveDate:
          type: string
          description: The date from which this mapping is effective
          example: '2026-01-01'
      description: A single SPF tax parameter mapped to its STE equivalents
  securitySchemes:
    jwtToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````