Reports API Fields

This table lists the fields included in the request body for Vertex Payroll Tax Employee Report for Gross Up API requests.

Field	Details	Description
`payCheck` - required	object	Used to calculate payroll taxes for a particular employee. Includes the following sub-fields: `employee` - required `workLocations` `deductions` `jurisdictions` `aggregatedCompensations` `aggregatedTaxes` `calculationOverrides` `canadianDetails` `formsData` `compensationOverrides` `deductionOverrides` `options`
`targetNet` - required	number	The target net amount for a gross up calculation. Providing a value to this property triggers performing a gross up calculation. Two digits precision decimal for dollar.

This table lists the fields included in the request body for Vertex Payroll Tax Employee Report for Paycheck API requests.

Field	Details	Description
`employee` - required	object	Information about the employee. Includes the following sub-fields: `employeeId`- required `payPeriod`- required `defaultSupplementalPayTypeTreatment` `residenceGeocodeId`- required `primaryWorkGeocodeId`- required `residentSchoolDistrictId` `specialPayPeriod` `periodToDateAggregation`
`workLocations`	array of objects	Information regarding work locations, including compensations. Includes the following sub-fields: `workLocationId` `geocodeId`- required `schoolDistrictId` `currentHours` `monthToDateHours` `yearToDateHours` Includes the following object: `compensations` which includes the following sub-fields: `compensationCodeId`- required `payType` `amount`- required `overrideCompensationType`
`deductions`	array of objects	`deductionTypeId` - required `deductionAmount` `deductionPercent` `yearToDateAmount` `cashTakenByEmployee` `taxabilityOverride` `maximumDeductionAmount`
`jurisdictions`	array of objects	Jurisdiction-specific taxing options. Includes the following object which is a combination of IDs that define a tax record: `taxRecordIdentifier` - required which includes the following sub-fields: `taxIdentifierId` - required `geocodeId` - required `schoolDistrictId` Includes the following sub-fields: `filingStatus` `primaryExemptions` `primaryExemptionAmount` `secondaryExemption` `secondaryExemptionAmount` `calculationMethod` `alternativeCalculationCode` `recalculate` `jurisdictionInteractionTreatementId` `nonResident` `ignoreParentJurisdictionDefaults` `taxExempt` `nonResidentAlienTreatment` `taxingLocationType` `supplementalPayTypeTreatment` `experienceRate` `specialPayPeriod`
`aggregatedCompensations`	array of objects	Includes the following object which is a combination of IDs that define a tax record: `taxRecordIdentifier` - required which includes the following sub-fields: `taxIdentifierId` - required `geocodeId` - required `schoolDistrictId` Includes the following sub-fields: `taxingLocationType` `compensationId` - required `payType` `amount` - required `aggregationType` - required `aggregateHours` `overrideCompensationType`
`aggregatedTaxes`	array of objects	Aggregated taxes paid in prior pay periods. Includes the following object which is a combination of IDs that define a tax record: `taxRecordIdentifier` - required which includes the following sub-fields: `taxIdentifierId` - required `geocodeId` - required `schoolDistrictId` Includes the following sub-fields: `payType` `taxingLocationType` `taxAmount` `aggregateAdjustedGross` `aggregationType` - required `aggregateHours` `aggregateExemptAmount`
`calculationOverrides`	array of objects	Options to override various values in computing taxes. Includes the following object which is a combination of IDs that define a tax record: `taxRecordIdentifier` - required which includes the following sub-fields: `taxIdentifierId` - required `geocodeId` - required `schoolDistrictId` Includes the following sub-fields: `taxingLocationType` `overrideAdditionalRate` `overrideAdditionalExemption` `overrideWageBase` `overrideExemptAmount` `overrideMaximumDeduction` `overrideRate` `additionalTaxAmount` `overrideTaxAmount` `supplementalPayAdditionalExemptions` `supplementalPayOverrideRate` `supplementalPayAdditionalTaxAmount` `supplementalPayOverrideTaxAmount` `supplementalPayOverrideExemptAmount`
`canadianDetails`	array of objects	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). Includes the following sub-fields: `geocodeId` - required `workGeocodeId` - required `annualDeductionAmount` `claimAmount` `employeeDateOfBirth` `married` `disabled` `nonResident` `numberOfDependents` `otherTaxCredits` `claimCode` `desitnatedAreaDeduction` `daysSinceLastPay` `disabledDependentsOver18` `over65` `pensionCompensation` `pensionablePayPeriods` `stockPurchaseAmount` `totalExpenseAmount` `totalRenumerationAmount`
`formsData`	array of objects	Additional information needed to calculate certain taxes. Includes the following sub-fields: `taxIdentifierId` `geocodeId` - required `schoolDistrictId` `taxingLocationType` `formFieldIdentifier` - required `formFieldValue`
`compensationOverrides`	array of objects	Provides the option to override pre-calculation compensation values at the tax object level. Includes the following object which is a combination of IDs that define a tax record: `taxRecordIdentifier` - required which includes the following sub-fields: `taxIdentifierId` - required `geocodeId` - required `schoolDistrictId` Includes the following sub-fields: `taxingLocationType` - required `payType` -required `compensationCodeId` `aggregationType` `compensationAmount` `overrideCompensationType`
`deductionOverrides`	array of objects	Provides the option to override pre-calculation deduction values at the tax object level. Includes the following object which is a combination of IDs that define a tax record: `taxRecordIdentifier` - required which includes the following sub-fields: `taxIdentifierId` - required `geocodeId` - required `schoolDistrictId` Includes the following sub-fields: `taxingLocationType` - required `deductionTypeId` `deductionAmount` `deductionPercent` `yearToDateDeductionAmount` `cashOption` `taxabilityOverride` `maximumDeductionOverride`
`options`	object	Includes the following sub-fields: `reportZeroTax` `processInvalidGeocode`

This table lists the fields included in the request body for Vertex Payroll Tax Employee Report for Vacation Pay API requests.

Field	Details	Description
`payCheck` - required	object	Used to calculate payroll taxes for a particular employee. Includes the following sub-fields: `employee` - required `worklocations` `deductions` `jurisdictions` `aggregatedCompensations` `aggregatedTaxes` `calculationOverrides` `canadianDetails` `formsData` `compensationOverrides` `deductionOverrides` `options`
`regularGrossPay` - required	number	Regular gross pay with two digits precision decimal.
`overrideVacationPayFactor`	number	Override to the ratio of vacation time to current pay period