Sign in

7be21448a2b3

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Expense Policies

Search Expense Policies

Endpoint to search ExpensePolicy resources using filtering parameters.

get/business/v2/expense-policies

Query parameters

textstring

A simple text to search in the ExpensePolicy (name or description).

Example:travel

A simple text to search in the ExpensePolicy (name or description).

statusesExpensePolicyStatus[]

The list of ExpensePolicy statuses to search by.

The list of ExpensePolicy statuses to search by.

[
  "ACTIVE"
]
pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3

It indicates the specific page to display (the counter starts from zero).

sinteger

It indicates the number of items per page.

Example:25

It indicates the number of items per page.

d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC

It indicates how the pages are ordered.

propsstring[]

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

[
  "creationTime"
]

Response

The result is an array of ExpensePolicy resources.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "name": "Company Travel Policy",
      "description": "A policy for company travel expenses",
      "policy_url": "https://www.policy.pdf",
      "status": "ACTIVE",
      "creation_time": "2017-06-01T12:48:40Z",
      "last_update": "2017-06-01T12:48:40Z"
    }
  ]
}