SOsoldo
Business Trips

Search BusinessTrips

Changed on

Endpoint to find BusinessTrips using filtering parameters.

get/business/v2/business-trips

Request

Query parameters

fromDatestring 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).

toDatestring date-time

The end of the period of the search toDate included (i.e. less than) (Formats: yyyy-MM-dd, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ssZ).

statusBusinessTripPurchaseStatus[]

The status of the Purchase.

The status of the BusinessTrip.

dateType'CREATION_TIME' | 'COMPLETED_TIME'

It determines the date to be considered for fromDate and toDate parameters.

Example:COMPLETED_TIME
travellerUserIdstring[]

The ID of the User that is travelling with the BusinessTrip.

textstring

A simple text to search in the BusinessTrip data.

Example:something
pinteger

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

Example:3
sinteger

It indicates the number of items per page.

Example:25
d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC
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.

[
  "creationTime"
]

Response

The result is an array containing BusinessTrips.

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": "There and back again",
      "description": "EXAMPLE BUSINESS TRIP DESCRIPTION",
      "author_user_id": "XMPL1234-000001",
      "approver_user_id": "XMPL1234-000003",
      "traveller_user_id": "XMPL1234-000003",
      "traveller_card_id": "2d65bd5e-3fdf-4002-b166-bde7fb8863fa",
      "total_amount": 10.25,
      "wallet_id": "2d65bd5e-3fdf-4002-b166-bde7fb8863fa",
      "creation_time": "2017-06-01T12:48:40Z",
      "last_update_time": "2017-06-01T12:48:40Z"
    }
  ]
}

Changes

  • 7be21448a2b3Revision changes
    • info

      for the query request parameter fromDate, the type was generalized from no type to string, and format from no format to date-time

    • info

      for the query request parameter toDate, the type was generalized from no type to string, and format from no format to date-time

  • ffea6d02a4f8Revision changes
    • info

      endpoint added