---
title: "Retrieves a list of payroll discounts"
method: GET
path: "/api/companies/v1/payroll_discounts"
tags: ["Payroll Discounts"]
---

# Retrieves a list of payroll discounts

`GET /api/companies/v1/payroll_discounts`

## Request

- Base URL: `https://hr.totalpass.com`
- URL: `https://hr.totalpass.com/api/companies/v1/payroll_discounts`
- Auth: API key in header `x-api-key`

This endpoint retrieves a comprehensive list of payroll discounts associated with a specific company group and reference month. It supports filtering by company document number and employee type (holder or dependent), as well as pagination for efficient data management.

## Query parameters

- `reference_month` string, required
- `company_document_number` string
- `employee_type` 'holder' | 'dependent'
- `page` integer
- `per_page` integer

## Response `200`

returns the list of payroll discounts with pagination

- object
  - `data` object[]
    - `company_id` integer
    - `company_name` string
    - `reference_month` string
    - `discounts` object[]
      - `discount_id` integer
      - `amount` string
      - `name` string
      - `document_number` string
      - `type` string
  - `meta` object
    - `count` integer
    - `last` integer
    - `next` integer, nullable
    - `page` integer
    - `pages` integer
    - `prev` integer, nullable

## Other responses

- `400`: returns bad request when query parameters are invalid
- `401`: returns unauthorized when api key is invalid
- `404`: returns not found when no data is found for the given company or reference month
- `422`: returns unprocessable entity on unexpected errors

---

[API](https://skmtc.dev/totalpass/apis/api-companies.md) - [All operations](https://skmtc.dev/totalpass/apis/api-companies/llms.txt) - [OpenAPI document](https://skmtc.dev/totalpass/apis/api-companies/revisions/62259afde09a?raw)