PayRunStateChange

Name / Description Type / Format Example
state
The state of the payrun. You would set this value when updating a payrun to finalise or re-open it.
Other states are used with Bureau functionality which isn't currently generally available.
string "Open" "SubmittedForProcessing" "Processing" "AwaitingApproval" "Approved" "Finalised"
reason string "NoneGiven" "AdditionalDataNotSubmitted" "ChangeToOriginalData" "PayBureauError"
reasonText
A free-form text field for a reason for the change of state.
string "string"
{
  "state": "Open",
  "reason": "NoneGiven",
  "reasonText": "string"
}
Contained in Models

- none -

Consumed by Operations
Update PayRun
Returned by Operations

- none -