PayRun

This model is right at the very heart of the software.
There is a PayRun for each period in which people are paid.

Schema

Name / Description Type / Format Example
uniqueId
Unique Id of report template column
 string uuid "string"
userName
Name of the user who created the report template
 string "string"
templateName
Name of the report template
 string "string"
description
Description of the report template
 string "string"
reportTemplateColumns
List of the report template column
 Contract.ReportTemplateColumnResponse[] {Contract.ReportTemplateColumnResponse}
updatedDate
Updated date of the report template column
 string date "2026-06-13"
createdDate
Created date of the report template column
 string date "2026-06-13"

JSON Example 

{
  "uniqueId": "string",
  "userName": "string",
  "templateName": "string",
  "description": "string",
  "reportTemplateColumns": [
    {
      "position": 0,
      "header": "string",
      "content": "string",
      "type": "CustomFixedData"
    }
  ],
  "updatedDate": "2026-06-13",
  "createdDate": "2026-06-13"
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Create Report Template (beta)
Get Report Template (beta)
Update Report Template (beta)
Getting Started The Ordinal property
Completing a Pay Run Start the PayRun
Completing a Pay Run Review the PayRun
Completing a Pay Run Finalise the PayRun
Completing a Pay Run Get Accounting Entries