| Name / Description | Type / Format | Example | |
|---|---|---|---|
payPeriod
|
string
|
"Custom"
"Monthly"
"FourWeekly"
"Fortnightly"
"Weekly"
"Daily"
|
|
payDate
The pay date of the period
|
string
date
|
"2025-11-28"
|
|
startDate
The start date of the period
|
string
date
|
"2025-11-28"
|
|
endDate
The end date of the period
|
string
date
|
"2025-11-28"
|
|
lowerEarningsThreshold
The lower earnings threshold for the period
|
number
double
|
0.0
|
|
qualifyingThreshold
The qualifying threshold for the period
|
number
double
|
0.0
|
|
upperEarningsThreshold
The upper earnings threshold for the period
|
number
double
|
0.0
|
|
minimumAge
The minimum age to assess in the period
|
integer
int32
|
0
|
|
deferalPeriodType
|
string
|
"Days"
"Weeks"
"Months"
"PayPeriods"
|
|
deferalPeriods
The number of deferal periods
|
integer
int32
|
0
|
|
enrolmentDeferalPeriodType
|
string
|
"Days"
"Weeks"
"Months"
"PayPeriods"
|
|
enrolmentDeferalPeriods
The number of deferal periods for enrolment
|
integer
int32
|
0
|
|
cyclicalReenrolmentDate
The cyclical reenrolment date
|
string
date
|
"2025-11-28"
|
|
cyclicalReenrolmentIsDue
If cyclical reenrolment is due in this period
|
boolean
|
true
|
{
"payPeriod": "Custom",
"payDate": "2025-11-28",
"startDate": "2025-11-28",
"endDate": "2025-11-28",
"lowerEarningsThreshold": 0.0,
"qualifyingThreshold": 0.0,
"upperEarningsThreshold": 0.0,
"minimumAge": 0,
"deferalPeriodType": "Days",
"deferalPeriods": 0,
"enrolmentDeferalPeriodType": "Days",
"enrolmentDeferalPeriods": 0,
"cyclicalReenrolmentDate": "2025-11-28",
"cyclicalReenrolmentIsDue": true
}- none -
- none -