Toast Payroll

Toast's own documentation covers employees and hours through the API. Access: Partner or paid customer access.

Integration method grade ? · field-level docs NOT publicly readable · last verified 2026-09-26 · Toast Payroll: deduction codes (Toast Support)

What the API lets you do

Question	Answer	Conf	What the documentation says
How do you get API access?	Partner or paid customer access	D	Four integration types: partner integrations (apply and be vetted), custom integrations for customers, standard API access bought through the Toast Shop (read-only), and analytics API access. Source
Can you read employees and pay rates?	Yes — Labor API	D	Employee has firstName, lastName, email, jobReferences, wageOverrides, externalEmployeeId and createdDate; no hire-date field in the schema. Source
Can you read pay statements?	No payroll API	—	The API overview lists no payroll API; labor reports cover raw hours, wages and tips for building payroll, not payroll results. Source
Can you write a deduction?	No payroll API	—	No payroll or deduction API is listed; deductions are managed in Toast Web (Team > employee > Recurring > Deductions). Source
Can you write a direct deposit account?	No payroll API	—	No payroll API, and the Employee schema has no bank or direct-deposit fields.
Can you read W-2s?	No payroll API	—	No payroll or tax-document API is listed.
Can you read hours worked?	Yes — time entries	D	TimeEntry has inDate, outDate, businessDate, regularHours, overtimeHours, hourlyWage, breaks and tips; shifts are also available. Source
Does it push change events?	No labor or payroll events	—	Webhooks cover orders, menus, stock, availability and similar restaurant events only.
How does an integration authenticate?	OAuth 2.0 client credentials	D	clientId and clientSecret to /authentication/v1/authentication/login return a bearer JWT; calls also need a Toast-Restaurant-External-ID header. Source

Deduction write, in detail

For benefits, HSA/FSA and 401(k) integrations. 3 of 10 fields are unverified — no public source states the answer. Compare every system on the deduction write detail page.

Field	Value	Conf	Note — and what a correct answer needed
Deduction read	No API; portal only	D	No payroll API is listed; deductions are viewed in Toast Web under the employee's Recurring tab.
Deduction write	Portal, Toast-assisted	D	Recurring deductions under Team > employee > Recurring > Deductions; one-time deductions in the payroll preview. New codes are built by Toast Customer Care on request.
Pre-tax vs post-tax at write	Set on the code	D	The deduction-codes article distinguishes pre-tax (HSA, 401(k), medical) from post-tax (garnishments, meals, uniforms) codes.
Amount vs percent	Amount or percent, not both	D	'A deduction will either have an amount or a percentage, but never both.' Limit caps are supported.
Effective dating	End dates on recurring	D	Recurring deductions carry end dates (which can be set to 2099); changes must be made before the payroll is opened.
Retro adjustment	Unverified	U	No public page on retroactive deduction adjustment located; arrears are mentioned only for insufficient pay.
Employer contribution	Unverified	U	The deduction articles do not describe employer contribution fields.
Code taxonomy shape	Company-specific, built by Toast	D	Customers request codes and Toast Customer Care builds them.
Auth model	Portal login (no API)	D	Deductions are managed only in the Toast Web portal; Toast APIs have no payroll scope.
Data freshness	Unverified	U	No public statement on when deduction changes take effect beyond 'before the payroll is opened'.

D vendor-documented · U unverified · — not offered. See every payroll system side by side in the Payroll API Capability Matrix.