Use Case Description
There are key events that could be used as triggers to retrieve payroll output data. Your application could subscribe notifications for these events and the status.
API Usage and Application Scope
The following table shows the list of events, the APIs to use and the Application Scope to be included. The canonical URI corresponding to the API needs to be added in the Consumer Application Registry (CAR) for the subscription following which a user can access this API and make successful API calls.
|
Events Trigger Notification |
Application Scope |
eventNameCode value |
GitHub Sample Response Payload |
|---|---|---|---|
|
A payroll is submitted |
/payroll/payrollManagement/payrollProcessing/ payrollJobManagement/payrollJobStatus.change |
payroll-processing-job.status.change |
|
|
A checkmate/ quickcalc is submitted |
/payroll/payrollManagement/payrollProcessing/ payrollJobManagement/payrollJobStatus.change |
payroll-output-status-notification.change |
payroll-output-event-notification-checkmate-notification.json |
|
A submitted payroll is completed |
/payroll/payrollManagement/payrollProcessing/ payrollJobManagement/payrollJobStatus.change |
payroll-processing-job.status.change |
payroll-output-event-notification-payroll-complete.json |
|
A submitted payroll resulted in error |
/payroll/payrollManagement/payrollProcessing/ payrollJobManagement/payrollJobStatus.change |
payroll-processing-job.status.change |
payroll-output-event-notification-payroll-edit-errors-found.json |
|
A submitted payroll is in progress |
/payroll/payrollManagement/payrollProcessing/ payrollJobManagement/payrollJobStatus.change |
payroll-output-status-notification.change |
payroll-output-event-notification-payroll-complete-api-in-progress.json |
|
A Continuous payroll is submitted |
/payroll/payrollManagement/payrollProcessing/ payrollJobManagement/payrollJobStatus.change |
payroll-output-status-notification.change |
payroll-output-event-notification-continuous-calc-notification.json |
