---
title: "List all payrolls"
method: GET
path: "/hris/{connection_id}/payroll"
tags: ["hris", "payroll"]
---

# List all payrolls

`GET /hris/{connection_id}/payroll`

## Request

- Base URL: `http://api.unified.to`
- URL: `http://api.unified.to/hris/{connection_id}/payroll`
- Auth: API key in header `authorization`

## Path parameters

- `connection_id` string, required

## Query parameters

- `limit` number
- `offset` number
- `updated_gte` string, date-time
- `sort` 'name' | 'updated_at' | 'created_at'
- `order` 'asc' | 'desc'
- `query` string
- `user_id` string
- `company_id` string
- `group_id` string
- `type` 'REGULAR' | 'OFF_CYCLE' | 'BONUS' | 'CORRECTION' | 'TERMINATION' | 'CONTRACTOR'
- `start_gte` string
- `end_lt` string
- `fields` string[]
- `raw` string

## Response `200`

Successful

- HrisPayroll[]
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `company_id` string: (reference to HrisCompany)
  - `group_id` string: the pay group (hris_group of type PAY_GROUP) (reference to HrisGroup)
  - `status` 'DRAFT' | 'PENDING' | 'APPROVED' | 'PROCESSING' | 'PAID' | 'FAILED' | 'CANCELLED'
  - `type` 'REGULAR' | 'OFF_CYCLE' | 'BONUS' | 'CORRECTION' | 'TERMINATION' | 'CONTRACTOR'
  - `start_at` string, date-time: pay period start (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `end_at` string, date-time: pay period end (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `paid_at` string, date-time: pay/check date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `approved_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `currency` string
  - `gross_amount` number
  - `net_amount` number
  - `employee_tax_amount` number
  - `employer_tax_amount` number
  - `deduction_amount` number: total employee deductions
  - `employer_contribution_amount` number: total employer benefit contributions
  - `total_cost_amount` number: total company cost/debit for this payroll
  - `user_ids` string[]: employees paid in this payroll
  - `payslip_ids` string[]
  - `metadata` HrisMetadata[]
    - `id` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
    - `slug` string
  - `raw` unknown

---

[API](https://skmtc.dev/unified/apis/unified-to-api-2.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api-2/revisions/7a38bdd7f089?raw)