Skip to navigation
Small Business APIPayroll

Submit a payroll run

View as Markdown

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
fromAccountIdstringRequired
The account to fund payroll from.
payDatedateRequired

Date employees should receive funds (YYYY-MM-DD).

employeeslist of objectsRequired
List of employee disbursements.

Response

The payroll run was successfully submitted.
idstring
Unique identifier for the payroll run.
statusenum
Current status of the payroll run.
Allowed values:
totalAmountdouble
Total amount disbursed across all employees.
employeeCountinteger
Number of employees in this payroll run.
createdAtdatetime
Timestamp when the payroll run was submitted.