List Payruns Summary

Get a list of pay run summaries associated with the business.

Request

GET ../api/v1/client/payrun/summary

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code
Description
Resource

200

Success

Refer Response Data

Response Data

{
    "dateFinalised": "date-time",
    "datePaid": "date-time",
    "externalId": "string",
    "id": "int32",
    "isFinalised": "boolean",
    "notation": "string",
    "payPeriodEnding": "date-time",
    "payPeriodStarting": "date-time",
    "payScheduleId": "int32",
    "paySlipsPublished": "boolean",
    "totalGrossWages": "double",
    "totalHours": "double",
    "totalNetWages": "double"
}

Last updated