Latest Salary Deduction Employee Data Push

Ontime calls this endpoint when it does not know the outcome of a push, for example after a timeout, to find the deduction you hold as accepted for the employee in the pay period. Ontime then records the push as accepted or rejected from what you hold.

When nothing has been accepted for the employee in the pay period, respond 200 with version 0, a null batch_id and a deduction_amount of 0. Respond 404 when the payroll or employee is not known.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

The deduction held as accepted.

Bodyapplication/json

Examples

Holding an accepted deductionNothing accepted

{
    "payroll_id": "PAYROLL-001",
    "pay_period_id": "February-26",
    "version": 2,
    "batch_id": "260210090000123456",
    "salary_deduction": {
        "employee_id": "EMP-001",
        "deduction_amount": 4509,
        "currency": "GBP"
    }
}

🟠401Unauthorised

🟠403Forbidden

🟠404Not Found