Reference

Preview a period

post
https://api.sandbox.salsa.dev/api/rest/v1/employers//period-preview

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

Path Params
string
required

Employer Id

Body Params
date
required

Date when the period should be calculated.

date
required

Date when the period ends.

includeElements
object

Options to control which payroll elements (e.g. compensations, benefits, etc.) should have their recurring amounts (from policies) and existing unprocessed amounts included in the calculation of this preview run. If not specified, all elements will be included in the preview by default, i.e. the default value is an object with all child properties set to true.

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

Updated 4 months ago

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