--- updatedAt: 2026-08-31T14:49:29.000Z --- # Service Operation for calculating vacation pay. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "version": "2.0.0", "title": "Payroll Cloud v2" }, "servers": [ { "url": "https://payroll-test.vertexcloud.com/payroll", "description": "Production Test" } ], "security": [ { "BearerAuth": [] } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": false }, "tags": [ { "name": "VacationPay", "description": "The VacationPay API is used to perform vacation pay processing. Vacation pay refers to those wages paid in advance for a specific pay date that represents the duration of an employee's vacation." } ], "paths": { "/v2/vacation-pay": { "post": { "summary": "Service Operation for calculating vacation pay.", "operationId": "calculateVacationPay", "tags": [ "VacationPay" ], "requestBody": { "description": "The paycheck to calculate", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vacationPay" } } } }, "responses": { "200": { "description": "Expected payroll tax results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paycheckCalculation" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorResponse" } } } } } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "OAuth 2.0 Bearer token. Request a token from your token endpoint and insert it here." } }, "schemas": { "errorResponse": { "type": "object", "properties": { "errors": { "type": "array", "description": "Collection of one or more errors resulting from the request.", "items": { "$ref": "#/components/schemas/Error" } } } }, "Error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "target": { "type": "string" } } }, "vacationPay": { "type": "object", "properties": { "payCheck": { "$ref": "#/components/schemas/paycheck" }, "regularGrossPay": { "type": "number", "description": "The regular gross pay with two digits precision decimal.", "multipleOf": 0.01, "minimum": 1 }, "overrideVacationPayFactor": { "type": "number", "description": "Override to the ratio of vacation time to current pay period." } }, "required": [ "payCheck", "regularGrossPay" ] }, "paycheck": { "type": "object", "description": "This is used to calculate payroll taxes for a particular employee. The employee's compensations, deductions, and work locations should be included on the the request. The computed taxes, deductions allowed, and compensations allowed are returned.", "properties": { "employee": { "description": "Information about the employee.", "type": "object", "properties": { "employeeId": { "type": "string", "maxLength": 30, "description": "An employee identifier. This is a character string that serves as an identifier for this particular employee. This field is returned with the calculation results." }, "payPeriod": { "type": "object", "properties": { "payDate": { "allOf": [ { "$ref": "#/components/schemas/date" }, { "description": "Pay date in format YYYY-MM-DD. For example, September 27, 2012 is represented as 2012-09-27." } ] }, "totalPeriods": { "type": "integer", "description": "The number of pay periods in the year. For example, if the employee is paid weekly, this number is 52.", "minimum": 1 }, "currentPeriod": { "type": "integer", "description": "The current pay period. For example, if this was the tenth pay period of the year, currentPeriod is set to 10.", "minimum": 1 } }, "required": [ "payDate", "totalPeriods", "currentPeriod" ] }, "defaultSupplementalPayTypeTreatment": { "allOf": [ { "$ref": "#/components/schemas/payTypeTreatment" }, { "description": "Indicates whether this pay calculation is for regular pay, supplemental pay, or both (regular and supplemental)." } ] }, "residenceGeocodeId": { "allOf": [ { "$ref": "#/components/schemas/geocodeId" }, { "description": "The geocode of the employee's residence." } ] }, "primaryWorkGeocodeId": { "allOf": [ { "$ref": "#/components/schemas/geocodeId" }, { "description": "The geocode of the employee's primary work location. For a definition of primary work location and guidelines for how to determine it, refer to the entry Primary Work Location in the Glossary section of the Vertex Payroll Tax Calculation Guide for US." } ] }, "residentSchoolDistrictId": { "allOf": [ { "$ref": "#/components/schemas/schoolDistrictId" }, { "description": "The school district number of the employee's residential school district." } ] }, "primaryWorkSchoolDistrictId": { "allOf": [ { "$ref": "#/components/schemas/schoolDistrictId" }, { "description": "The school district of the primary work location. Not used by any current taxing jurisdiction." } ] }, "specialPayPeriod": { "$ref": "#/components/schemas/specialPayPeriod" }, "periodToDateAggregation": { "type": "boolean", "description": "Period-to-date aggregation flag. If this flag is set to true, it indicates that this pay supplements another pay in the same pay period." } }, "required": [ "employeeId", "residenceGeocodeId", "payPeriod", "primaryWorkGeocodeId" ] }, "workLocations": { "type": "array", "items": { "$ref": "#/components/schemas/workLocation" } }, "deductions": { "type": "array", "items": { "$ref": "#/components/schemas/deduction" } }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/jurisdiction" } }, "aggregatedCompensations": { "type": "array", "items": { "$ref": "#/components/schemas/aggregatedCompensation" } }, "aggregatedTaxes": { "type": "array", "items": { "$ref": "#/components/schemas/aggregatedTax" } }, "calculationOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/calculationOverride" } }, "canadianDetails": { "type": "array", "items": { "$ref": "#/components/schemas/canadianDetail" } }, "formsData": { "type": "array", "items": { "$ref": "#/components/schemas/formData" } }, "compensationOverrides": { "type": "array", "description": "Provides the option to override pre-calculation compensation values at the tax object level.", "items": { "$ref": "#/components/schemas/compensationOverride" } }, "deductionOverrides": { "type": "array", "description": "Provides the option to override pre-calculation deduction values at the tax object level.", "items": { "$ref": "#/components/schemas/deductionOverride" } }, "options": { "type": "object", "properties": { "reportZeroTax": { "type": "boolean", "description": "Set to true if you want to see a tax result generated even when the tax amount and adjusted gross are zero.", "default": false }, "processInvalidGeocode": { "type": "boolean", "description": "Set to TRUE if you want to see invalid geocode processing.", "default": false } } } }, "required": [ "employee" ] }, "formData": { "type": "object", "description": "Additional information needed to calculate certain taxes.", "properties": { "taxIdentifierId": { "allOf": [ { "$ref": "#/components/schemas/taxIdentifierId" }, { "description": "Applies to the Tax id. For the complete list, refer to /tax-identifiers query." } ] }, "geocodeId": { "allOf": [ { "$ref": "#/components/schemas/geocodeId" }, { "description": "The geocode that applies to the jurisdiction. A value of 000000000 defaults to federal taxes. For state taxes, supply a geocode with the state part specified and the county and local parts zeroed (that is, 390000000 for Pennsylvania)." } ] }, "schoolDistrictId": { "allOf": [ { "$ref": "#/components/schemas/schoolDistrictId" }, { "description": "Specifies the school district (relevant only for certain taxes)." } ] }, "taxingLocationType": { "$ref": "#/components/schemas/taxingLocationType" }, "formFieldIdentifier": { "type": "string", "description": "Identifying string for the form (or field within form) in DOM format." }, "formFieldValue": { "type": "string", "description": "The value to use for the field." } }, "required": [ "geocodeId", "taxingLocationType", "formFieldIdentifier" ] }, "paycheckCalculation": { "type": "object", "description": "This is used to calculate payroll taxes for a particular employee. The employee's compensations, deductions, and work locations should be included on the the request. The computed taxes, deductions allowed, and compensations allowed are returned.", "properties": { "employeeId": { "type": "string", "maxLength": 30, "description": "An employee identifier. This is a character string that serves as an identifier for this particular employee. This field is returned with the calculation results." }, "grossUpPay": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "When a gross up calculation is invoked by setting targetNet on the request, this field represents the calculated gross pay. Two digits precision decimal for dollar." } ] }, "vacationPayFactor": { "type": "number", "description": "Ratio of vacation time to current pay period." }, "taxResults": { "type": "array", "items": { "$ref": "#/components/schemas/taxResult" } }, "compensationResults": { "type": "array", "items": { "$ref": "#/components/schemas/compensationResult" } }, "deductionResults": { "type": "array", "items": { "$ref": "#/components/schemas/deductionResult" } }, "formResults": { "type": "array", "items": { "$ref": "#/components/schemas/formResult" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } }, "versionInfo": { "$ref": "#/components/schemas/versionInfo" } } }, "taxResult": { "type": "object", "description": "Individual payroll tax results.", "properties": { "taxRecordIdentifier": { "$ref": "#/components/schemas/taxRecordIdentifier" }, "taxRecordType": { "$ref": "#/components/schemas/taxRecordType" }, "taxName": { "type": "string", "description": "Descriptive name for the tax result." }, "taxType": { "$ref": "#/components/schemas/taxType" }, "calculationStatus": { "$ref": "#/components/schemas/calculationStatus" }, "taxAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The dollar amount of the tax. This is what displays on the employee’s pay stub. Additionally, aggregations of this amount need to be fed back in with the next payroll as part of the aggregatedTaxes array. Two digits precision decimal for dollar." } ] }, "supplementalPayTaxAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The dollar amount of the tax for supplemental pay. Two digits precision decimal for dollar." } ] }, "adjustedGross": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The adjusted gross used to calculate the tax. Aggregations of this field need to be fed back in with the next payroll as part of the aggregatedTaxes array. Two digits precision decimal for dollar." } ] }, "adjustedSupplementalGross": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The adjusted supplemental gross used to calculate the tax. Two digits precision decimal for dollar." } ] }, "alternativeCalculationCode": { "type": "integer", "description": "Specifies an alternate calculation code to use. The /alternative-calculations query returns a list of valid alternate calculation codes. The alternate calculation code enables you to tailor a specific calculation to a specific state. Note - the meaning of this parameter depends on the tax being computed. For example, for Arizona State Withholding Tax, the employee can elect a rate to use via this code. Refer to the Vertex Payroll Tax Calculation Guide for the US or the Vertex Payroll Tax Calculation Guide for Canada for details about how to use these codes for particular taxes." }, "annualizedAdjustedCurrentGross": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The annualized adjusted current gross. Two digits precision decimal for dollar." } ] }, "annualizedAdjustedSupplementalGross": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The annualized adjusted current supplemental gross. Two digits precision decimal for dollar." } ] }, "annualizedRegularTax": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The annualized tax for regular income. Two digits precision decimal for dollar." } ] }, "annualizedSupplementalTax": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The annualized tax for supplemental income. Two digits precision decimal for dollar." } ] }, "subjectGrossAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The subject gross amount, or the accumulated gross associated with Regular Pay that is subject to tax. Subject gross is reportable but might not have tax withheld for it. Subject Gross (from the Federal Withholding tax results) is what is aggregated and reported on the employee’s W2 form at the end of the year. Two digits precision decimal for dollar." } ] }, "subjectSupplementalGrossAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The subject gross amount, or the accumulated gross associated with Supplemental Pay that is subject to tax. Subject gross is reportable but might not have tax withheld for it. Subject Gross (from the Federal Withholding tax results) is what is aggregated and reported on the employee’s W2 form at the end of the year. Two digits precision decimal for dollar." } ] }, "taxableGross": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The taxable gross amount, or the accumulated gross associated with Regular Pay that is taxable. Taxable gross is the amount of wages for which tax was calculated. Two digits precision decimal for dollar." } ] }, "taxableTips": { "deprecated": true, "description": "This property is deprecated and will be removed in a future release.", "type": "number" }, "utilizedAlternativeCalculationCode": { "type": "integer", "description": "Specifies alternate calculation code that was actually used. The /alternative-calculations query returns a list of valid alternate calculation codes. The alternate calculation code enables you to tailor a specific calculation to a specific state. Note - the meaning of this parameter depends on the tax being computed. For example, for Arizona State Withholding Tax, the employee can elect a rate to use via this code. Refer to the Vertex Payroll Tax Calculation Guide for the US or the Vertex Payroll Tax Calculation Guide for Canada for details about how to use these codes for particular taxes." }, "utilizedBaseAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The wage base amount used in the calculation. Two digits precision decimal for dollar." } ] }, "calculationMethod": { "$ref": "#/components/schemas/calculationMethod" }, "utilizedExemptAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The exemption amount used. Two digits precision decimal for dollar." } ] }, "filingStatusId": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "The filing status that was actually used. Id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values." } ] }, "utilizedMaximumDeductionAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The maximum deduction amount used. Two digits precision decimal for dollar." } ] }, "utilizedRate": { "allOf": [ { "$ref": "#/components/schemas/percent" }, { "description": "The tax rate that was used to calculate the tax. Standard percentage format as a decimal. With 0.01 to mean 1% not .01 percent. 0.000001 (smallest granularity) represent 0.0001%." } ] }, "utilizedSupplementalRate": { "allOf": [ { "$ref": "#/components/schemas/percent" }, { "description": "The supplemental rate that was used to calculate the tax. Standard percentage format as a decimal. With 0.01 to mean 1% not .01 percent. 0.000001 (smallest granularity) represent 0.0001%." } ] }, "recalculation": { "$ref": "#/components/schemas/recalculation" }, "utilizedSchoolDistrictId": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "The school district number that was actually used." } ] }, "utilizedSupplementalPayTypeTreatment": { "allOf": [ { "$ref": "#/components/schemas/payTypeTreatment" }, { "description": "The supplemental pay type treatment that was actually used." } ] }, "utilizedJurisdictionTreatmentInteraction": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "The Jurisdictional Interaction Treatment (JIT) that is used. Id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values." } ] }, "workLocationsUsed": { "allOf": [ { "$ref": "#/components/schemas/workLocationsUsed" }, { "description": "The work locations that were used in the calculation of this tax result." } ] } }, "required": [ "taxRecordIdentifier", "taxName", "taxType", "calculationStatus", "taxAmount", "taxableGross" ] }, "compensationResult": { "type": "object", "description": "Information about the use of compensations in tax results.", "properties": { "compensationId": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "The product or user-defined compensation id. Id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values." } ] }, "taxRecordIdentifier": { "$ref": "#/components/schemas/taxRecordIdentifier" }, "utilizedCompensationId": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "The compensation id that was actually used for calculation. Id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values." } ] }, "taxName": { "type": "string", "description": "Descriptive name for the tax." }, "taxType": { "$ref": "#/components/schemas/taxType" }, "taxingLocationType": { "$ref": "#/components/schemas/taxingLocationType" }, "taxableAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The product-determined portion of the compensation amount that falls within a limit that the taxing jurisdiction set. (For some non-cash compensation, there is a limit to how much is allowed in a given period, and the excess is treated as cash). This value is what is aggregated and fed back in with the aggregatedCompensations array on later payroll runs. Negative value returned - if the returned amount allowed value is -1, the supplied compensation id was invalid because it was not associated with a defined compensation and/or not in the user-defined compensation range. The invalid compensation is ignored in the tax calculation. If a compensation is not calculated, check for a negative value and adjust the compensation as needed. Two digits precision decimal for dollar." } ] }, "exemptAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The compensation amount exempt from tax. Two digits precision decimal for dollar." } ] }, "payType": { "$ref": "#/components/schemas/payType" }, "compensationDescription": { "type": "string", "description": "Description of the compensation." }, "errorIndicator": { "type": "boolean", "description": "Present if an error is encountered." }, "errorDescription": { "type": "string", "description": "Description of the error; is only present if errorIndicator is true." }, "workLocationsUsed": { "allOf": [ { "$ref": "#/components/schemas/workLocationsUsed" }, { "description": "The work locations that were used in the calculation of this compensation result." } ] } }, "required": [ "taxRecordIdentifier", "taxName", "taxType", "compensationId", "utilizedCompensationId", "payType" ] }, "deductionResult": { "type": "object", "properties": { "taxRecordIdentifier": { "$ref": "#/components/schemas/taxRecordIdentifier" }, "taxName": { "type": "string", "description": "Descriptive name for the tax." }, "deductionId": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "The deduction id of this result. Id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values." } ] }, "taxType": { "$ref": "#/components/schemas/taxType" }, "deductionAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The deduction amount. Two digits precision decimal for dollar." } ] }, "deductionPercent": { "allOf": [ { "$ref": "#/components/schemas/percent" }, { "description": "The deduction percent (percentage of gross). Standard percentage format as a decimal. With 0.01 to mean 1% not .01 percent. 0.000001 (smallest granularity) represent 0.0001%." } ] }, "actualAmount": { "type": "number", "description": "The Actual Deduction Amount set by the payroll calculation. This is only relevant when the value type in the request was set to indicate that a percentage of gross was to be deducted. In that case, look at the actual amount to see the dollar amount." }, "amountAllowed": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The amount of the deduction allowed. Some deductions are allowed only up to some limit. This is always a dollar value. Two digits precision decimal for dollar." } ] }, "utilizedDeductionValue": { "type": "string", "enum": [ "DeductionAmount", "PercentageOfGross" ], "description": "An enum indicating whether the deduction was passed as an amount or percent." }, "deductionDescription": { "type": "string", "description": "Description of the deduction." }, "workLocationsUsed": { "allOf": [ { "$ref": "#/components/schemas/workLocationsUsed" }, { "description": "The work locations that were used in the calculation of this deduction result." } ] } }, "required": [ "taxRecordIdentifier", "deductionId", "utilizedDeductionValue" ] }, "formResult": { "type": "object", "description": "Information about the use of form data in the calculation.", "properties": { "taxRecordIdentifier": { "$ref": "#/components/schemas/taxRecordIdentifier" }, "taxName": { "type": "string", "description": "Descriptive name for the tax." }, "taxType": { "$ref": "#/components/schemas/taxType" }, "formFieldIdentifier": { "type": "string", "description": "Name of the form." }, "formFieldValue": { "type": "string", "description": "Contains the value associated with the form name. This is the value that was supplied during input." }, "utilizedFormValue": { "type": "string", "description": "Contains the value that was actually used. This is usually the same as formFieldValue except when either the supplied value was invalid (and a default was substituted), or for certain output-only fields of certain forms. In the latter case, formFieldValue is omitted in request." }, "formExists": { "type": "boolean", "description": "True if the form exists." }, "formStatus": { "type": "string", "description": "Result status of the form operation.\n\n|Value |Description |tVprtFormStatus mapping|\n|:-----------------------|:------------------------------------|---------------:|\n|OK |The form was successfully processed. |eVprtFormStatusOK |\n|BadName |Invalid form field identifier name. |eVprtFormStatusBadName |\n|InvalidFieldIdentifier |This enum name is incorrect and will be fixed in a later release. This indicates an invalid form field value. |eVprtFormStatusValueContents |\n|FormNotUsed |Form not used. This is not necessarily an error. It means that the form was not used by this particular jurisdiction. |eVprtFormStatusNotUsed |\n|MiscError |Miscellaneous error. |eVprtFormStatusMiscError |\n", "enum": [ "OK", "BadName", "InvalidFieldIdentifier", "FormNotUsed", "MiscError" ] }, "formDescription": { "type": "string", "description": "Description of the form." }, "workLocationsUsed": { "allOf": [ { "$ref": "#/components/schemas/workLocationsUsed" }, { "description": "The work locations that were used in the calculation of this form result." } ] } }, "required": [ "taxRecordIdentifier", "taxType", "formFieldIdentifier" ] }, "calculationOverride": { "type": "object", "description": "Options to override various values in computing taxes", "properties": { "taxRecordIdentifier": { "$ref": "#/components/schemas/taxRecordIdentifier" }, "taxingLocationType": { "$ref": "#/components/schemas/taxingLocationType" }, "overrideAdditionalRate": { "allOf": [ { "$ref": "#/components/schemas/percent" }, { "description": "Override Additional Rate. Standard percentage format as a decimal. With 0.01 to mean 1% not .01 percent. 0.000001 (smallest granularity) represent 0.0001%." } ] }, "overrideAdditionalExemption": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Override Additional Exemption. Two digits precision decimal for dollar." } ] }, "overrideWageBase": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Override Wage Base. Two digits precision decimal for dollar." } ] }, "overrideExemptAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Override Exemption Amount. Two digits precision decimal for dollar." } ] }, "overrideMaximumDeduction": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Override Maximum Deduction. Two digits precision decimal for dollar." } ] }, "overrideRate": { "allOf": [ { "$ref": "#/components/schemas/percent" }, { "description": "Override Tax Rate. Standard percentage format as a decimal. With 0.01 to mean 1% not .01 percent. 0.000001 (smallest granularity) represent 0.0001%." } ] }, "additionalTaxAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Additional Tax Amount. Two digits precision decimal for dollar. Note - Override Tax Amount and Additional Tax Amount are mutually exclusive." } ] }, "overrideTaxAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Override Tax Amount. Two digits precision decimal for dollar. Note - Override Tax Amount and Additional Tax Amount are mutually exclusive." } ] }, "supplementalPayAdditionalExemptions": { "type": "number", "description": "Override Additional Exemptions (Supplemental Pay). Two digits precision decimal for dollar." }, "supplementalPayAdditionalRate": { "allOf": [ { "$ref": "#/components/schemas/percent" }, { "description": "Override Additional Rate (Supplemental Pay). Standard percentage format as a decimal. With 0.01 to mean 1% not .01 percent. 0.000001 (smallest granularity) represent 0.0001%." } ] }, "supplementalPayOverrideRate": { "allOf": [ { "$ref": "#/components/schemas/percent" }, { "description": "Override rate (Supplemental Pay). Standard percentage format as a decimal. With 0.01 to mean 1% not .01 percent. 0.000001 (smallest granularity) represent 0.0001%." } ] }, "supplementalPayAdditionalTaxAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Additional Tax Amount (Supplemental Pay). Two digits precision decimal for dollar." } ] }, "supplementalPayOverideTaxAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Override Tax Amount (Supplemental Pay). Two digits precision decimal for dollar." } ] }, "supplementalPayOverrideExemptAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Override Exemption Amount (Supplemental Pay). Two digits precision decimal for dollar." } ] } }, "required": [ "taxRecordIdentifier" ] }, "workLocationsUsed": { "type": "object", "description": "The work locations that were used in calculating a result.", "properties": { "workLocations": { "type": "array", "description": "The work locations that were used in calculating a result.", "items": { "$ref": "#/components/schemas/workLocationUsed" } } } }, "workLocationUsed": { "type": "object", "description": "Information regarding the work location used.", "properties": { "workLocationId": { "type": "string", "description": "Client-defined identifier for a work location. Serves as an identifier for this particular employee's work location." } }, "required": [ "workLocationId" ] }, "workLocation": { "type": "object", "description": "Information regarding work locations, including compensations.", "properties": { "workLocationId": { "type": "string", "description": "Client-defined identifier for a work location. Serves as an identifier for this particular employee's work location." }, "geocodeId": { "allOf": [ { "$ref": "#/components/schemas/geocodeId" }, { "description": "The geocode of this work location." } ] }, "schoolDistrictId": { "allOf": [ { "$ref": "#/components/schemas/schoolDistrictId" }, { "description": "The school district of this work location." } ] }, "currentHours": { "type": "number", "description": "Number of hours worked in the current pay period." }, "monthToDateHours": { "type": "number", "description": "Month-to-date aggregate number of hours worked at this location." }, "yearToDateHours": { "type": "number", "description": "Year-to-date aggregate number of hours worked at this location." }, "compensations": { "type": "array", "items": { "$ref": "#/components/schemas/compensation" }, "minItems": 1, "maxItems": 50, "default": [] } }, "required": [ "geocodeId", "compensations" ] }, "deduction": { "type": "object", "properties": { "deductionTypeId": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "Deduction id. This code identifies what kind of deduction is being specified. The /deduction-identifiers api returns valid deduction id codes. Additionally, there is a range of id codes reserved for user-defined deductions. This range is 1000 through 1999. Note - id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values." } ] }, "deductionAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Use either deductionAmount for a currency value, or deductionPercent for percentage of gross. (Pass either deductionAmount or deductionPercent. Cannot pass both.) Two digits precision decimal for dollar." } ] }, "deductionPercent": { "allOf": [ { "$ref": "#/components/schemas/percent" }, { "description": "Use either deductionAmount for a currency value, or deductionPercent for percentage of gross. (Pass either deductionAmount or deductionPercent. Cannot pass both.) Standard percentage format as a decimal. With 0.01 to mean 1% not .01 percent. 0.000001 (smallest granularity) represent 0.0001%." } ] }, "yearToDateAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The dollar amount of how much of this deduction has been taken before this pay period in the current year. Two digits precision decimal for dollar." } ] }, "cashTakenByEmployee": { "type": "boolean", "description": "The Cash Option parameter represents the employee's option to choose cash instead of an employer's benefit. If the employee selects the cash option, the dollar value of that benefit is not deducted from an employee's current gross and is taxable." }, "taxabilityOverride": { "$ref": "#/components/schemas/taxabilityOverride" }, "maximumDeductionAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Currency amount to apply, overriding the maximum permitted deduction. Two digits precision decimal for dollar." } ] } }, "required": [ "deductionTypeId" ] }, "aggregatedCompensation": { "type": "object", "properties": { "taxRecordIdentifier": { "$ref": "#/components/schemas/taxRecordIdentifier" }, "taxingLocationType": { "$ref": "#/components/schemas/taxingLocationType" }, "compensationId": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "Compensation id. This identifies what kind of compensation this is (for example, cash, bonus, stock options, educational assistance, etc). The /compensation-identifiers query returns a list of valid compensation ids. Note - for user-defined compensations the compensation id must be valued between 1000-1999. Id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values." } ] }, "payType": { "allOf": [ { "$ref": "#/components/schemas/payType" }, { "description": "Pay type - Regular or Supplemental. Regular pay is what the employee is paid on a regular basis. Examples of supplemental pay include bonuses, taxable fringe benefits, and so forth. If omitted, regular is used." } ] }, "amount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The dollar amount of the aggregated compensation. If specified, this must be greater than or equal to zero. If this is omitted and aggregationType is Current, then the entry can be used to override the compensation type for a location for a particular Tax id, without changing the amount that was specified in the compensation object in the workLocations array. Two digits precision decimal for dollar." } ] }, "aggregationType": { "allOf": [ { "$ref": "#/components/schemas/aggregationType" }, { "description": "The aggregation type (for example, month-to-date, year-to-date)." } ] }, "aggregateHours": { "type": "number", "description": "Aggregate number of hours worked." }, "overrideCompensationType": { "allOf": [ { "$ref": "#/components/schemas/compensationType" }, { "description": "This is used to override the consideration of whether the compensation is considered taxable. Note - this field must be specified if the compensation id is in the user-defined range." } ] } }, "required": [ "taxRecordIdentifier", "compensationId", "amount", "aggregationType" ] }, "aggregatedTax": { "description": "Aggregated taxes paid in prior pay periods.", "properties": { "taxRecordIdentifier": { "$ref": "#/components/schemas/taxRecordIdentifier" }, "payType": { "$ref": "#/components/schemas/payType" }, "taxingLocationType": { "$ref": "#/components/schemas/taxingLocationType" }, "taxAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The dollar amount of the aggregate tax. Two digits precision decimal for dollar." } ] }, "aggregateAdjustedGross": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Aggregate Adjusted Gross. Two digits precision decimal for dollar." } ] }, "aggregationType": { "allOf": [ { "$ref": "#/components/schemas/aggregationType" }, { "description": "The aggregation type (for example, month-to-date, year-to-date)." } ] }, "aggregateHours": { "type": "number", "description": "Aggregate number of hours worked. You must specify this only if you want to override the work location value for a particular tax id." }, "aggregateExemptAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Aggregate Exemption Amount (used for Canadian taxes only). Two digits precision decimal for dollar." } ] } }, "required": [ "taxRecordIdentifier", "aggregationType" ] }, "compensation": { "type": "object", "description": "Compensation", "properties": { "compensationCodeId": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "Compensation id. This identifies what kind of compensation this is (for example, cash, bonus, stock options, educational assistance, etc). The /compensation-identifiers query returns a list of valid compensation ids. Note - for user-defined compensations the compensation id must be valued between 1000-1999. Id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values." } ] }, "payType": { "allOf": [ { "$ref": "#/components/schemas/payType" }, { "description": "Pay type - Regular or Supplemental. Regular pay is what the employee is paid on a regular basis. Examples of supplemental pay include bonuses, taxable fringe benefits, and so forth. If omitted, regular is used." } ] }, "amount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The dollar amount of the compensation. Note - negative compensation amounts are not supported. Two digits precision decimal for dollar." } ] }, "overrideCompensationType": { "allOf": [ { "$ref": "#/components/schemas/compensationType" }, { "description": "Override compensation type. This is used to override the consideration of whether the compensation is considered taxable. Note - this field must be specified if the compensation id is in the user-defined range." } ] } }, "required": [ "compensationCodeId", "amount" ] }, "jurisdiction": { "type": "object", "description": "Jurisdiction-specific taxing options.", "properties": { "taxRecordIdentifier": { "$ref": "#/components/schemas/taxRecordIdentifier" }, "filingStatus": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "Specifies the code number for the filing status to be used. (Id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values.)" } ] }, "primaryExemptions": { "type": "integer", "description": "The number of primary exemptions." }, "primaryExemptionAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The amount of the primary exemptions. Two digits precision decimal for dollar." } ] }, "secondaryExemptions": { "type": "integer", "description": "The number of secondary exemptions." }, "secondaryExemptionAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The amount of the secondary exemptions. Two digits precision decimal for dollar." } ] }, "calculationMethod": { "allOf": [ { "$ref": "#/components/schemas/calculationMethod" }, { "description": "Use the /calculation-methods query to return the set of calculation method codes that are valid for a particular jurisdiction, and the supplemental methods that are compatible with it. If an invalid code is supplied, then the default for that jurisdiction is used. Refer to the Vertex Payroll Tax Calculation Guide for US or the Vertex Payroll Tax Calculation Guide for Canada for details about the various calculation methods." } ] }, "alternativeCalculationCode": { "type": "integer", "description": "Specifies an alternate calculation code to use. The /alternative-calculations query returns a list of valid alternate calculation codes. The alternate calculation code enables you to tailor a specific calculation to a specific state. Note - the meaning of this parameter depends on the tax being computed. For example, for Arizona State Withholding Tax, the employee can elect a rate to use via this code. Refer to the Vertex Payroll Tax Calculation Guide for US or the Vertex Payroll Tax Calculation Guide for Canada for details about how to use these codes for particular taxes." }, "recalculate": { "$ref": "#/components/schemas/recalculation" }, "jurisdictionInteractionTreatmentId": { "$ref": "#/components/schemas/jitType" }, "nonResident": { "type": "boolean", "description": "Non-residence certificate. This parameter controls certain reciprocity treatments for work taxes." }, "ignoreParentJurisdictionDefaults": { "type": "boolean", "description": "Normally, if a county-level or local-level jurisdiction is not specified, the state-level jurisdiction defaults are used. If true, do not use this jurisdiction to provide defaults for any lower-level jurisdictions." }, "taxExempt": { "type": "boolean", "description": "If set to true, then the employee is exempt from the specified tax. If set to false or not specified, then the employee is not exempt." }, "nonResidentAlienTreatment": { "type": "boolean", "description": "If set to true, then non-resident alien processing occurs. If set to false or not specified, then this processing does not occur." }, "taxingLocationType": { "$ref": "#/components/schemas/taxingLocationType" }, "supplementalPayTypeTreatment": { "$ref": "#/components/schemas/payTypeTreatment" }, "experienceRate": { "minimum": 0, "allOf": [ { "$ref": "#/components/schemas/percent" }, { "description": "The employer tax rate to use (mainly for specifying FUTA, SUI, and SDI rates, which vary based on employer history). Standard percentage format as a decimal. With 0.01 to mean 1% not .01 percent. 0.000001 (smallest granularity) represent 0.0001%." } ] }, "specialPayPeriod": { "allOf": [ { "$ref": "#/components/schemas/specialPayPeriod" }, { "description": "Indicator as to whether this is a special pay period (last pay of month, last pay of year, etc). Certain taxes are only calculated on special pay periods. This will override the special pay period in the employee object." } ] } }, "required": [ "taxRecordIdentifier" ] }, "canadianDetail": { "type": "object", "description": "Maximum of two occurrences, one for Canadian federal (signified by having the Canadian federal geocode) and the other for provincial taxes (signified by having the relevant provincial geocode).", "properties": { "geocodeId": { "allOf": [ { "$ref": "#/components/schemas/geocodeId" }, { "description": "The tax geocode - the taxing Jurisdiction to which the following data items apply. For example, if this only applies to the Canadian federal level, then the part of the GeoCode specifying which Province would be zeros." } ] }, "workGeocodeId": { "allOf": [ { "$ref": "#/components/schemas/geocodeId" }, { "description": "The geocode of this work location." } ] }, "annualDeductionAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Annual deductions such as child care expenses, alimony payments, and maintenance payments not deducted at source. The employer is informed by the Tax Services Office of the amount. This amount is referred to as F1 in the formula for computer programs. Two digits precision decimal for dollar." } ] }, "claimAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Total Personal Tax credits indicated on form TD1(E). This amount is referred to as TC in the formula for computer programs. Two digits precision decimal for dollar." } ] }, "employeeDateOfBirth": { "allOf": [ { "$ref": "#/components/schemas/date" }, { "description": "Employee's date of birth in YYYY-MM-DD date format. For example, September 27, 2012 is represented as 2012-09-27." } ] }, "married": { "type": "boolean", "description": "Indicates that the employee is married or the equivalent. (true or false)" }, "disabled": { "type": "boolean", "description": "Indicates that the employee is disabled. (true or false)" }, "nonResident": { "type": "boolean", "description": "Indicates that the employee is a non-resident of Canada. (true or false)" }, "numberOfDependents": { "type": "integer", "description": "Number of dependents under 18." }, "otherTaxCredits": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Other federal tax credits such as medical expenses and charitable donations. The employer is informed by a Tax Services Office of the amount. This amount is referred to as K3 in the formula for computer programs. Two digits precision decimal for dollar." } ] }, "claimCode": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "Claim Code indicated on form TD1(E). Id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values." } ] }, "designatedAreaDeduction": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Deduction indicated on form TD1(E) for living in a designated area. This is referred to as HD in the formula for computer programs. Two digits precision decimal for dollar." } ] }, "daysSinceLastPay": { "type": "integer", "description": "Number of days since last commission or draw paid." }, "disabledDependentsOver18": { "type": "integer", "description": "Number of disabled dependents over 18." }, "over65": { "type": "boolean", "description": "Indicates that the employee is over 65 years of age. (true or false)" }, "pensionCompensation": { "type": "boolean", "description": "Indicates that the compensation amount or amounts passed are pension income. (true or false)" }, "pensionablePayPeriods": { "type": "integer", "description": "Pensionable pay periods." }, "stockPurchaseAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Purchase amount of approved shares of the capital stock of prescribed labor-sponsored venture capital corporations for the year. This amount is used to calculate labor-sponsored funds tax credits (Lcf and Lcp). Two digits precision decimal for dollar." } ] }, "totalExpenseAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "For employees remunerated by commission. Total expenses (or revised expenses) are indicated on form TD1X. This amount is referred to as E in the formula for computer programs. Two digits precision decimal for dollar." } ] }, "totalRenumerationAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "For employees remunerated by commission. Total remuneration is indicated on form TD1X. This amount is referred to as I1 in the formula for computer programs. Two digits precision decimal for dollar." } ] } }, "required": [ "geocodeId", "workGeocodeId" ] }, "compensationOverride": { "type": "object", "description": "Quantum compensation override", "properties": { "taxRecordIdentifier": { "$ref": "#/components/schemas/taxRecordIdentifier" }, "taxingLocationType": { "$ref": "#/components/schemas/taxingLocationType" }, "payType": { "$ref": "#/components/schemas/payType" }, "compensationCodeId": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "Compensation id. This identifies what kind of compensation this is (for example, cash, bonus, stock options, educational assistance, etc). The /compensation-identifiers query returns a list of valid compensation ids. Note - for user-defined compensations the compensation id must be valued between 1000-1999. Id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values." } ] }, "aggregationType": { "allOf": [ { "$ref": "#/components/schemas/aggregationType" }, { "description": "The aggregation type (for example, month-to-date, year-to-date, and so on). The default is Current." } ] }, "compensationAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The dollar amount of the compensation. Two digits precision decimal for dollar." } ] }, "overrideCompensationType": { "$ref": "#/components/schemas/compensationType" } }, "required": [ "taxRecordIdentifier", "compensationId", "taxingLocationType", "payType" ] }, "deductionOverride": { "type": "object", "description": "Quantum deduction override", "properties": { "taxRecordIdentifier": { "$ref": "#/components/schemas/taxRecordIdentifier" }, "taxingLocationType": { "$ref": "#/components/schemas/taxingLocationType" }, "deductionTypeId": { "allOf": [ { "$ref": "#/components/schemas/idType" }, { "description": "Deduction Id. This code identifies what kind of deduction is being specified. The /deduction-identifiers returns valid deduction id codes. Additionally, there is a range of id codes reserved for user-defined deductions. This range is 1000 through 1999. Note - id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values." } ] }, "deductionAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Use either deductionAmount for a currency value, or deductionPercent for percentage of gross. (Pass either deductionAmount or deductionPercent. Cannot pass both.) Two digits precision decimal for dollar." } ] }, "deductionPercent": { "allOf": [ { "$ref": "#/components/schemas/percent" }, { "description": "Use either deductionAmount for a currency value, or deductionPercent for percentage of gross. (Pass either deductionAmount or deductionPercent. Cannot pass both.) Standard percentage format as a decimal. With 0.01 to mean 1% not .01 percent. 0.000001 (smallest granularity) represent 0.0001%." } ] }, "yearToDateDeductionAmount": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "The dollar amount of how much of this deduction has been taken before this pay period in the current year. Two digits precision decimal for dollar." } ] }, "cashOption": { "type": "boolean", "description": "Cash option - true = cash may be taken by employee; false = cash may not be taken by employee." }, "taxabilityOverride": { "$ref": "#/components/schemas/taxabilityOverride" }, "maximumDeductionOverride": { "allOf": [ { "$ref": "#/components/schemas/currency" }, { "description": "Currency amount to apply, overriding the maximum permitted deduction. (Pass either deductionAmount or deductionPercent. Cannot pass both.) Two digits precision decimal for dollar." } ] } }, "required": [ "taxRecordIdentifier", "deductionId", "taxingLocationType" ] }, "taxRecordIdentifier": { "type": "object", "description": "Combination of IDs that define a tax record.", "properties": { "taxIdentifierId": { "allOf": [ { "$ref": "#/components/schemas/taxIdentifierId" }, { "description": "Applies to the tax id. Note - for the complete list, refer to /tax-identifiers query." } ] }, "geocodeId": { "allOf": [ { "$ref": "#/components/schemas/geocodeId" }, { "description": "The geocode that applies to the jurisdiction. A value of 000000000 defaults to federal taxes. For state taxes, supply a geocode id with the state part specified and the county and local parts zeroed (that is, 390000000 for Pennsylvania)." } ] }, "schoolDistrictId": { "allOf": [ { "$ref": "#/components/schemas/schoolDistrictId" }, { "description": "Specifies the school district (relevant only for certain taxes)." } ] } }, "required": [ "taxIdentifierId", "geocodeId" ] }, "versionInfo": { "type": "object", "description": "version information", "properties": { "version": { "type": "string", "description": "version" }, "legacyVersion": { "type": "string", "description": "legacyVersion" }, "dataVersion": { "type": "string", "description": "dataVersion" }, "minimumWageDataVersion": { "type": "string", "description": "Minimum wage data version. This is only sent back on the minimum-wages endpoint." }, "transDateTime": { "type": "string", "description": "transDateTime" } }, "required": [ "version", "legacyVersion", "dataVersion", "transDateTime" ] }, "taxingLocationType": { "description": "Used to indicate whether only residential taxes, only work taxes, or both should be considered.", "type": "string", "enum": [ "Residential", "Work", "Both" ] }, "payType": { "description": "Whether this applies to Regular or Supplemental pay.", "type": "string", "enum": [ "Regular", "Supplemental" ] }, "payTypeTreatment": { "description": "Pay type that applies, including both, where both regular and supplemental apply.", "type": "string", "enum": [ "Both", "Regular", "Supplemental" ] }, "taxabilityOverride": { "type": "string", "description": "Whether the deduction should be treated as fully taxable or fully exempt. This property supersedes a value for maximumDeductionAmount.", "enum": [ "Taxable", "Exempt" ] }, "specialPayPeriod": { "description": "Indicates whether this is a special pay period (last pay of the month, last pay of the year, and so forth). Certain taxes are calculated only on special pay periods.", "type": "string", "enum": [ "NotSpecial", "LastMonth", "LastQuarter", "LastSemiAnnual", "LastYear" ] }, "aggregationType": { "description": "Aggregation period.", "type": "string", "enum": [ "Current", "PeriodToDate", "MonthToDate", "QuarterToDate", "SemiAnnualToDate", "YearToDate", "Previous", "PreviousMonthToDate", "PreviousQuarterToDate", "PreviousYearToDate", "PriorState" ] }, "compensationType": { "description": "Enumeration of the permitted combinations of the factors\n* Cash or Non-Cash\n* Subject or Not Subject\n* Taxable or Not Taxable\n\n| Value | Cash | Subject | Taxable | Mapping to xxx |\n|-------------------- |:-------: |:----------: |:----------: |---------------- |\n|CashSubjectTaxable | X | X | X |eVprtCompTypeCST |\n|NonCashNotSubjectNotTaxable | | | |eVprtCompTypeNCNSNT |\n|NonCashSubjectNotTaxable | | X | |eVprtCompTypeNCSNT |\n|NonCashSubjectTaxable | | X | X |eVprtCompTypeNCST |\n|CashNotSubjectNotTaxable | X | | |eVprtCompTypeCNSNT |\n|CashSubjectNotTaxable | X | X | |eVprtCompTypeCSNT|\n", "type": "string", "enum": [ "CashSubjectTaxable", "NonCashNotSubjectNotTaxable", "NonCashSubjectNotTaxable", "NonCashSubjectTaxable", "CashNotSubjectNotTaxable", "CashSubjectNotTaxable" ] }, "recalculation": { "description": "The recalculation option. The recalculation option is a parameter that is available for the calculation of a tax that uses another tax in the calculation formula. Several state and local taxes use the Federal Withholding Tax or the State Withholding Tax in their calculations. This parameter enables you to use the federal or state tax amount that was previously calculated instead of recalculating these tax amounts. The default value for this parameter is to not recalculate these amounts.\n\n|Value|Description|\n|:---------|:----------------------:|\n|No |Do not recalculate |\n|Yes |Recalculate |\n|MedicareOnly |Only recalculate Medicare tax |\n", "enum": [ "No", "Yes", "MedicareOnly" ] }, "calculationStatus": { "type": "string", "description": "Calculation Status enumeration.\n\n|Value|Description|tVprtCalcStat mapping|\n|:-----------------------|:------------------------------------|---------------:|\n|OK |Calculation OK |eVprtCalcStatOK|\n|MaxTaxReached |Maximum tax amount reached |eVprtCalcStatReachedMax|\n|YTDGross |YTD gross amount is over maximum |eVprtCalcStatOvMax|\n|UserBypassed |User bypassed tax calculation |eVprtCalcStatByPassed|\n|GrossNotTaxable |Gross amount not taxable |eVprtCalcStatGrsNotTxbl|\n|TaxNotExist |Tax does not exist |eVprtCalcStatTaxNotExist|\n|NoGross |No gross amount was passed |eVprtCalcStatNoGrs|\n|NegativeAdjustedGross |The adjusted gross was negative |eVprtCalcStatNegAdjGrs|\n|NegativeTax |Negative tax amount was returned |eVprtCalcStatNegTaxRet|\n|NegativeTaxZero |Negative tax calculated 0.00 returned|eVprtCalcStatNegTax0Ret|\n|NoTaxReciprocation |Tax eliminated due to reciprocation |eVprtCalcStatNoTaxRecip|\n|WithheldWorkTaxReduction |Tax reduced by work tax withheld |eVprtCalcStatWrkWithheld|\n|WithheldResidentTaxReduction |Tax reduced by resident tax withheld |eVprtCalcStatResWithheld|\n|TaxRecordNotFound |Tax record not found |eVprtCalcStatRecNotFound|\n|InvalidPayDate |Invalid Pay Date was passed |eVprtCalcStatInvPayDate|\n|InvalidPayPeriods |Invalid number of pay periods |eVprtCalcStatInvPayPrds|\n|DataError |An unexpected Data error |eVprtCalcStatDataErr|\n|InvalidEmployeeInfo |Invalid Employee Info was passed |eVprtCalcStatInvEmpHdl|\n|InvalidTaxId |Invalid Tax ID |eVprtCalcStatInvTaxID|\n|InvalidOverrideVacation |Invalid Override Vacation Factor |eVprtCalcStatInvOvVacFactor|\n|InvalidGeocodeId |Invalid GeoCode |eVprtCalcStatInvGeoCode|\n|IncompatibleSupplementalMethod |SupMethUsed Incompatible w/ PayTypeAlwd |eVprtCalcStatPayTypeNotAlwd|\n|RateDataError | An unexpected Rate data error |eVprtCalcStatRateDataErr|\n|InvalidTaxType |Invalid Tax Type |eVprtCalcStatInvTaxType|\n", "enum": [ "OK", "MaxTaxReached", "YTDGross", "UserBypassed", "GrossNotTaxable", "TaxNotExist", "NoGross", "NegativeAdjustedGross", "NegativeTax", "NegativeTaxZero", "NoTaxReciprocation", "WithheldWorkTaxReduction", "WithheldResidentTaxReduction", "TaxRecordNotFound", "InvalidPayDate", "InvalidPayPeriods", "DataError", "InvalidEmployeeInfo", "InvalidTaxId", "InvalidOverrideVacation", "InvalidGeocodeId", "IncompatibleSupplementalMethod", "RateDataError", "InvalidTaxType" ] }, "taxType": { "description": "The enumerated types used to indicate valid tax types. The enumerated value ResidentTax is for resident tax, FederalTax is for federal tax and values WorkTax1 through WorkTax300 are for work taxes for different work locations.", "type": "string", "enum": [ "ResidentTax", "FederalTax", "WorkTax1", "WorkTax2", "WorkTax3", "WorkTax4", "WorkTax5", "WorkTax6", "WorkTax7", "WorkTax8", "WorkTax9", "WorkTax10", "WorkTax11", "WorkTax12", "WorkTax13", "WorkTax14", "WorkTax15", "WorkTax16", "WorkTax17", "WorkTax18", "WorkTax19", "WorkTax20", "WorkTax21", "WorkTax22", "WorkTax23", "WorkTax24", "WorkTax25", "WorkTax26", "WorkTax27", "WorkTax28", "WorkTax29", "WorkTax30", "WorkTax31", "WorkTax32", "WorkTax33", "WorkTax34", "WorkTax35", "WorkTax36", "WorkTax37", "WorkTax38", "WorkTax39", "WorkTax40", "WorkTax41", "WorkTax42", "WorkTax43", "WorkTax44", "WorkTax45", "WorkTax46", "WorkTax47", "WorkTax48", "WorkTax49", "WorkTax50", "WorkTax51", "WorkTax52", "WorkTax53", "WorkTax54", "WorkTax55", "WorkTax56", "WorkTax57", "WorkTax58", "WorkTax59", "WorkTax60", "WorkTax61", "WorkTax62", "WorkTax63", "WorkTax64", "WorkTax65", "WorkTax66", "WorkTax67", "WorkTax68", "WorkTax69", "WorkTax70", "WorkTax71", "WorkTax72", "WorkTax73", "WorkTax74", "WorkTax75", "WorkTax76", "WorkTax77", "WorkTax78", "WorkTax79", "WorkTax80", "WorkTax81", "WorkTax82", "WorkTax83", "WorkTax84", "WorkTax85", "WorkTax86", "WorkTax87", "WorkTax88", "WorkTax89", "WorkTax90", "WorkTax91", "WorkTax92", "WorkTax93", "WorkTax94", "WorkTax95", "WorkTax96", "WorkTax97", "WorkTax98", "WorkTax99", "WorkTax100", "WorkTax101", "WorkTax102", "WorkTax103", "WorkTax104", "WorkTax105", "WorkTax106", "WorkTax107", "WorkTax108", "WorkTax109", "WorkTax110", "WorkTax111", "WorkTax112", "WorkTax113", "WorkTax114", "WorkTax115", "WorkTax116", "WorkTax117", "WorkTax118", "WorkTax119", "WorkTax120", "WorkTax121", "WorkTax122", "WorkTax123", "WorkTax124", "WorkTax125", "WorkTax126", "WorkTax127", "WorkTax128", "WorkTax129", "WorkTax130", "WorkTax131", "WorkTax132", "WorkTax133", "WorkTax134", "WorkTax135", "WorkTax136", "WorkTax137", "WorkTax138", "WorkTax139", "WorkTax140", "WorkTax141", "WorkTax142", "WorkTax143", "WorkTax144", "WorkTax145", "WorkTax146", "WorkTax147", "WorkTax148", "WorkTax149", "WorkTax150", "WorkTax151", "WorkTax152", "WorkTax153", "WorkTax154", "WorkTax155", "WorkTax156", "WorkTax157", "WorkTax158", "WorkTax159", "WorkTax160", "WorkTax161", "WorkTax162", "WorkTax163", "WorkTax164", "WorkTax165", "WorkTax166", "WorkTax167", "WorkTax168", "WorkTax169", "WorkTax170", "WorkTax171", "WorkTax172", "WorkTax173", "WorkTax174", "WorkTax175", "WorkTax176", "WorkTax177", "WorkTax178", "WorkTax179", "WorkTax180", "WorkTax181", "WorkTax182", "WorkTax183", "WorkTax184", "WorkTax185", "WorkTax186", "WorkTax187", "WorkTax188", "WorkTax189", "WorkTax190", "WorkTax191", "WorkTax192", "WorkTax193", "WorkTax194", "WorkTax195", "WorkTax196", "WorkTax197", "WorkTax198", "WorkTax199", "WorkTax200", "WorkTax201", "WorkTax202", "WorkTax203", "WorkTax204", "WorkTax205", "WorkTax206", "WorkTax207", "WorkTax208", "WorkTax209", "WorkTax210", "WorkTax211", "WorkTax212", "WorkTax213", "WorkTax214", "WorkTax215", "WorkTax216", "WorkTax217", "WorkTax218", "WorkTax219", "WorkTax220", "WorkTax221", "WorkTax222", "WorkTax223", "WorkTax224", "WorkTax225", "WorkTax226", "WorkTax227", "WorkTax228", "WorkTax229", "WorkTax230", "WorkTax231", "WorkTax232", "WorkTax233", "WorkTax234", "WorkTax235", "WorkTax236", "WorkTax237", "WorkTax238", "WorkTax239", "WorkTax240", "WorkTax241", "WorkTax242", "WorkTax243", "WorkTax244", "WorkTax245", "WorkTax246", "WorkTax247", "WorkTax248", "WorkTax249", "WorkTax250", "WorkTax251", "WorkTax252", "WorkTax253", "WorkTax254", "WorkTax255", "WorkTax256", "WorkTax257", "WorkTax258", "WorkTax259", "WorkTax260", "WorkTax261", "WorkTax262", "WorkTax263", "WorkTax264", "WorkTax265", "WorkTax266", "WorkTax267", "WorkTax268", "WorkTax269", "WorkTax270", "WorkTax271", "WorkTax272", "WorkTax273", "WorkTax274", "WorkTax275", "WorkTax276", "WorkTax277", "WorkTax278", "WorkTax279", "WorkTax280", "WorkTax281", "WorkTax282", "WorkTax283", "WorkTax284", "WorkTax285", "WorkTax286", "WorkTax287", "WorkTax288", "WorkTax289", "WorkTax290", "WorkTax291", "WorkTax292", "WorkTax293", "WorkTax294", "WorkTax295", "WorkTax296", "WorkTax297", "WorkTax298", "WorkTax299", "WorkTax300" ] }, "calculationMethod": { "description": "Enumeration of calculation methods.\n\n|Value |Description |tVprtCalcMeth mapping|\n|:-----------------------|:------------------------------------|---------------:|\n|Annualize |Annualize |eVprtCalcMethAnn |\n|Cumulative |Cumulative |eVprtCalcMethCum |\n|FlatRate |Flat Rate |eVprtCalcMethFlatRate |\n|FlatRateCombined |Flat Rate Combined |eVprtCalcMethFlatRateComb |\n|FlatAmount |FlatAmount |eVprtCalcMethFlatAmt |\n|ConcurrentAggregation |Concurrent Aggregation |eVprtCalcMethConAgg |\n|AnnualizedConcurrentAggregation |Annualized Concurrent Aggregation |eVprtCalcMethAnnConAgg |\n|PreviousAggregation |Previous Aggregation |eVprtCalcMethPrevAgg |\n|AnnualizedPreviousAggregation |Annualized Previous Aggregation |eVprtCalcMethAnnPrevAgg |\n|CumulativeAggregation |Cumulative Aggregation |eVprtCalcMethCumAgg |\n|PercentFederal |Percent of Federal |eVprtCalcMethPctFed |\n|PercentFederalCombined |Percent of Federal Combined |eVprtCalcMethPctFedComb |\n|SurchargePercentState |Surcharge (Percent of State) |eVprtCalcMethSur |\n|SelfAdjust |Self Adjust |eVprtCalcMethSelfAdj |\n|NoSelfAdjust |No Self Adjust |eVprtCalcMethNoSelfAdj |\n|SelfAdjustMaximum |Self Adjust at Maximum |eVprtCalcMethSelfAdjMax |\n|BypassCalculation |Bypass Tax Calculation |eVprtCalcMethByPass |\n|TieredFlat |Tiered Flat Rate |eVprtCalcMethTieredFlatRate |\n|LumpSum |Lump Sum |eVprtCalcMethLump |\n|LumpSumComposite |Lump Sum Composite |eVprtCalcMethLumComp |\n|CommissionsDrawsTDX |Commissions and Draws (TDX) |eVprtCalcMethComm |\n|SelfAdjustQuarter |SelfAdjustQuarter |eVprtCalcMethQtrSelfAdj |\n|SelfAdjustSemiAnnual |Self Adjust Semi-annual |eVprtCalcMethSemiAnnSelfAdj |\n|SelfAdjustQuarterMax |Self Adjust at Max Quarterly |eVprtCalcMethSelfAdjMaxQuarterly |\n|SelfAdjustSemiAnnualMax |Self Adjust at Max Semiann |eVprtCalcMethSelfAdjMaxSemiAnn |\n|AlternateFlatRate |Alternate Flat Rate |eVprtCalcMethAltFlatRate |\n|TieredFlatRateCombined |Tiered Flat Rate Combined |eVprtCalcMethTieredFlatRateComb |\n|ExactPercentageMethod |Exact Percentage Method |eVprtCalcMethExactPercentage |\n|NonCumulative |Non Cumulative |eVprtCalcMethNonCumulative |\n|AlternateAnnualized |Alternate Annualized |eVprtCalcMethAltAnn |\n|AlternateTieredFlatRate |Alternate Tiered Flat Rate |eVprtCalcMethAltTieredFlatRate\n", "type": "string", "enum": [ "Annualize", "Cumulative", "FlatRate", "FlatRateCombined", "FlatAmount", "ConcurrentAggregation", "AnnualizedConcurrentAggregation", "PreviousAggregation", "AnnualizedPreviousAggregation", "CumulativeAggregation", "PercentFederal", "PercentFederalCombined", "SurchargePercentState", "SelfAdjust", "NoSelfAdjust", "SelfAdjustMaximum", "BypassCalculation", "TieredFlat", "LumpSum", "LumpSumComposite", "CommissionsDrawsTDX", "SelfAdjustQuarter", "SelfAdjustSemiAnnual", "SelfAdjustQuarterMax", "SelfAdjustSemiAnnualMax", "AlternateFlatRate", "TieredFlatRateCombined", "ExactPercentageMethod", "NonCumulative", "AlternateAnnualized", "AlternateTieredFlatRate" ] }, "currency": { "description": "Two digits precision decimal for dollar.", "type": "number", "multipleOf": 0.01 }, "date": { "description": "Date in format YYYY-MM-DD. For example, September 27, 2012 is represented as 2012-09-27.", "type": "string", "format": "date" }, "percent": { "description": "Standard percentage format as a decimal. With 0.01 to mean 1% not .01 percent. 0.000001 (smallest granularity) represent 0.0001%.", "type": "number", "multipleOf": 0.000001 }, "idType": { "description": "Id guidelines are to use string type, but Vertex Payroll IDs must be constrained to integer values.", "type": "string", "pattern": "[0-9]*" }, "geocodeId": { "type": "string", "pattern": "[0-9]*", "minLength": 9, "maxLength": 9, "description": "Id for a full geocode." }, "taxIdentifierId": { "type": "string", "pattern": "^(-1|100|101|102|103|104|105|200|201|202|203|204|205|300|301|302|303|304|305|400|401|402|403|404|405|406|407|408|409|410|411|412|413|414|415|416|417|418|419|448|449|450|451|452|453|454|455|456|457|458|459|460|461|462|463|464|465|466|467|468|469|470|471|472|473|474|475|476|477|478|479|480|481|482|483|484|485|486|487|488|489|490|491|492|493|494|495|500|501|502|503|504|505|506|507|508|509|510|511|512|513|514|530|531|532|533|534|535|536|537|538|539|540|541|542|543|544|545|546|547)$", "description": "Id for a tax identifier." }, "schoolDistrictId": { "type": "string", "pattern": "[0-9]*", "maxLength": 5, "description": "Id for a school district." }, "taxRecordType": { "type": "string", "description": "Used to indicate whether the tax is for an Employee or an Employer.", "enum": [ "Employee", "Employer" ] }, "jitType": { "type": "string", "pattern": "^([0-9]|10|13|99)$", "description": "Valid jurisdiction interaction treatment ids:\n\n|Value |Description |\n|:---------|:----------------------:|\n|0 |This provides the same Treatment as setting pNRCertif to False. |\n|1 |This provided the same Treatment as setting pNRCertif to True. |\n|2 |Credit the resident tax by the amount of work tax withheld. Always accumulate wages. |\n|3 |Credit the resident tax by the amount of work tax withheld. Accumulate wages only if resident tax is withheld. |\n|4 |Eliminate the resident tax if the work tax is > zero. Always accumulate wages. |\n|5 |Eliminate the resident tax if the work tax is > zero. Accumulate wages only if resident tax is withheld. |\n|6 |Eliminate the resident tax if work tax is imposed on nonresidents. Always accumulate wages. |\n|7 |Eliminate the resident tax if work tax is imposed on nonresidents. Accumulate wages only if resident tax is withheld |\n|8 |Calculate work taxes only. |\n|9 |Misc Behavior Maryland. |\n|10 |Credit the resident tax by the amount of the work tax withheld. Accumulate wages only if out of state tax is not withheld. |\n|13 |Eliminate the resident tax if the wages are earned out of state. Accumulate wages only if tax withheld. |\n|99 |Calculate the tax for this jurisdiction independent of all other jurisdictions. |\n" } } } } ```