Jump to Content
Guides
Reference
Changelog
API Upgrades
Guides
Reference
v2025-01-01
Guides
Reference
Changelog
API Upgrades
Reference
v2025-01-01
Reference
The benefit object
All
Pages
Start typing to search…
JUMP TO
Check API
Introduction
Topics
Authentication
Errors
Error codes
Errors during payroll preview
Rate limiting
X-Request-Log-Id Response Header
Idempotent Requests
Versioning
Check Components
Overview of Components
Setup Components
Company Previous Payroll Provider Access
post
Company Progress Tracker Component
post
Company Verification Documents
post
Company Signatory Agreements
post
Company Connect Bank Account
post
Company Team Setup
post
Company Pay History
post
Company Full Service Setup Submission Component
post
Company Business Details Component
post
Employee Tax Setup Component
post
Company Components
Company Onboard
post
Company Terms of Service
post
Company Details
post
Company Payment Setup
post
Company Tax Setup
post
Company-Defined Employee Setup
post
Company Filing Authorization
post
Company Accounting Integration
post
Company Authorization Documents
post
Company Tax Documents
post
Company Reports
post
Run Payroll
post
Filing Preparation Checklist Component
post
Filing Preview Component
post
Employee Components
Employee Onboard
post
Employee SSN Setup
post
Employee Payment Setup
post
Employee Withholdings Setup
post
Employee Profile
post
Employee Benefits
post
Employee Post-Tax Deductions
post
Employee Tax Documents
post
Employee Paystubs
post
Contractor Components
Contractor Onboard
post
Contractor Tax Documents
post
API Reference
Companies
The company object
Create a company
post
Get a company
get
Update a company
patch
List companies
get
Get payroll journal
get
Get payroll summary
get
Get tax liability report
get
Get company paydays
get
Get contractor payments report
get
Get W-2 Preview Report
get
Get W-4 Exempt Status Report
get
The Federal EIN Verification object
List Federal EIN Verifications
get
Get a Federal EIN Verification
get
List tax deposits
get
The Signatory object
Get signatories
get
Create a signatory
post
The Enrollment Profile object
Get the enrollment profile
get
Create the enrollment profile
put
Update the enrollment profile
patch
Get a company's applied-for tax parameters report
get
Implementation
Start implementation
post
Cancel implementation
post
Request Embedded Setup
post
Addresses
Validate address
post
Workplaces
The workplace object
Create a workplace
post
Get a workplace
get
Update a workplace
patch
List workplaces
get
Employees
The employee object
Create an employee
post
Get an employee
get
Update an employee
patch
List employees
get
List employee paystubs
get
Get a paystub
get
List employee forms
get
Get an employee form
get
Submit an employee form
post
Get company-defined attributes
get
Update company-defined attributes
patch
Get reciprocity elections
get
Update reciprocity elections
patch
Reveal employee SSN
get
Contractors
The contractor object
Create a contractor
post
Get a contractor
get
Update a contractor
patch
List contractors
get
List contractor payments
get
Get a contractor pay statement
get
List contractor forms
get
Submit a contractor form
post
Reveal contractor SSN
get
Bank Accounts
The bank account object
Create a bank account
post
Update a bank account
patch
Get a bank account
get
List bank accounts
get
Delete a bank account
del
Reveal account number
get
Net Pay Splits
The net pay split object
Create a net pay split
post
Get a net pay split
get
List net pay splits
get
Payrolls
The payroll object
The preview object
The totals object
The off-cycle options object
The warnings object
Create a payroll
post
Preview a payroll
get
Reopen a pending payroll
post
Approve a payroll
post
Get a payroll
get
Update a payroll
patch
List payrolls
get
Delete a payroll
del
Get paper checks
get
Get Cash Requirement Report
get
Get Paper Checks Report
get
[Sandbox] Start processing
post
[Sandbox] Complete funding
post
[Sandbox] Fail funding
post
[Sandbox] Complete disbursements
post
Payroll Items
The payroll item object
The earning object
Types of earnings
Create a payroll item
post
Get a payroll item
get
Update a payroll item
patch
Update payroll items (bulk)
patch
List payroll items
get
Delete a payroll item
del
Delete payroll items (bulk)
del
Get a paper check
get
Warnings
Contractor Payments
The contractor payment object
Create a contractor payment
post
Get a contractor payment
get
Update a contractor payment
patch
List contractor payments
get
Delete a contractor payment
del
Get a paper check
get
External Payrolls
The external payroll object
The external payroll item object
The external payroll contractor payment
List external payrolls
get
Get an external payroll
get
Create an external payroll
post
Update an external payroll
patch
Delete an external payroll
del
Approve an external payroll
post
Reopen an external payroll
post
Preview an external payroll
get
Pay Schedules
The pay schedule object
Create a pay schedule
post
Get a pay schedule
get
List pay schedules
get
Update a pay schedule
patch
Get paydays
get
Benefits
The benefit object
Types of benefits
Create a benefit
post
Get a benefit
get
List benefits
get
Update a benefit
patch
Delete a benefit
del
Post-Tax Deductions
The post-tax deduction object
Create a post-tax deduction
post
Get a post-tax deduction
get
Update a post-tax deduction
patch
List post-tax deductions
get
Delete a post-tax deduction
del
Company Benefits
The company benefit object
Create a company benefit
post
Get a company benefit
get
List company benefits
get
Update a company benefit
patch
Delete a company benefit
del
Earning Rates
The earning rate object
Create an earning rate
post
Get an earning rate
get
List earning rates
get
Update an earning rate
patch
Earning Codes
The earning code object
Create an earning code
post
Get an earning code
get
List earning codes
get
Update an earning code
patch
Documents
The document object
List company tax documents
get
Get a company tax document
get
Download a company tax document
get
List company authorization documents
get
Get a company authorization document
get
Download a company authorization document
get
List employee tax documents
get
Get an employee tax document
get
Download an employee tax document
get
List contractor tax documents
get
Get a contractor tax document
get
Download a contractor tax document
get
List setup documents
get
Get a Setup Document
get
Download a setup document
get
Company Provided Documents
The company provided document object
Create a company provided document
post
Get a company provided document
get
List company provided documents
get
Upload a file for a company provided document.
put
Forms
The form object
Types of form parameters
Get a form
get
List forms
get
Render a form
post
Payments
The payments and payment attempts objects
List payments
get
Get a payment
get
Get a payment attempt
get
Retry a payment
post
Refund a payment
post
Cancel a payment
post
Tax Parameters
The tax parameter object
Types of tax parameters
Tax parameter option
Tax parameter dependency
Tax parameter setting
Tax parameter jurisdiction
Tax parameter definition
Company Tax Parameters
List a company's tax parameters
get
Update a company's tax parameters
patch
List a company's tax parameter settings
get
Get a specific company's tax parameter setting
get
List a company's jurisdictions
get
Employee Tax Parameters
List an employee's tax parameters
get
Update an employee's tax parameter
patch
List an employee's tax parameter settings
get
Get a specific employee's tax parameter setting
get
List an employee's jurisdictions
get
Bulk get employee tax parameters
get
Bulk get employee tax parameter settings
get
Bulk update employee tax parameters
patch
Tax Elections
The tax election object
Company Tax Elections
List company tax elections
get
Create company tax elections
post
Update company tax elections
patch
Employee Tax Elections
List employee tax elections
get
Update employee tax elections
patch
[Legacy] Tax Filings
The tax filing object
The tax filing event object
Tax filing status
List tax filings
get
Get a tax filing
get
Get a tax filing event
get
[New] Filings
The filing object
List filings
get
Get a filing
get
Setup
The setup object
Get a setup
get
List setups
get
Requirements
The requirement object
Requirement categories
Requirement statuses
Requirement errors
Requirement guidance
List requirements
get
Get a requirement
get
Webhooks
The webhook config object
Create a webhook config
post
Get a webhook config
get
Update a webhook config
patch
Delete a webhook config
del
List webhook configs
get
Ping a webhook config
post
Retry webhook event in sandbox
post
Notifications
The notification object
Types of notification topics
List notifications
get
Get a notification
get
Communications
The communication object
The email object
List communications
get
Get a communication
get
Usage
List usage summaries
get
List usage records
get
Integrations
List Integration Partners
get
Get an Integration Partner
get
List Integration Permissions
get
Get an Integration Permission
get
Authorize an Integration Partner
put
List Integration Accesses
get
Employee tax statements
The employee tax statement object
Get an employee tax statement
get
List employee tax statements
get
Tax packages
The tax package object
Request a tax package
post
Get a tax package
get
The benefit object
Ask AI
Represents benefits available to employees.
