API Reference
Log In
API Reference

Allowances list

List all allowances (viáticos) available for a subsidiary. Supports filtering by state and expanding beneficiaries, allowance segments, or documents.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Defaults to v1

Api version

string
required

Id of the selected enterprise

string
required

Id of the selected subsidiary

Query Params
string
enum

Filter allowances by status. Accepts 'pending', 'approved', 'accounted', 'paid', or 'rejected'.

Allowed:
string

Expand related resources. Available options: 'beneficiary', 'allowance_segments', 'documents'. Multiple values can be comma-separated (e.g., 'beneficiary,documents').

integer

A page number within the paginated result set.

integer

Number of results to return per page.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json