Salary Deduction Employee Data Push

POST

/deductions/payroll/{payroll_id}

OperationId:push_employee_deduction

Ontime calls this endpoint to instruct the deduction for one employee on a payroll for a pay period, and to have it paid to Ontime. Each push carries the employee's total deduction for the pay period and replaces any earlier version; a deduction_amount of 0 means nothing is to be deducted.

Respond 200 with is_accepted true when you accept the deduction, or 200 with is_accepted false and a rejection_reason when you do not, including for an unknown payroll or employee. Use other status codes only for authentication, permission and server errors: Ontime treats them as an unknown outcome and asks what you hold with the latest push deduction endpoint.

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

Header Params

Body Params application/jsonRequired

Example

{
    "pay_period_id": "February-26",
    "batch_id": "260210090000123456",
    "version": 2,
    "salary_deduction": {
        "employee_id": "EMP-001",
        "deduction_amount": 4509,
        "currency": "GBP"
    },
    "requested_payments": [
        {
            "payment_information": {
                "payment_reference": "260210090000123456",
                "payment_amount": 4509,
                "payment_account": {
                    "account_number": "12345678",
                    "sort_code": "123456",
                    "account_holder_name": "Ontime Payments Ltd"
                }
            }
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/deductions/payroll/PAYROLL-001' \
--header 'Idempotency-Key: {{$string.uuid}}' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "pay_period_id": "February-26",
    "batch_id": "260210090000123456",
    "version": 2,
    "salary_deduction": {
        "employee_id": "EMP-001",
        "deduction_amount": 4509,
        "currency": "GBP"
    },
    "requested_payments": [
        {
            "payment_information": {
                "payment_reference": "260210090000123456",
                "payment_amount": 4509,
                "payment_account": {
                    "account_number": "12345678",
                    "sort_code": "123456",
                    "account_holder_name": "Ontime Payments Ltd"
                }
            }
        }
    ]
}'

Responses

🟢200Success

application/json

The deduction was accepted or rejected.

Bodyapplication/json

Examples

AcceptedRejected

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

🟠401Unauthorised

🟠403Forbidden

Payroll Information

Latest Salary Deduction Employee Data Push