List Payroll runs
/unified/hris/payroll_runs
Query Parameters
Refer Specifying query parameters in Truto APIs
3 supported1 required3 notes
The Deel legal entity, referencing companies.id. Required: Deel scopes this data per legal entity.
The company to use, referencing companies.id. Optional: when omitted the account's company is looked up automatically. The request fails if the account can see more than one company and none is given.
The Paychex company to use, referencing companies.id (Paychex companyId). 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 request fails with a 400 when no company can be resolved (the credential sees more than one company with API permission, none, or 100 or more companies).
Flat alternative to company.id.
3 supported
This represents the start date
2 supported2 notes
Return payroll runs from this date (Deel date_start, YYYY-MM-DD). Deel needs a start and an end at most one year apart, so both are always sent: with neither date the last 365 days are returned, with one date the other is set 364 days away, and a longer range is cut to one year from start_date. Deel rejects a start before 1 January five years ago; to read older or longer history, walk year-sized windows.
Return pay periods starting on or after this date. Accepts an ISO date-time string, or an object with gte/gt.
This represents the end date
2 supported2 notes
Return payroll runs up to this date (Deel date_end, YYYY-MM-DD). Deel rejects an end after 31 December five years ahead. See start_date for the one-year window.
Return pay periods ending on or before this date. Accepts an ISO date-time string, or an object with lte/lt.
Filter by run state. open = Paychex INITIAL/ENTRY, closed = COMPLETED/COMPLETED_BY_MEC; the other values match the Paychex status of the same name.
closedopenprocessingreissuedreleasedreversed
1 supported
A date (YYYY-MM-DD): returns runs whose period starts or ends on that date.
1 supported
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. data is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }, where truto_excerpt is the leading bytes of that body. The same applies to a string requestOptions.body. null for static responses or when truto_skip_api_call=true.
The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.
List of Payroll runs
The unique identifier for payrollruns
4 supported
This represents the check date
2 supported
This represents the date when the payrollruns was created
1 supported
This represents the end date
4 supported
Raw data returned from the remote API call.
This represents the run state
4 supported
This represents the run type
4 supported
This represents the start date
4 supported
This represents the date when the payrollruns was updated
1 supported
truto unified hris payrollruns \
-a '<integrated_account_id>' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'hris',
'payrollruns',
{ 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():
async for item in truto_api.unified_api.list(
"hris",
"payrollruns",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/hris/payroll_runs?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/payroll_runs?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/payroll_runs"
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())