Preview PayrollRun

Previews a new PayrollRun. This provides a lightweight preview of what a payroll run may look like after creation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Employer Id

Body Params

Creates a PayrollRun preview for the workers included in the PayGroup.

payPeriod
object
required

Pay period for this PayrollRun. This will determine which pay and deductions entries will be used in the payment's calculation.

string
required
Defaults to PayrollRunPreviewFromPayGroupInput

Input type.

string
required

Id of the WorkerPayGroup.

workerWorkLocationOverrides
array of objects | null

Optional work location overrides per worker.

workerWorkLocationOverrides
Responses

500

Internal Server Error

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json