Sign in

7be21448a2b3

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Requests

Get Request

Endpoint to get an Request by ID. There are 3 types of request:GOODS_OR_SERVICES, FUNDS,TRIP.

get/business/v2/requests/{requestId}

Path parameters

requestIdstring required

The Request ID.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7

Response

The returned resource is a single Request.

type'GOODS_OR_SERVICES' | 'FUNDS' | 'TRIP'
idstring

The Request ID (sortable: no).

namestring

The name of the Request (sortable: no).

descriptionstring

The description of the Request (sortable: no).

requesterstring

The ID of the User that makes the Request (sortable: no).

request_process_idstring

The ExpenseReviewProcess ID of the Request (sortable: no).

status'APPROVED' | 'DECLINED' | 'PENDING' | 'IDLE' | 'DELETED'
amountnumber

The amount of the Request (sortable: no).

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
has_attachmentsboolean

It determines whether the Request has one or more attachments (sortable: no).

creation_timestring

The date and time when the Request was created (sortable: yes).

last_update_timestring

The date and time when the Request was last updated (sortable: yes).

notestring

The comments of the Request (sortable: no).

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "name": "Supplier name",
  "description": "Example description",
  "requester": "XMPL1234-000001",
  "request_process_id": "135fdb6c-2e77-4fc0-a79f-2453fde75ef7",
  "amount": 10.25,
  "creation_time": "2017-06-01T12:48:40Z",
  "last_update_time": "2017-06-01T12:48:40Z",
  "note": "Requester note",
  "review_timeline": [
    {
      "step_number": 2,
      "date": "2025-12-24T23:00:00Z",
      "reviewer_info": [
        {
          "id": "XMPL1234-000003",
          "name": "JOHNDOE"
        }
      ]
    }
  ]
}