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

# Process batch calculator requests

> POST's multiple calculator calculations to the STE for async queue processing. Returns an array of calculation results with tax details and deductions.



## OpenAPI

````yaml /cbs/api-reference/cbs-api.yaml post /data/batch
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:
  /data/batch:
    post:
      tags:
        - Data
      summary: Process batch calculator requests
      description: >-
        POST's multiple calculator calculations to the STE for async queue
        processing. Returns an array of calculation results with tax details and
        deductions.
      operationId: calculateBatch
      requestBody:
        content:
          application/json:
            examples:
              Batch Calculator Request:
                description: Batch Calculator Request
                summary: Multiple calculator requests
                value:
                  - calculator:
                      checkDate: 1464291711938
                      federalAllowances: 0
                      federalFilingStatusType: SINGLE
                      grossPay: 52000
                      grossPayType: ANNUALLY
                      grossPayYTD: 0
                      payFrequency: WEEKLY
                      state: AZ
                      stateInfo:
                        parms:
                          - name: PERCENTSTATE
                            value: '2.7'
                          - name: stateExemption
                            value: false
                      voluntaryDeductions:
                        - benefitType: _401k
                          deductionAmount: 2
                          deductionMethodType: PERCENT_OF_GROSS
                          deductionName: 401k
                          exemptFederal: true
                          exemptFica: true
                          exemptLocal: true
                          exemptState: true
                      w42020: false
                    profileHash: ''
                  - calculator:
                      checkDate: 1579813694317
                      federalFilingStatusType: SINGLE
                      grossPayType: PAY_PER_PERIOD
                      payFrequency: WEEKLY
                      rates:
                        - hours: 70
                          payRate: 30
                      state: AZ
                    profileHash: ''
            schema:
              type: string
        description: Array of calculator objects
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                Batch Response:
                  description: Batch Response
                  summary: Array of calculation results
                  value:
                    _links:
                      self:
                        href: https://calculators.symmetry.com/api/data/batch
                    content:
                      - profileHash: ''
                        response:
                          calculator:
                            additionalFederalWithholding: 0
                            checkDate: '2016-05-26T19:41:51.938+00:00'
                            deductions2020: 0
                            dependents2020: 0
                            exemptFederal: false
                            exemptFica: false
                            exemptMedicare: false
                            federalAllowances: 0
                            federalFilingStatusType: SINGLE
                            federalFilingStatusType2020: SINGLE
                            grossPay: 52000
                            grossPayType: ANNUALLY
                            grossPayYTD: 0
                            otherIncome: null
                            otherIncome2020: 0
                            payFrequency: WEEKLY
                            presetDeductions: null
                            presetImputed: null
                            print: null
                            roundFederalWithholding: false
                            state: AZ
                            stateInfo:
                              parms:
                                - name: PERCENTSTATE
                                  value: '2.7'
                                - name: stateExemption
                                  value: false
                            twoJobs2020: false
                            voluntaryDeductions:
                              - benefitType: _401k
                                deductionAmount: 2
                                deductionMethodType: PERCENT_OF_GROSS
                                deductionName: 401k
                                exemptFederal: true
                                exemptFica: true
                                exemptLocal: true
                                exemptState: true
                                ytdAmount: null
                            w42020: false
                          eic: 0
                          federal: 152.86
                          fica: 62
                          grossPay: 1000
                          localeTaxes: []
                          medicare: 14.5
                          netPay: 724.18
                          state: 26.46
                          stateTaxTypes: []
                          taxPaidDetails:
                            - amtPaid: 62
                              description: Employer Social Security Tax
                              grossSubjectWages: 1000
                              grossWages: 1000
                              locationCode: 00-000-0000
                              payType: COMBINED
                              subjectWages: 1000
                              uTaxID: 00-000-0000-ER_FICA-000-Res-Comb
                            - amtPaid: 14.5
                              description: Employer Medicare Tax
                              grossSubjectWages: 1000
                              grossWages: 1000
                              locationCode: 00-000-0000
                              payType: COMBINED
                              subjectWages: 1000
                              uTaxID: 00-000-0000-ER_MEDI-000-Res-Comb
                            - amtPaid: 62
                              description: Social Security Tax
                              grossSubjectWages: 1000
                              grossWages: 1000
                              locationCode: 00-000-0000
                              payType: COMBINED
                              subjectWages: 1000
                              uTaxID: 00-000-0000-FICA-000-Res-Comb
                            - amtPaid: 152.86
                              description: Federal Income Tax
                              grossSubjectWages: 980
                              grossWages: 1000
                              locationCode: 00-000-0000
                              payType: REGULAR
                              subjectWages: 980
                              uTaxID: 00-000-0000-FIT-000-Res-Reg
                            - amtPaid: 14.5
                              description: Medicare Tax
                              grossSubjectWages: 1000
                              grossWages: 1000
                              locationCode: 00-000-0000
                              payType: COMBINED
                              subjectWages: 1000
                              uTaxID: 00-000-0000-MEDI-000-Res-Comb
                            - amtPaid: 0
                              description: Additional Medicare
                              grossSubjectWages: 1000
                              grossWages: 1000
                              locationCode: 00-000-0000
                              payType: COMBINED
                              subjectWages: 0
                              uTaxID: 00-000-0000-MEDI2-000-Res-Comb
                            - amtPaid: 26.46
                              description: Arizona State Tax
                              grossSubjectWages: 980
                              grossWages: 1000
                              locationCode: 04-000-9999
                              payType: REGULAR
                              subjectWages: 980
                              uTaxID: 04-000-0000-SIT-000-Res-Reg
                          timeStamp: 1763492700787
                          voluntaryDeductions:
                            - name: 401k
                              value: '20.00'
                      - profileHash: ''
                        response:
                          calculator:
                            additionalFederalWithholding: 0
                            checkDate: '2020-01-23T21:08:14.317+00:00'
                            deductions2020: 0
                            dependents2020: 0
                            exemptFederal: false
                            exemptFica: false
                            exemptMedicare: false
                            federalAllowances: 0
                            federalFilingStatusType: SINGLE
                            federalFilingStatusType2020: SINGLE
                            grossPayType: PAY_PER_PERIOD
                            grossPayYTD: 0
                            otherIncome: null
                            otherIncome2020: 0
                            payFrequency: WEEKLY
                            presetDeductions: null
                            presetImputed: null
                            print: null
                            rates:
                              - hours: 70
                                payRate: 30
                            roundFederalWithholding: false
                            state: AZ
                            stateInfo: {}
                            twoJobs2020: false
                            voluntaryDeductions:
                              - benefitType: _Custom
                                deductionAmount: 0
                                deductionMethodType: PERCENT_OF_GROSS
                                deductionName: ''
                                exemptFederal: false
                                exemptFica: false
                                exemptLocal: false
                                exemptState: false
                                ytdAmount: 0
                            w42020: false
                          eic: 0
                          federal: 372.61
                          fica: 130.2
                          grossPay: 2100
                          localeTaxes: []
                          medicare: 30.45
                          netPay: 1510.04
                          state: 56.7
                          stateTaxTypes: []
                          taxPaidDetails:
                            - amtPaid: 130.2
                              description: Employer Social Security Tax
                              grossSubjectWages: 2100
                              grossWages: 2100
                              locationCode: 00-000-0000
                              payType: COMBINED
                              subjectWages: 2100
                              uTaxID: 00-000-0000-ER_FICA-000-Res-Comb
                            - amtPaid: 30.45
                              description: Employer Medicare Tax
                              grossSubjectWages: 2100
                              grossWages: 2100
                              locationCode: 00-000-0000
                              payType: COMBINED
                              subjectWages: 2100
                              uTaxID: 00-000-0000-ER_MEDI-000-Res-Comb
                            - amtPaid: 130.2
                              description: Social Security Tax
                              grossSubjectWages: 2100
                              grossWages: 2100
                              locationCode: 00-000-0000
                              payType: COMBINED
                              subjectWages: 2100
                              uTaxID: 00-000-0000-FICA-000-Res-Comb
                            - amtPaid: 372.61
                              description: Federal Income Tax
                              grossSubjectWages: 2100
                              grossWages: 2100
                              locationCode: 00-000-0000
                              payType: REGULAR
                              subjectWages: 2100
                              uTaxID: 00-000-0000-FIT-000-Res-Reg
                            - amtPaid: 30.45
                              description: Medicare Tax
                              grossSubjectWages: 2100
                              grossWages: 2100
                              locationCode: 00-000-0000
                              payType: COMBINED
                              subjectWages: 2100
                              uTaxID: 00-000-0000-MEDI-000-Res-Comb
                            - amtPaid: 0
                              description: Additional Medicare
                              grossSubjectWages: 2100
                              grossWages: 2100
                              locationCode: 00-000-0000
                              payType: COMBINED
                              subjectWages: 0
                              uTaxID: 00-000-0000-MEDI2-000-Res-Comb
                            - amtPaid: 56.7
                              description: Arizona State Tax
                              grossSubjectWages: 2100
                              grossWages: 2100
                              locationCode: 04-000-9999
                              payType: REGULAR
                              subjectWages: 2100
                              uTaxID: 04-000-0000-SIT-000-Res-Reg
                          timeStamp: 1763492700786
                          voluntaryDeductions:
                            - name: ''
                              value: '0.00'
          description: Batch calculations processed successfully
        '400':
          content:
            application/json:
              example:
                content: Error occurred calculating batch
          description: Invalid batch request - error calculating batch
        '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/data/batch/badpath
                status: 404
                timestamp: 1641573466465
          description: Invalid endpoint path
        '405':
          content:
            application/json:
              example:
                error: Method Not Allowed
                path: /api/data/batch
                status: 405
                timestamp: 1641572607838
          description: Method not allowed
        '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

````