Home
Home
  1. Salary Deduction
  • Salary Deduction
    • Welcome
    • Getting started
      • Availability and Onboarding
        • Light Availability Check
        • Full Availability Check
        • Onboarding
      • Salary Deduction
        • Deduction Instruction
        • Re-running Payroll
        • Deduction Payments and Reconciliation
        • Changes to Employee Status
    • API Reference
      • Authentication
      • Idempotency
      • Webhooks
        • Webhooks
      • Salary Deduction
        • Salary Deduction Data Request
        • Salary Deduction Confirmation Submission
    • Schemas
      • Availability Check
        • Light Availability Check Response
        • Light Availability Check Request
        • Full Availability Check Response
        • Full Availability Check Request
      • Core
        • ProblemDetails
      • Deduction Instructions
        • Salary Deduction
        • Confirmation Deduction Response
        • Salary Deduction Enablement Response
        • Employee Deduction Push Response
        • Employee Deduction Push Request
        • Latest Employee Deduction Push Response
      • Payment Account
        • Payment Account
        • Payment Information
      • Payroll
        • Salary Deduction Confirmation Data Submission
        • Salary Deduction Data Response
        • Payroll
        • Employee Payroll
        • Employment
        • Pay Date
        • Salary Deduction Enablement Request
      • Webhooks
        • Employee Update Payload
        • WebHook
  • Payroll Provider API Prototypes
    • Light Availability Check
      POST
    • Full Availability Check
      POST
    • Salary Deduction Enablement
      POST
    • Payroll Information
      GET
    • Salary Deduction Employee Data Push
      POST
    • Latest Salary Deduction Employee Data Push
      GET
  1. Salary Deduction

Changes to Employee Status

About Changes to Employee Status#

From time to time Employees leave their Employer or move to another payroll. If a Payroll Provider notifies Ontime when this happens, Ontime can help Employees and Billers to manage future payments more smoothly.

Assumptions and prerequisites#

The Employee is enabled for Salary Deduction on the Payroll.
1

Payroll Provider sends a webhook#

Requirements
The Payroll Provider MAY send Ontime a Webhook when an enabled Employee:
leaves their Employer (employee_left), or
moves to another Payroll (employee_payroll_moved).
Send the webhook once the change has taken effect, not when it is first scheduled. If a request fails, retry it with the same event_id.
WebHook

API Documentation
Webhooks
2

Ontime Updates Employee data#

Requirements
On receipt of the webhook Ontime MUST call the Payroll Provider's Full Availability Check to retrieve the Employee's current details. Ontime stores the new Employee data and processes updates as required.
Previous
Deduction Payments and Reconciliation
Next
Authentication