v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Expense Reports

Search Expense Reports

Endpoint to search ExpenseReport using filtering parameters.

get/business/v2/expense-reports

Query parameters

numberstring

The ExpenseReport number.

Example:NR9912098

The ExpenseReport number.

trxOwnerIdstring

The ID of the User who made the expenses included in the ExpenseReport.

Example:XMPL1234-000003

The ID of the User who made the expenses included in the ExpenseReport.

trxDateFromstring date-time

The beginning of the period of the search fromDate included (i.e. greater than or equal to) (Formats: yyyy-MM-dd, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ssZ).

trxDateTostring date-time

The beginning of the period of the search fromDate included (i.e. greater than or equal to) (Formats: yyyy-MM-dd, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ssZ).

statusExpenseReportStatus[]

The ExpenseReport status.

The ExpenseReport status.

typeExpenseReportType[]

The ExpenseReport type.

The ExpenseReport type.

toReimburseboolean

It determines whether only reports with or without an amount to be reimbursed should be returned.

Example:true

It determines whether only reports with or without an amount to be reimbursed should be returned.

exportedDatestring date-time

The date when the ExpenseReport got exported (Formats: yyyy-MM-dd, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ssZ).

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 containing ExpenseReport.

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"
    }
  ]
}