---
title: "Retrieve a payslip"
method: GET
path: "/hris/{connection_id}/payslip/{id}"
tags: ["hris", "payslip"]
---

# Retrieve a payslip

`GET /hris/{connection_id}/payslip/{id}`

## Request

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

## Path parameters

- `connection_id` string, required
- `id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Response `200`

Successful

- HrisPayslip
  - `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)
  - `user_id` string: the employee (reference to HrisEmployee)
  - `company_id` string: (reference to HrisCompany)
  - `payment_reference` string
  - `payment_type` 'DIRECT' | 'CHEQUE' | 'CASH'
  - `paid_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `start_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `end_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `currency` string
  - `gross_amount` number
  - `net_amount` number
  - `details` HrisPayslipDetail[]
    - `type` 'EARNING_SALARY' | 'EARNING_OVERTIME' | 'EARNING_TIP' | 'EARNING_BONUS' | 'EARNING_COMMISSION' | 'EARNING_ADJUSTMENT' | 'EARNING' | 'PRETAX_DEDUCTION' | 'PRETAX_DEDUCTION_HEALTH_INSURANCE' | 'PRETAX_DEDUCTION_RETIREMENT' | 'PRETAX_DEDUCTION_HRA' | 'TAX_FEDERAL' | 'TAX_REGION' | 'TAX_LOCAL' | 'POSTTAX_BENEFIT' | 'POSTTAX_GARNISHMENT' | 'REIMBURSEMENT' | 'EARNING_REGULAR' | 'EARNING_DOUBLE_OVERTIME' | 'EARNING_PTO' | 'EARNING_SICK' | 'EARNING_HOLIDAY' | 'EARNING_SEVERANCE' | 'EARNING_REIMBURSEMENT' | 'TAX_SOCIAL_SECURITY' | 'TAX_MEDICARE' | 'TAX_UNEMPLOYMENT' | 'TAX_EMPLOYER' | 'PRETAX_DEDUCTION_HSA' | 'PRETAX_DEDUCTION_FSA' | 'PRETAX_DEDUCTION_DEPENDENT_CARE' | 'PRETAX_DEDUCTION_COMMUTER' | 'PRETAX_DEDUCTION_DENTAL' | 'PRETAX_DEDUCTION_VISION' | 'POSTTAX_DEDUCTION' | 'POSTTAX_RETIREMENT_ROTH' | 'POSTTAX_LOAN_REPAYMENT' | 'EMPLOYER_CONTRIBUTION' | 'PENSION' | 'EARNING_CASH_IN_LIEU'
    - `name` string
    - `description` string
    - `amount` number, required
    - `employee_amount` number
    - `company_amount` number
    - `hours` number
    - `rate_amount` number: pay rate for hourly/unit-based lines
    - `ytd_amount` number: year-to-date amount for this line
    - `is_pre_tax` boolean
    - `is_employer` boolean: true when this line is paid by the employer (employer tax or contribution)
    - `paycode_id` string: the hris_paycode for this line
    - `benefit_id` string
    - `deduction_id` string
    - `original_type` string: integration pay-code label before normalization
  - `deduction` HrisPayslipDeduction: The ID (and optionally name) of the employee deduction (if this detail represents a deduction)
    - `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)
    - `user_id` string: employee ID (reference to HrisEmployee)
    - `company_id` string: (reference to HrisCompany)
    - `benefit_id` string
    - `amount` number: percentage or absolute amount (employee's portion)
    - `type` 'FIXED' | 'PERCENTAGE'
    - `coverage_level` 'EMPLOYEE_ONLY' | 'EMPLOYEE_SPOUSE' | 'EMPLOYEE_CHILD' | 'EMPLOYEE_CHILDREN' | 'EMPLOYEE_FAMILY' | 'FAMILY' | 'OTHER': Level selected by employee (e.g. "FAMILY", "EMPLOYEE_ONLY", or other)
    - `frequency` 'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY': Frequency for this deduction (should always be set, matches IHrisBenefit.frequency)
    - `start_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `end_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `is_active` boolean
    - `notes` string
    - `employer_amount` number: percentage or absolute amount (employer's portion/match)
    - `employer_type` 'PERCENTAGE' | 'FIXED'
    - `max_amount` number: annual maximum employee amount (always money)
    - `paycode_id` string: the hris_paycode (deduction code) this deduction uses
    - `garnishment_type` 'CHILD_SUPPORT' | 'TAX_LEVY' | 'STUDENT_LOAN' | 'CREDITOR' | 'BANKRUPTCY' | 'OTHER': set when this deduction is a court-ordered garnishment
    - `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
  - `payroll_id` string: the hris_payroll (pay run) this payslip belongs to
  - `group_id` string: the pay group (hris_group of type PAY_GROUP) (reference to HrisGroup)
  - `type` 'REGULAR' | 'OFF_CYCLE' | 'BONUS' | 'CORRECTION' | 'TERMINATION' | 'CONTRACTOR'
  - `hours` number: total hours paid on this payslip
  - `employee_tax_amount` number: total taxes withheld from the employee
  - `employer_tax_amount` number: total employer-paid taxes
  - `deduction_amount` number: total employee deductions (pre and post-tax)
  - `employer_contribution_amount` number: total employer benefit contributions
  - `gross_ytd_amount` number: year-to-date gross pay as of this payslip
  - `net_ytd_amount` number: year-to-date net pay as of this payslip
  - `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)