Payroll Information

GET

/payrolls/{payroll_id}

OperationId:get_payroll_information

Called by Ontime to retrieve information about the Payroll specified by the payroll_id.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Indicates the request was successfully processed by the server and a valid response is included in the body.

Bodyapplication/json

Example

{
    "payroll_response": {
        "payroll": {
            "id": "e886b6bd-a98f-49df-80fa-f8e4b882b823",
            "payment_run_frequency": "four_weekly",
            "pay_dates": [
                {
                    "pay_date": "2026-09-29T20:01:16.581Z",
                    "payroll_cutoff_date": "2027-01-25T11:25:22.426Z"
                },
                {
                    "pay_date": "2026-05-14T05:16:12.444Z",
                    "payroll_cutoff_date": "2026-11-10T06:47:18.758Z"
                }
            ]
        }
    }
}

🟠400

🟠401Unauthorised

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🟠422Unprocessable Entity

Salary Deduction Enablement

Salary Deduction Employee Data Push