GET /Report/PAYDASHBOARD/run

payrun.io

Summary: Runs the Pay Dashboard payslips report
Operation ID: GetPayDashboardPayslipReportOuput
Auth: unknown
Description

Returns the result of the executed Pay Dashboard payslip report for the given query parameters. See https://api.paydashboard.com for details. For compatability should be returned as JSON with TransformDefinitionKey=Json-Clean.

Parameters (11)

Api-Version (string, header, required, default: default)

The version of the api to target. Omit or set as 'default' to target the current api version.

Authorization (string, header, required, default: Auto)

The OAuth 1 authorization header. 'Auto' enables auto complete.

EmployeeCodes (string, query, optional)

A comma separated list of the employee codes. E.g. EMP001,EMP002

EmployerKey (string, query, required)

The employer unique key. E.g. ER001

MaxIndex (string, query, optional)

The highest element index to return from the report. Used to control paging within large data sets. E.g. 100

PayScheduleKey (string, query, required)

The pay schedule unique key. E.g. SCH001

PaymentDate (string, query, optional)

The payment date context for the report. E.g. 2018-04-30

PublicationDate (string, query, required)

Specific to the Pay Dashboard report, allows the specification of a future payslip publication date. E.g. 2018-12-31

StartIndex (string, query, optional)

The element index to begin the report. Used to control paging within large data sets. E.g. 1

TaxYear (string, query, required)

The tax year. E.g. 2017 = 2017/18 year.

TransformDefinitionKey (string, query, optional)

The transform definition unique key. E.g. P45-Pdf

No probe data for this endpoint yet.