Preview a period

Calculates the amounts for a set of worker for a given period.

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

Employer Id

Body Params

Input data for previewing a period specifying a PayGroup.

date
required

Date when the period should be calculated.

date
required

Date when the period ends.

includeElements
boolean
required

Include elements already processed by any PayrollRun within the same period.

date
required

Date when the period starts.

string
required
Defaults to PeriodPreviewFromPayGroupInput

Input type.

string
required

Id of the WorkerPayGroup.

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