Jump to Content

Guides API Reference

API Reference

Guides API Reference

All

Pages

Start typing to search…

Timesheets API

⏰ Start here! Guide to the Timesheets API
Update classified hours for entire pay periodpost
Create a shift on an employee’s timesheetpost
Update a shift on an employee’s timesheetput
Delete a shift on an employee’s timesheetdel
Retrieve a shift by IDget
List shifts on an employee’s timesheetget

Payables API

💵 Guide to the Payables API
Create Payable Itempost
Create Payable Items (bulk)post
Prepare Payable Items for Payoutpost
Update Payable Item by IDput
Get Payable Item by IDget
List Payable Itemsget
List Unpaid Payable Itemsget
Delete Payable Item by IDdel
Delete payable items by ID (bulk)post

Embedded Experience API

Create embedded experience URLpost
Create contractor for embedded onboardingpost
Create employee for embedded onboardingpost

Create Worker API

Look up hiring status for a workerpost
Kick off onboarding for a contractorpost
Kick off onboarding for an employeepost
Create a complete contractor recordpost
Create a complete employee recordpost
Delete a worker in onboardingdel

Worker Data API

List workersget
Search for workersget
Get worker by IDget
Get Everee access invitationget
Get accrued leave balancesget
Update personal informationput
Update default position & compensationput
Update default bank accountput
Update default work locationput
Update home addressput
Update worker IDput
Update approval groupput
Update taxpayer identifierput
Update payment preferencesput
Update start/hire dateput
Update emergency contactput

Payroll Expenses API

Get payroll expenses by pay period (or date range)get

Early Pay API

💸 How Early Pay works
Get Early Pay Statusget
Request Early Paypost

REAL TIME PAYROLL API

Update Real Time Payroll enrollmentput

ORGANIZATION API

Create a work locationpost
Archive a work locationdel
Retrieve a work locationget
List work locationsget
List Workers' Compensation classesget
Create an approval grouppost
List approval groupsget
List Treasury Tipped Occupation Codesget
List all SOC codesget

Leave Policies API

List leave policiesget

Files & Forms API

List worker filesget
Get W-4 tax withholding settingsget
Update W-4 tax withholding settingsput
Get Form W-9 infoget

Worker Payment History API

Retrieve a worker’s pay historyget
Retrieve a pay history item by IDget
Retrieve a list of available pay statementsget
Retrieve a pay statementget

Candidates API

Get Worker Profile by TINget

W-2 Payroll Gross Earnings API

Create gross earning for W-2 payrollpost
Create bulk gross earnings for W-2 payrollpost
Delete gross earnings for W-2 payrolldel

Reference

Worker
WorkedShift
PaymentHistoryItem
Money
Earning types
Payment statuses
Tax methods
Pagination

Everee API

Payables

Get Everee access invitation

get

https://example.com

Retrieve the "invitation URL" for a worker.

Language

Response

Click Try It! to start a request and see the response here!