Client APISpend Requests

Create a spend request

Create a spend request.

Create a spend request for a hirer. Spend requests are pre-contract funding requests that flow through approvals. You can include custom fields configured on your client account and optionally set an external ID for idempotency and later lookup.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
hirerstringRequired
The identifier or the email address of the hirer creating the spend request.
titlestringRequired<=100 characters
The title of the spend request.
descriptionstringRequired<=100000 characters
A detailed description of the spend request.
amountstringRequiredformat: "decimal"
The amount of money requested.
amount_typeenumRequired
The type of the amount requested. * `DAY_RATE` - Day rate * `TOTAL` - Total
Allowed values:
currencyenumRequired
The currency in which the amount is specified. * `AUD` - $ AUD * `CAD` - $ CAD * `CHF` - ₣ CHF * `CZK` - Kč CZK * `DKK` - kr DKK * `EUR` - € EUR * `GBP` - £ GBP * `HKD` - $ HKD * `NOK` - kr NOK * `NZD` - $ NZD * `PLN` - zł PLN * `SEK` - kr SEK * `SGD` - $ SGD * `AED` - د.إ AED * `USD` - $ USD * `ZAR` - R ZAR
custom_fieldslist of objectsOptional
An array of custom fields specific to the spend request.
external_idstringOptionalDefaults to
An external identifier for the spend request, optional.
spend_request_configurationstringOptional<=40 charactersDefaults to
The identifier of the configuration to create the spend request against.

Response

dataobject
The spend request object. This object represents a request to commit spend on the YunoJuno platform.