SupplementaryPayRunDetails

Schema

Name / Description Type / Format Example
description
Description of the Supplementary Pay Run
This will be set to a default value if not set by the user
 string "string"
paymentDate
The intended date that the Employees included in the supplementary PayRun will be paid, although this can be changed on a per PayRunEntry basis
This date must be on or after the PaymentDate of the main PayRun
 string date "2025-04-27"
employeeUniqueIds
List of employee unique ids to be included in a supplementary Payrun
 string[]

JSON Example 

{
  "description": "string",
  "paymentDate": "2025-04-27",
  "employeeUniqueIds": [
    "string"
  ]
}

References

Contained in Models

- none -

Consumed by Operations
Creates a supplementary PayRun - Beta
Returned by Operations

- none -