v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Payroll Runs

Get Employee Details for a Payroll Run

Gets the employee details for a payroll run

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage payroll runs (payroll)	View payroll runs (payroll_run:read)	-

get/v1/payroll-runs/{payroll_run_id}/employee-details

Path parameters

payroll_run_idstring required

Payroll run ID

Query parameters

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "data": {
    "employee_details": [
      {
        "base_salary": {
          "amount": 1000,
          "currency": "USD"
        },
        "benefits": {
          "amount": 100,
          "currency": "USD"
        },
        "deductions": {
          "amount": 200,
          "currency": "USD"
        },
        "employer_costs": {
          "amount": 100,
          "currency": "USD"
        },
        "expenses": {
          "amount": 100,
          "currency": "USD"
        },
        "full_name": "John Doe",
        "gross_pay": {
          "amount": 1000,
          "currency": "USD"
        },
        "incentives": {
          "amount": 100,
          "currency": "USD"
        },
        "net_pay": {
          "amount": 800,
          "currency": "USD"
        },
        "other": {
          "amount": 100,
          "currency": "USD"
        },
        "payslip_id": "123e4567-e89b-12d3-a456-426614174000",
        "total_cost": {
          "amount": 1000,
          "currency": "USD"
        }
      }
    ]
  }
}