AePeriod

Schema

Name / Description Type / Format Example
payPeriod string "Custom" "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily"
payDate string date "2025-08-29"
startDate string date "2025-08-29"
endDate string date "2025-08-29"
lowerEarningsThreshold number double 0.0
qualifyingThreshold number double 0.0
minimumAge integer int32 0
deferalPeriodType string "Days" "Weeks" "Months" "PayPeriods"
deferalPeriods integer int32 0
cyclicalReenrolmentDate string date "2025-08-29"
cyclicalReenrolmentIsDue boolean true

JSON Example 

{
  "payPeriod": "Custom",
  "payDate": "2025-08-29",
  "startDate": "2025-08-29",
  "endDate": "2025-08-29",
  "lowerEarningsThreshold": 0.0,
  "qualifyingThreshold": 0.0,
  "minimumAge": 0,
  "deferalPeriodType": "Days",
  "deferalPeriods": 0,
  "cyclicalReenrolmentDate": "2025-08-29",
  "cyclicalReenrolmentIsDue": true
}

References

Contained in Models
AeEmployeeAssessmentRequest
Consumed by Operations

- none -

Returned by Operations

- none -