# Get Employee payroll runs

> Source: https://truto.one/docs/api-reference/unified-hris-api/employeepayrollruns/get/

`GET /unified/hris/employee_payroll_runs/{id}`

Resource: **EmployeePayrollRuns** · API: **Unified HRIS API**

## Supported integrations

Paychex, Workday (partial)

## Path parameters

- **`id`** _(string, required)_
  The ID of the resource.

## Query parameters

- **`integrated_account_id`** _(string, required)_
  The ID of the integrated account to use for the request.
- **`truto_response_format`** _(string)_
  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`.
  Allowed: `unified`, `raw`, `normalized`, `stream`, `debug`
- **`truto_ignore_remote_data`** _(boolean)_
  Excludes the `remote_data` attribute from the response.
- **`truto_exclude_fields`** _(array<string>)_
  Array of fields to exclude from the response.
- **`remote_query`** _(object)_
  Query parameters to pass to the underlying API without any transformations. Refer [this guide](https://truto.one/docs/api-reference/overview/querying#remote-query-parameters) to see how to structure the query parameters.
- **`company`** _(object)_
  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.
- **`company_id`** _(string)_
  Flat alternative to company.id.
- **`employee`** _(object)_
  This represents employee
- **`employee_id`** _(string)_
  Flat alternative to employee.id.

## Response body

- **`id`** _(string, required)_
  The unique identifier for Employee Payroll Runs
- **`employee`** _(string)_
  This represents employee
- **`payroll_run`** _(string)_
  This represents the payroll run
- **`gross_pay`** _(number)_
  This represents the gross pay
- **`net_pay`** _(number)_
  This represents the net pay
- **`start_date`** _(string)_
  This represents the start date
- **`end_date`** _(string)_
  This represents the end date
- **`check_date`** _(string)_
  This represents the check date
- **`earnings`** _(array<object>)_
  This represents the earnings
- **`deductions`** _(array<object>)_
  This represents the deductions
- **`taxes`** _(array<object>)_
  This represents the taxes
- **`created_at`** _(string)_
  This represents the date when the Employee Payroll Runs was created
- **`updated_at`** _(string)_
  This represents the date when the Employee Payroll Runs was updated
- **`remote_data`** _(object)_
  Raw data returned from the remote API call.

## Code examples

### Truto CLI

```bash
truto unified hris employeepayrollruns '<resource_id>' \
  -m get \
  -a '<integrated_account_id>' \
  -o json
```

### Truto TS SDK

```typescript
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);
```

### Truto Python SDK

```python
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

```bash
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'
```

### JavaScript

```javascript
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);
```

### Python

```python
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())
```