SOsoldo
Requests

Search Requests

Changed on

Endpoint to search Requests.

get/business/v2/requests

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

statusRequestStatus[]

The status of the Request.

paymentMethod'TEMPORARY_CARD' | 'BANK_TRANSFER'

The payment method of the Request.

textstring

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

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 Requests.

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": "Supplier name",
      "description": "Example description",
      "requester": "XMPL1234-000001",
      "amount": 10.25,
      "creation_time": "2017-06-01T12:48:40Z",
      "last_update_time": "2017-06-01T12:48:40Z"
    }
  ]
}

Changes

  • 9fa34523c5a0Revision changes
    • info

      added the new optional query request parameter fromDate

    • info

      added the new optional query request parameter toDate

  • 7be21448a2b3Revision changes
    • breaking

      removed the enum value CARD from the query request parameter paymentMethod

    • warning

      added the new TEMPORARY_CARD enum value to the // response property for the response status

    • info

      added the new enum value TEMPORARY_CARD to the query request parameter paymentMethod

    • info

      removed the CARD enum value from the // response property for the response status