Getting Started with the Vertex Payroll Tax RESTful APIs

About Vertex Payroll Tax

Vertex Payroll Tax is a cloud-based payroll tax calculation engine that is built on the industry-leading Vertex Cloud Platform. This product is integrated with leading HCM and Staffing platforms and used to calculate payroll taxes for 30 million employees each year.
For customers who prefer an on-premise solution, Vertex Payroll Tax is also available to run locally as a docker container.

About Vertex Payroll Tax RESTful APIs

Welcome to the Vertex® Developer Network. The Vertex Payroll Tax RESTful APIs give customers the ability to precisely calculate payroll tax for employees across the United States and Canada. Functionality includes:

Address Cleansing to ensure precise onboarding and tax calculation
GeoCode assignment to the employee's home and work location or locations
Calculation of gross to net withholdings
Gross-up and vacation pay calculations

To learn more about how to use the Vertex Payroll Tax RESTful APIs, go to Using the Payroll Tax API.

Available Vertex Payroll Tax RESTful APIs

Here is more information about the available Vertex Payroll Tax RESTful APIs.

Paychecks API: the Vertex Payroll Tax Paychecks API is used to calculate payroll taxes for a particular employee. The employee's compensations, deductions, and work locations must be included in the request. The computed taxes, deductions allowed, and compensations allowed are returned.

Gross-up: The Gross-up API calculates the gross pay amount required to pay an employee a specified net amount.

VacationPay: 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.

Queries: Various queries are available to assist customers in understanding what data is contained within the system and how to effectively integrate that data.

Sample API calls

Go to Sample Payroll API Calls to view samples of the following scripts:

GeoCode & calculation
Address Cleansing

O Series OAS files

Links to downloads of the OpenAPI Specification (OAS) files for the Vertex Payroll tax APIs can be found on the following pages.