Skip to content
GET /unified/hris/employee_payroll_runs/{id}

Partial response — use the "get" endpoint for the full object.

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

companyobject

Optional. The Paychex company (companies.id), used only to fill start_date/end_date on the check from its pay period. A company pinned on the connection (company_id in the integrated account context) always wins and this parameter is then ignored. Otherwise, when omitted, the credential's companies are looked up and the single company with API permission is used. The record itself is read by id whatever company is given; when no company resolves, the call still succeeds without that data.

1 supported
Paychex
supported
idstring
required
company_idstring

Flat alternative to company.id.

1 supported
Paychex
supported
employeeobject

This represents employee

References: Employees → id
2 supported2 required2 notes
Paychex
required

The employee (employees.id, Paychex workerId) the check belongs to. Required: Paychex addresses checks per worker.

Workday
required

The employee (employees.id, a Workday worker WID, or a reference such as Employee_ID=21001). Required: Workday only exposes this data per worker. Workday pay slips do not name the worker, so each record's employee is this value when it is the worker WID (employees.id) and is left empty for a reference id such as Employee_ID=21001 or me.

idstring
required
employee_idstring

Flat alternative to employee.id.

2 supported
Paychex
supported
Workday
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

idstring
required·

The unique identifier for Employee Payroll Runs

2 supported
Paychex
supported
Workday
supported
check_datestring · date-time

This represents the check date

2 supported
Paychex
supported
Workday
supported
created_atstring · date-time

This represents the date when the Employee Payroll Runs was created

deductionsobject[]

This represents the deductions

earningsobject[]

This represents the earnings

employeestring

This represents employee

References: Employees → id
2 supported
Paychex
supported
Workday
supported
end_datestring · date-time

This represents the end date

1 supported
Paychex
supported
gross_paynumber

This represents the gross pay

2 supported
Paychex
supported
Workday
supported
net_paynumber

This represents the net pay

2 supported
Paychex
supported
Workday
supported
payroll_runstring

This represents the payroll run

References: PayrollRuns → id
1 supported
Paychex
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

start_datestring · date-time

This represents the start date

1 supported
Paychex
supported
taxesobject[]

This represents the taxes

updated_atstring · date-time

This represents the date when the Employee Payroll Runs was updated

truto unified hris employeepayrollruns '<resource_id>' \
  -m get \
  -a '<integrated_account_id>' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.get(
  'hris',
  'employeepayrollruns',
  '<resource_id>',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.get(
        "hris",
        "employeepayrollruns",
        "<resource_id>",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X GET 'https://api.truto.one/unified/hris/employee_payroll_runs/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/hris/employee_payroll_runs/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/hris/employee_payroll_runs/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())