PayRunStateChange

Schema

Name / Description Type / Format Example
state string "Opening" "Open" "ReOpening" "RollingBack" "RolledBack" "SubmittedForProcessing" "Processing" "AwaitingApproval" "Approved" "Finalising" "Finalised" "Deleting"
reason string "Other" "AdditionalDataNotSubmitted" "ChangeToOriginalData" "PayBureauError"
reasonText
A free-form text field for a reason for the change of state.
 string "string"
employeeUniqueIds
List of employee unique ids, whose PayRunEntries to be re-opened during a Payrun rollback operation.
Will be used only during a transition to a rolled back pay run state
 string[]

JSON Example 

{
  "state": "Opening",
  "reason": "Other",
  "reasonText": "string",
  "employeeUniqueIds": [
    "string"
  ]
}

References

Contained in Models

- none -

Consumed by Operations
Update PayRun
Registers a request to update the PayRun (beta)
Returned by Operations

- none -