Allowances list

List all allowances (viáticos) available for a subsidiary.

Expandable resources (pass to ?expand=):

OptionWhat it adds
beneficiaryReplaces beneficiary_id with the beneficiary's full user object.
cost_centerReplaces cost_center_id with the full cost_center object.
allowance_segmentsAdds the per-fare allowance_segments breakdown (omitted unless expanded).
documentsAdds the supporting documents with presigned download URLs (omitted unless expanded).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Id of the selected enterprise

string
required

Id of the selected subsidiary

Query Params
cost_center_id
array of uuids

Filter allowances by one or many cost center ids (comma-separated)

cost_center_id
expand
array of strings

Related resources to inline. Combine multiple with commas, e.g. ?expand=beneficiary,cost_center. Available options: beneficiary, cost_center, allowance_segments, documents. By default these come back as <field>_id references (or are omitted); expanding replaces them with the full nested object.

expand
Allowed:
fare_internal_ids
array of strings or null

Filter allowances by multiple fare internal_ids (comma-separated)

fare_internal_ids
integer

A page number within the paginated result set.

integer

Number of results to return per page.

string
enum
  • rejected - Rejected
  • pending - Pending
  • approved - Approved
  • accounted - Accounted
  • paid - Paid
Allowed:
Responses

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