Name / Description | Type / Format | Example | |
---|---|---|---|
employeeId
Employee unique Id
|
string
uuid
|
"string"
|
|
employeeRoleId
Employee role unique Id
|
string
uuid
|
"string"
|
|
taxYear
|
string
|
"Year2017"
"Year2018"
"Year2019"
"Year2020"
"Year2021"
"Year2022"
"Year2023"
"Year2024"
|
|
payPeriod
|
string
|
"Custom"
"Monthly"
"FourWeekly"
"Fortnightly"
"Weekly"
"Daily"
|
|
periodNumber
Tax Week or Tax Month number this PayRunEntry relates to
|
integer
int32
|
0
|
|
payAmount
monetary amount for given period, if not provided then 0
|
number
double
|
0.0
|
|
hours
decimal amount of hours worked, if not provided then 0
|
number
double
|
0.0
|
|
isStatutoryPayOnly
optional boolean flag, if the period only had SXP present
|
boolean
|
true
|
|
paymentDate
The date payment was made for respective period
|
string
date
|
"2024-12-05"
|
{
"employeeId": "string",
"employeeRoleId": "string",
"taxYear": "Year2017",
"payPeriod": "Custom",
"periodNumber": 0,
"payAmount": 0.0,
"hours": 0.0,
"isStatutoryPayOnly": true,
"paymentDate": "2024-12-05"
}
- none -
- none -