API Reference

Get Employee Report For Paycheck.

post
https://payroll-test.vertexcloud.com/payroll/v2/paychecks-employee-report

Returns the Employee Report in xml format for the given Paycheck request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The Paycheck request to generate the employee report for.

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.

employee
object
required

Information about the employee.

workLocations
array of objects
workLocations
deductions
array of objects
deductions
jurisdictions
array of objects
jurisdictions
aggregatedCompensations
array of objects
aggregatedCompensations
aggregatedTaxes
array of objects
aggregatedTaxes
calculationOverrides
array of objects
calculationOverrides
canadianDetails
array of objects
canadianDetails
formsData
array of objects
formsData
compensationOverrides
array of objects

Provides the option to override pre-calculation compensation values at the tax object level.

compensationOverrides
deductionOverrides
array of objects

Provides the option to override pre-calculation deduction values at the tax object level.

deductionOverrides
options
object
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 13 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago