TOtotalpass
Payroll Discounts

Retrieves a list of payroll discounts

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.

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

Query parameters

reference_monthstring required

Reference month for the payroll discounts in YYYY-MM format (e.g., 2026-07)

company_document_numberstring

Optional filter by specific company document number (e.g., CNPJ) within the company group

employee_type'holder' | 'dependent'

Optional filter by participant type. Options are 'holder' or 'dependent'. If omitted, returns all discounts.

pageinteger

Page number for pagination

per_pageinteger

Number of items per page for pagination

Response

returns the list of payroll discounts with pagination

Example response

{
  "data": [
    {
      "company_id": 20374,
      "company_name": "Acme Corp",
      "reference_month": "2026-07",
      "discounts": [
        {
          "discount_id": 2190029,
          "amount": "150.0",
          "name": "JOHN DOE",
          "document_number": "11122233344",
          "type": "holder"
        }
      ]
    }
  ],
  "meta": {
    "count": 2,
    "last": 1,
    "page": 1,
    "pages": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.