> ## 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 salary calculator configuration > Returns the salary calculator model or field definitions for modeling salary-based employee paychecks ## OpenAPI ````yaml /cbs/api-reference/cbs-api.yaml get /calculators/salary 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: /calculators/salary: get: tags: - Salary Calculator summary: Get salary calculator configuration description: >- Returns the salary calculator model or field definitions for modeling salary-based employee paychecks operationId: getCalculator_3 parameters: - description: Two letter state abbreviation example: AZ in: query name: state required: false schema: type: string - description: 'Response format: model, fields, or schema' example: model in: query name: format required: false schema: enum: - fields - model - schema type: string - description: Include print object example: false in: query name: print required: false schema: default: false type: boolean - description: Include otherIncome object example: false in: query name: imputed required: false schema: default: false type: boolean responses: '200': content: application/json: examples: Salary Calculator Model: description: Salary Calculator Model summary: Salary calculator configuration for Arizona value: _links: calculate: href: >- https://calculators.symmetry.com/api/calculators/salary?report=&showcalc=false&itd=false self: href: >- https://calculators.symmetry.com/api/calculators/salary?state=Arizona&format=model&print=false&imputed=false content: additionalFederalWithholding: 0 checkDate: '2025-11-18T16:56:15.952+00:00' deductions2020: 0 dependents2020: 0 exemptFederal: false exemptFica: false exemptMedicare: false federalAllowances: 0 federalFilingStatusType: SINGLE federalFilingStatusType2020: SINGLE grossPay: 0 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.0' - name: stateExemption value: false - name: additionalStateWithholding value: '0' twoJobs2020: false voluntaryDeductions: - benefitType: _Custom deductionAmount: 0 deductionMethodType: PERCENT_OF_GROSS deductionName: '' exemptFederal: false exemptFica: false exemptLocal: false exemptState: false ytdAmount: 0 w42020: false schema: $ref: '#/components/schemas/SalaryResource' description: Success '400': content: application/json: example: content: Invalid request parameter state=badstate description: Bad Request (invalid parameter) '401': content: application/json: example: message: No api key found description: No API key '403': content: application/json: example: message: Invalid api key description: Invalid API key '404': content: application/json: example: error: Not Found path: /api/calculators/salary/badpath status: 404 timestamp: 1641573466465 description: Not Found '405': content: application/json: example: error: Method Not Allowed path: /api/calculators/salary status: 405 timestamp: 1641572607838 description: Method Not Allowed '422': content: {} description: Unprocessable Entity '500': description: Internal Server Error security: - pcc-api-key: [] components: schemas: SalaryResource: description: HATEOAS response wrapper for salary calculator with hypermedia links properties: _links: $ref: '#/components/schemas/Links' content: $ref: '#/components/schemas/SalaryCalculator' description: Salary calculator configuration type: object Links: additionalProperties: $ref: '#/components/schemas/Link' type: object SalaryCalculator: description: Salary calculator configuration for standard salaried employees properties: additionalFederalWithholding: description: Additional amount to withhold for federal taxes example: 100 minimum: 0 type: number checkDate: description: Date of the paycheck calculation example: '2024-03-15' format: date-time type: string deductions2020: description: Deductions amount from W-4 2020+ Step 4b example: 0 minimum: 0 type: number dependents2020: description: Dependent amount from W-4 2020+ Step 3 example: 4000 minimum: 0 type: number exemptFederal: description: Whether the employee is exempt from federal tax withholding example: false type: boolean exemptFica: description: Whether the employee is exempt from FICA (Social Security) tax example: false type: boolean exemptMedicare: description: Whether the employee is exempt from Medicare tax example: false type: boolean federalAllowances: description: Number of federal tax allowances claimed example: 2 format: int32 minimum: 0 type: integer federalFilingStatusType: description: Federal tax filing status enum: - HEAD_OF_HOUSEHOLD - MARRIED - SINGLE example: SINGLE type: string federalFilingStatusType2020: description: Federal filing status for W-4 2020+ form enum: - HEAD_OF_HOUSEHOLD - MARRIED_FILING_JOINTLY - SINGLE example: SINGLE type: string grossPay: description: Gross pay amount for the calculation period example: 52000 minimum: 0 type: number grossPayType: description: Method used to calculate gross pay enum: - ANNUAL - GROSS_PER_PAYPERIOD - HOURLY - PAY_PER_PERIOD example: ANNUAL type: string grossPayYTD: description: Year-to-date gross pay example: 10000 minimum: 0 type: number otherIncome: description: List of other income sources (imputed income) items: $ref: '#/components/schemas/OtherIncome' type: array otherIncome2020: description: Other income amount from W-4 2020+ Step 4a example: 0 minimum: 0 type: number payFrequency: description: Frequency of pay periods enum: - ANNUALLY - BI_WEEKLY - DAILY - MONTHLY - QUARTERLY - SEMI_ANNUALLY - SEMI_MONTHLY - WEEKLY example: BI_WEEKLY type: string presetDeductions: description: List of preset custom deductions items: $ref: '#/components/schemas/PresetDeduction' type: array presetImputed: description: List of preset imputed income items: $ref: '#/components/schemas/PresetDeduction' type: array print: $ref: '#/components/schemas/PrintInfo' description: Print object for PDF report generation roundFederalWithholding: description: Whether to round federal withholding amounts example: false type: boolean state: description: Two-letter state abbreviation where the employee works enum: - Alabama - Alaska - American Samoa - Arizona - Arkansas - California - Colorado - Connecticut - Delaware - Florida - Georgia - Guam - Hawaii - Idaho - Illinois - Indiana - Iowa - Kansas - Kentucky - Louisiana - Maine - Maryland - Massachusetts - Michigan - Minnesota - Mississippi - Missouri - Montana - N. Mariana Islands - Nebraska - Nevada - New Hampshire - New Jersey - New Mexico - New York - North Carolina - North Dakota - Ohio - Oklahoma - Oregon - Pennsylvania - Puerto Rico - Rhode Island - South Carolina - South Dakota - Tennessee - Texas - US Virgin Islands - Utah - Vermont - Virginia - Washington - Washington DC - West Virginia - Wisconsin - Wyoming example: CA type: string stateInfo: $ref: '#/components/schemas/Stateparms' description: State-specific parameters for the calculation twoJobs2020: description: Whether employee has two jobs (W-4 2020+ Step 2c) example: false type: boolean voluntaryDeductions: description: List of voluntary deductions (401k, HSA, custom deductions, etc.) items: $ref: '#/components/schemas/VoluntaryDeduction' type: array w42020: description: Whether using W-4 form from 2020 or later (vs. pre-2020 W-4) example: false type: boolean required: - additionalFederalWithholding - federalAllowances - grossPay - grossPayYTD - state type: object Link: properties: deprecation: type: string href: type: string hreflang: type: string name: type: string profile: type: string templated: type: boolean title: type: string type: type: string type: object OtherIncome: properties: exemptFederal: type: boolean exemptFica: type: boolean exemptLocal: type: boolean exemptState: type: boolean imputed: type: boolean incomeAmount: type: number incomeName: type: string incomeType: enum: - $ Fixed Amount - $ Hourly Rate - '% of Gross Pay' - '% of Net Pay' type: string type: object PresetDeduction: description: >- Preset deduction with name-value format for simple deduction configuration properties: amount: description: Deduction amount or percentage example: 5 type: string name: description: Deduction name example: 401k type: string ytd: description: Year-to-date deduction amount example: 0 type: string type: object PrintInfo: description: >- Print information interface for PDF report generation including employee/company details and check information properties: checkDate: format: date-time type: string checkNumber: type: string checkNumberOnCheck: type: boolean companyAddressLine1: type: string companyAddressLine2: type: string companyAddressLine3: type: string companyName: type: string companyNameOnCheck: type: boolean employeeAddressLine1: type: string employeeAddressLine2: type: string employeeAddressLine3: type: string employeeName: type: string id: type: string remarks: type: string type: object Stateparms: description: >- State-specific parameters including state tax configuration and local/county information properties: local: $ref: '#/components/schemas/Locale' description: Local/county tax location information parms: description: State-specific parameter name-value pairs items: $ref: '#/components/schemas/NameValue' type: array type: object VoluntaryDeduction: properties: benefitType: type: string deductionAmount: type: number deductionMethodType: enum: - $ Fixed Amount - $ Hourly Rate - '% of Gross Pay' - '% of Net Pay' type: string deductionName: type: string exemptFederal: type: boolean exemptFica: type: boolean exemptLocal: type: boolean exemptState: type: boolean ytdAmount: type: number type: object Locale: description: >- Locale/location information including address, city, state, zip, and resident/exempt flags for local tax calculations properties: address1: type: string address2: type: string city: type: string exempt: type: boolean resident: type: boolean state: type: string zip: type: string zip4: type: string type: object NameValue: description: >- Name-value pair for representing various data structures (state parameters, list values, tax types, etc.) properties: name: description: Name or label example: Federal type: string value: description: Value associated with the name example: 100.5 type: object securitySchemes: pcc-api-key: description: API key for CBS API authentication in: header name: pcc-api-key type: apiKey ````