PaySchedulePeriodEvent

An Event within a PaySchedulePeriod. The event could be scheduled x days before PaymentDate.

Name / Description Type / Format Example
payPeriodEventType
Different events supported for a PaySchedule Period. These events happen a pre-configured number of days before the PaymentDate for that PaySchedulePeriod.
string "SubmitForProcessing" "SendForApproval" "Approval" "Finalise" "SendPaySlip" "SubmitRti"
eventDate
The expected date and time of the event.
string date "2021-10-16"
actualEventDate
The actual date and time when the event was completed.
string date "2021-10-16"
isOverDue
Returns true if its past the event date.
boolean true
id
The unique id of the object
string uuid "string"
{
  "payPeriodEventType": "SubmitForProcessing",
  "eventDate": "2021-10-16",
  "actualEventDate": "2021-10-16",
  "isOverDue": true,
  "id": "string"
}
Contained in Models
PaySchedulePeriod
Consumed by Operations

- none -

Returned by Operations

- none -