API Reference

Retrieves a list of payroll discounts

get
https://{hr_server}/api/companies/v1/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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d{4}-(0[1-9]|1[0-2])$

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

string

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

string
enum

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

Allowed:
integer

Page number for pagination

integer

Number of items per page for pagination

Responses

Updated 22 days ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago

Did this page help you?