Skip to content

Ramp: Unified request schemas (part 5)

47 Ramp schemas with complete fields and constraints.

← Unified request operations · All schemas

Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

FieldTypePresenceDescription and constraints
$objectRoot
accounting_auto_mark_ready_rule_enabledbooleanRequired within parent
accounting_rulesarrayRequired within parentRead only: true
accounting_rules[]ModelEach itemExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION accounting auto mark ready rule enabled, accounting rules, approval chain data, approval events, archive date, available actions, available actions v2, blank canvas execution id, default transaction memo, members, spending restrictions, submission policy id, travel metadata, trip accounting rules item
amount_detailsModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details
Read only: true
categories_blacklistarrayRequired within parentRead only: true
categories_blacklist[]JSONEach item
categories_blacklist[] (anyOf 1)integerAlternative
categories_blacklist[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
categories_whitelistarrayRequired within parentRead only: true
categories_whitelist[]JSONEach item
categories_whitelist[] (anyOf 1)integerAlternative
categories_whitelist[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
is_shareablebooleanRequired within parent
lock_dateJSONRequired within parent
lock_date (anyOf 1)stringAlternativeFormat: date-time
lock_date (anyOf 2)nullAlternative
payment_restrictionsModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled
Read only: true
post_spend_approval_instance_policyModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name
Read only: true
spend_eligibility_starts_atJSONRequired within parent
spend_eligibility_starts_at (anyOf 1)stringAlternativeFormat: date-time
spend_eligibility_starts_at (anyOf 2)nullAlternative
spend_frequencystringRequired within parentKnown values: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
submission_policyModelRequired within parentExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY submission policy
Read only: true
vendor_blacklistarrayRequired within parentRead only: true
vendor_blacklist[]JSONEach item
vendor_blacklist[] (anyOf 1)integerAlternative
vendor_blacklist[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
vendor_whitelistarrayRequired within parentRead only: true
vendor_whitelist[]JSONEach item
vendor_whitelist[] (anyOf 1)integerAlternative
vendor_whitelist[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled, Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY submission policy, Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION accounting auto mark ready rule enabled, accounting rules, approval chain data, approval events, archive date, available actions, available actions v2, blank canvas execution id, default transaction memo, members, spending restrictions, submission policy id, travel metadata, trip accounting rules item

Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY submission policy

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentFormat: uuid
is_defaultbooleanRequired within parent
namestringRequired within parent

Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata

FieldTypePresenceDescription and constraints
$objectRoot
originJSONRequired within parent
origin (anyOf 1)ModelAlternativeExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata travel location
origin (anyOf 2)nullAlternative
payment_methodstringRequired within parentKnown values: NONE, SPEND_ALLOCATION
spend_estimate_line_itemsarrayRequired within parent
spend_estimate_line_items[]ModelEach itemExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata spend estimate line items item
travel_locationModelRequired within parentExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata travel location
travel_request_typestringRequired within parentKnown values: GROUP, INDIVIDUAL
trip_end_datestringRequired within parentFormat: date
trip_start_datestringRequired within parentFormat: date

Referenced models: Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata travel location, Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata spend estimate line items item

Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata spend estimate line items item

FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata spend estimate line items item amount
Read only: true
categorystringRequired within parentKnown values: CUSTOM, FLIGHT, LODGING, PER_DIEM
idstringRequired within parent
labelstringRequired within parent

Referenced models: Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata spend estimate line items item amount

Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata spend estimate line items item amount

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternative
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parent

Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata travel location

FieldTypePresenceDescription and constraints
$objectRoot
cityJSONOptional
city (anyOf 1)stringAlternative
city (anyOf 2)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternative
country (anyOf 2)nullAlternative
latJSONOptional
lat (anyOf 1)JSONAlternative
lat (anyOf 1) (anyOf 1)numberAlternative
lat (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
lat (anyOf 2)nullAlternative
lngJSONOptional
lng (anyOf 1)JSONAlternative
lng (anyOf 1) (anyOf 1)numberAlternative
lng (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
lng (anyOf 2)nullAlternative
stateJSONOptional
state (anyOf 1)stringAlternative
state (anyOf 2)nullAlternative
timezonestringOptional
trip_destination_idJSONOptional
trip_destination_id (anyOf 1)stringAlternative
trip_destination_id (anyOf 2)nullAlternative

Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip trip id, trip name

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
trip_namestringRequired within parent

List attachments on a procurement request — response body — item

FieldTypePresenceDescription and constraints
$objectRoot
attachment_typestringRequired within parentType of attachment. PURCHASE_ORDER attachments are included in the purchase order PDF sent to the vendor; SPEND_REQUEST attachments are supporting documents on the request.
Known values: PURCHASE_ORDER, SPEND_REQUEST
created_atstringRequired within parentTime at which the attachment was uploaded.
Format: date-time
download_urlJSONRequired within parent
download_url (anyOf 1)stringAlternativePre-signed URL to download the attachment. Valid for 1 hour.
Read only: true
download_url (anyOf 2)nullAlternative
filenamestringRequired within parentOriginal filename of the uploaded attachment.
Read only: true
idstringRequired within parentUnique identifier of the attachment.
Format: uuid
sourcestringRequired within parentWhere the attachment originated from.
Known values: DEVELOPER_API, DOCUSIGN, IRONCLAD, RAMP
unified_request_idstringRequired within parentUnique identifier of the request this attachment belongs to.
Format: uuid
Read only: true
uploaded_by_user_idJSONRequired within parent
uploaded_by_user_id (anyOf 1)stringAlternativeUnique identifier of the user who uploaded the attachment.
Format: uuid
uploaded_by_user_id (anyOf 2)nullAlternative

List unified requests with pagination — response body — item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"SPEND_REQUEST": "#/components/schemas/UnifiedSpendRequest"}, "propertyName": "unified_request_type"}
$ (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item value

Referenced models: List unified requests with pagination — response body — item value

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
$ (allOf 2)objectAll variants apply
$ (allOf 2).existing_spend_allocation_idJSONRequired within parent
$ (allOf 2).existing_spend_allocation_id (anyOf 1)stringAlternativeRead only: true
$ (allOf 2).existing_spend_allocation_id (anyOf 2)nullAlternative
$ (allOf 2).existing_spend_requestJSONRequired within parent
$ (allOf 2).existing_spend_request (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION existing spend request amount details, id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type
$ (allOf 2).existing_spend_request (anyOf 2)nullAlternative
$ (allOf 2).is_shareablebooleanRequired within parent
$ (allOf 2).issuance_parametersJSONRequired within parent
$ (allOf 2).issuance_parameters (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION issuance parameters is default allocation, is physical, is temporary edit requested, requesting physical card, temporary limit reset date, temporary limit start date
Read only: true
$ (allOf 2).issuance_parameters (anyOf 2)nullAlternative
$ (allOf 2).lifecycle_presetJSONRequired within parent
$ (allOf 2).lifecycle_preset (anyOf 1)stringAlternativeThe request's persisted lifecycle preset, or null when no preset is configured.
Known values: SINGLE_USE
$ (allOf 2).lifecycle_preset (anyOf 2)nullAlternative
$ (allOf 2).lock_dateJSONOptional
$ (allOf 2).lock_date (anyOf 1)stringAlternativeFormat: date-time
$ (allOf 2).lock_date (anyOf 2)nullAlternative
$ (allOf 2).lock_displayJSONRequired within parent
$ (allOf 2).lock_display (anyOf 1)stringAlternativeRead only: true
$ (allOf 2).lock_display (anyOf 2)nullAlternative
$ (allOf 2).payment_restrictionsJSONRequired within parent
$ (allOf 2).payment_restrictions (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled
Read only: true
$ (allOf 2).payment_restrictions (anyOf 2)nullAlternative
$ (allOf 2).post_spend_approval_instance_policyJSONRequired within parent
$ (allOf 2).post_spend_approval_instance_policy (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name
Read only: true
$ (allOf 2).post_spend_approval_instance_policy (anyOf 2)nullAlternative
$ (allOf 2).predictionJSONRequired within parent
$ (allOf 2).prediction (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION prediction explanations, feedback, overall decision, prediction id, single sentence summary, system string rationale
Read only: true
$ (allOf 2).prediction (anyOf 2)nullAlternative
$ (allOf 2).relative_lock_duration_countJSONRequired within parent
$ (allOf 2).relative_lock_duration_count (anyOf 1)JSONAlternative
$ (allOf 2).relative_lock_duration_count (anyOf 1) (anyOf 1)integerAlternative
$ (allOf 2).relative_lock_duration_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).relative_lock_duration_count (anyOf 2)nullAlternative
$ (allOf 2).relative_lock_duration_unitJSONRequired within parent
$ (allOf 2).relative_lock_duration_unit (anyOf 1)stringAlternativeKnown values: DAYS, MONTHS, WEEKS, YEARS
$ (allOf 2).relative_lock_duration_unit (anyOf 2)nullAlternative
$ (allOf 2).restricted_request_typestringRequired within parentKnown values: SPEND_ALLOCATION
Default: SPEND_ALLOCATION
$ (allOf 2).resulting_spend_allocation_idJSONRequired within parent
$ (allOf 2).resulting_spend_allocation_id (anyOf 1)stringAlternativeRead only: true
$ (allOf 2).resulting_spend_allocation_id (anyOf 2)nullAlternative
$ (allOf 2).spend_allocationJSONRequired within parent
$ (allOf 2).spend_allocation (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION spend request type: SPEND LIMIT, unified spend request type: PROCUREMENT SPEND ALLOCATION spend allocation id, payment restrictions, submission policy
$ (allOf 2).spend_allocation (anyOf 2)nullAlternative
$ (allOf 2).spend_eligibility_starts_atJSONOptional
$ (allOf 2).spend_eligibility_starts_at (anyOf 1)stringAlternativeFormat: date-time
$ (allOf 2).spend_eligibility_starts_at (anyOf 2)nullAlternative
$ (allOf 2).spend_request_typestringRequired within parentKnown values: SPEND_LIMIT
Default: SPEND_LIMIT
$ (allOf 2).spending_restrictionsModelOptionalExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION spending restrictions
Read only: true
$ (allOf 2).travel_metadataJSONRequired within parent
$ (allOf 2).travel_metadata (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL spend request type: TRAVEL, unified spend request type: TRAVEL travel metadata
Read only: true
$ (allOf 2).travel_metadata (anyOf 2)nullAlternative
$ (allOf 2).unified_spend_request_typestringRequired within parentKnown values: SPEND_ALLOCATION
Default: SPEND_ALLOCATION

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION issuance parameters is default allocation, is physical, is temporary edit requested, requesting physical card, temporary limit reset date, temporary limit start date, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION existing spend request amount details, id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION spend request type: SPEND LIMIT, unified spend request type: PROCUREMENT SPEND ALLOCATION spend allocation id, payment restrictions, submission policy, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION spending restrictions, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION prediction explanations, feedback, overall decision, prediction id, single sentence summary, system string rationale, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL spend request type: TRAVEL, unified spend request type: TRAVEL travel metadata

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
$ (allOf 2)objectAll variants apply
$ (allOf 2).amount_detailsModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details
Read only: true
$ (allOf 2).spend_frequencyJSONRequired within parent
$ (allOf 2).spend_frequency (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
$ (allOf 2).spend_frequency (anyOf 2)nullAlternative

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

FieldTypePresenceDescription and constraints
$objectRoot
dataJSONOptional
data (anyOf 1)integerAlternative
data (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
frequencystringRequired within parentKnown values: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION existing spend request amount details, id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type

FieldTypePresenceDescription and constraints
$objectRoot
amount_detailsModelOptionalExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details
Read only: true
idstringOptionalFormat: uuid
is_shareablebooleanOptional
lock_dateJSONOptional
lock_date (anyOf 1)stringAlternativeFormat: date-time
lock_date (anyOf 2)nullAlternative
post_spend_approval_instance_policyJSONRequired within parent
post_spend_approval_instance_policy (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name
Read only: true
post_spend_approval_instance_policy (anyOf 2)nullAlternative
spend_eligibility_starts_atJSONOptional
spend_eligibility_starts_at (anyOf 1)stringAlternativeFormat: date-time
spend_eligibility_starts_at (anyOf 2)nullAlternative
spend_frequencyJSONOptional
spend_frequency (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
spend_frequency (anyOf 2)nullAlternative
unified_request_idJSONRequired within parent
unified_request_id (anyOf 1)stringAlternativeFormat: uuid
Read only: true
unified_request_id (anyOf 2)nullAlternative
unified_spend_request_typestringRequired within parentKnown values: APPROVAL_ONLY, FUND_UNARCHIVE, PROCUREMENT_SPEND_ALLOCATION, PURCHASE_ORDER, SPEND_ALLOCATION, TRAVEL
Read only: true

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION issuance parameters is default allocation, is physical, is temporary edit requested, requesting physical card, temporary limit reset date, temporary limit start date

FieldTypePresenceDescription and constraints
$objectRoot
is_default_allocationbooleanOptionalApproval sets the owner's default spend allocation (Ramp Card) limit instead of creating new funds. With requesting_physical_card, approval ships a physical primary card; otherwise it issues a virtual primary card.
is_physicalbooleanOptional
is_temporary_edit_requestedbooleanOptional
requesting_physical_cardbooleanOptional
temporary_limit_reset_dateJSONOptional
temporary_limit_reset_date (anyOf 1)stringAlternativeRequested time to restore the original limit, if specified.
Format: date-time
temporary_limit_reset_date (anyOf 2)nullAlternative
temporary_limit_start_dateJSONOptional
temporary_limit_start_date (anyOf 1)stringAlternativeRequested start time of the temporary limit increase, if specified.
Format: date-time
temporary_limit_start_date (anyOf 2)nullAlternative

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled

FieldTypePresenceDescription and constraints
$objectRoot
primary_card_enabledbooleanOptionalDefault: false
reimbursements_enabledbooleanOptionalDefault: false
virtual_card_enabledbooleanOptionalDefault: true

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
is_defaultbooleanRequired within parent
nameJSONRequired within parent
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION prediction explanations, feedback, overall decision, prediction id, single sentence summary, system string rationale

FieldTypePresenceDescription and constraints
$objectRoot
explanationsarrayOptionalPer-bullet rationale strings explaining the prediction, produced by the policy agent's justification stage. Includes policy-citation-backed bullets and non-policy context bullets. Empty if the prediction predates the justification stage.
explanations[]stringEach item
feedbackarrayOptional
feedback[]ModelEach itemExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION prediction explanations, feedback, overall decision, prediction id, single sentence summary, system string rationale feedback item
overall_decisionstringRequired within parent
prediction_idstringRequired within parent
single_sentence_summarystringOptionalDeprecated: use explanations instead.
Default:
system_string_rationalestringRequired within parentDeprecated: use explanations instead. The single synthesized rationale string from the policy agent's evaluation stage.

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION prediction explanations, feedback, overall decision, prediction id, single sentence summary, system string rationale feedback item

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION prediction explanations, feedback, overall decision, prediction id, single sentence summary, system string rationale feedback item

FieldTypePresenceDescription and constraints
$objectRoot
acting_user_uuidstringRequired within parent
created_atstringRequired within parentFormat: date-time
feedback_commentJSONRequired within parent
feedback_comment (anyOf 1)stringAlternative
feedback_comment (anyOf 2)nullAlternative
feedback_typestringRequired within parentType of feedback provided by the user.
Known values: negative, positive

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION spending restrictions

FieldTypePresenceDescription and constraints
$objectRoot
intervalstringRequired within parentKnown values: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
$ (allOf 2)objectAll variants apply
$ (allOf 2).existing_spend_requestJSONRequired within parent
$ (allOf 2).existing_spend_request (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type
$ (allOf 2).existing_spend_request (anyOf 2)nullAlternative
$ (allOf 2).spend_request_typestringRequired within parentKnown values: APPROVAL_ONLY
Default: APPROVAL_ONLY
$ (allOf 2).unified_spend_request_typestringRequired within parentKnown values: APPROVAL_ONLY
Default: APPROVAL_ONLY

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
$ (allOf 2)objectAll variants apply
$ (allOf 2).blank_canvas_execution_idJSONRequired within parent
$ (allOf 2).blank_canvas_execution_id (anyOf 1)stringAlternativeFormat: uuid
Read only: true
$ (allOf 2).blank_canvas_execution_id (anyOf 2)nullAlternative
$ (allOf 2).earliest_due_dateJSONRequired within parent
$ (allOf 2).earliest_due_date (anyOf 1)stringAlternativeFormat: date-time
Read only: true
$ (allOf 2).earliest_due_date (anyOf 2)nullAlternative
$ (allOf 2).has_blocking_approval_requirementsJSONRequired within parent
$ (allOf 2).has_blocking_approval_requirements (anyOf 1)booleanAlternativeRead only: true
$ (allOf 2).has_blocking_approval_requirements (anyOf 2)nullAlternative
$ (allOf 2).is_expansion_requestbooleanRequired within parentRead only: true
$ (allOf 2).is_import_only_spend_programbooleanRequired within parentRead only: true
$ (allOf 2).is_renewal_requestbooleanRequired within parentRead only: true
$ (allOf 2).is_sla_due_soonbooleanRequired within parentRead only: true
$ (allOf 2).planned_outcomeJSONOptional
$ (allOf 2).planned_outcome (anyOf 1)stringAlternativeSelected outcome after approval, or null for program defaults.
Read only: true
$ (allOf 2).planned_outcome (anyOf 2)nullAlternative
$ (allOf 2).reduced_agreementsarrayRequired within parentRead only: true
$ (allOf 2).reduced_agreements[]ModelEach itemExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks reduced agreements item
$ (allOf 2).sla_due_dateJSONRequired within parent
$ (allOf 2).sla_due_date (anyOf 1)stringAlternativeFormat: date-time
Read only: true
$ (allOf 2).sla_due_date (anyOf 2)nullAlternative
$ (allOf 2).sla_duration_in_secondsJSONRequired within parent
$ (allOf 2).sla_duration_in_seconds (anyOf 1)JSONAlternative
$ (allOf 2).sla_duration_in_seconds (anyOf 1) (anyOf 1)integerAlternativeRead only: true
$ (allOf 2).sla_duration_in_seconds (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).sla_duration_in_seconds (anyOf 2)nullAlternative
$ (allOf 2).spend_end_dateJSONOptional
$ (allOf 2).spend_end_date (anyOf 1)stringAlternativeFormat: date
$ (allOf 2).spend_end_date (anyOf 2)nullAlternative
$ (allOf 2).spend_frequencyJSONRequired within parent
$ (allOf 2).spend_frequency (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
$ (allOf 2).spend_frequency (anyOf 2)nullAlternative
$ (allOf 2).spend_start_dateJSONOptional
$ (allOf 2).spend_start_date (anyOf 1)stringAlternativeFormat: date
$ (allOf 2).spend_start_date (anyOf 2)nullAlternative
$ (allOf 2).tasksarrayRequired within parentRead only: true
$ (allOf 2).tasks[]ModelEach itemExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks reduced agreements item, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks reduced agreements item

FieldTypePresenceDescription and constraints
$objectRootA reduced schema for PayeeAgreement used in unified request pagination.

Contains only the essential fields needed to display agreement information
in the context of a unified request pagination response.
idstringRequired within parent
sourceModelRequired within parentExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreements item source
statusstringRequired within parentEnum for status of `PayeeAgreementSpendRequestMapping` model

A `PayeeAgreementSpendRequestMapping` object is in a `PENDING` state
if the SpendRequest is in a draft state. We will upgrade the mapping
to an `ACTIVE` state once the request is in a submitted state
Known values: ACTIVE, PENDING

Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreements item source

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"GLOBAL_FORM_RESPONSE": "#/components/schemas/GlobalFormResponseNodeTask", "LAUNCH_ESIGN_WORKFLOW": "#/components/schemas/ESignNodeTask", "LAUNCH_THIRD_PARTY_RISK_MANAGEMENT_VENDOR_REVIEW_WORKFLOW": "#/components/schemas/ThirdPartyRiskManagementVendorReviewTask", "ticket": "#/components/schemas/SpendRequestTicketTask"}, "propertyName": "task_type"}
$ (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item provider type: docusign, dropbox sign, task type LAUNCH ESIGN WORKFLOW
$ (anyOf 2)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type GLOBAL FORM RESPONSE
$ (anyOf 3)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type ticket
$ (anyOf 4)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA, task type LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item provider type: docusign, dropbox sign, task type LAUNCH ESIGN WORKFLOW, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type GLOBAL FORM RESPONSE, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type ticket, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA, task type LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA, task type LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW

FieldTypePresenceDescription and constraints
$objectRoot
due_dateJSONOptional
due_date (anyOf 1)stringAlternativeDue date for the vendor review
Default: null
Format: date-time
due_date (anyOf 2)nullAlternative
external_review_linkstringRequired within parentExternal link to the vendor review in the TPRM provider
node_titleJSONRequired within parent
node_title (anyOf 1)stringAlternative
node_title (anyOf 2)nullAlternative
provider_typestringRequired within parentThe TPRM provider type (e.g., Vanta)
Known values: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA
submitted_atstringRequired within parentFormat: date-time
task_typestringRequired within parentMust equal: LAUNCH_THIRD_PARTY_RISK_MANAGEMENT_VENDOR_REVIEW_WORKFLOW
vendor_review_idstringRequired within parentUUID of the vendor review

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item provider type: docusign, dropbox sign, task type LAUNCH ESIGN WORKFLOW

FieldTypePresenceDescription and constraints
$objectRoot
esign_envelope_idJSONRequired within parent
esign_envelope_id (anyOf 1)stringAlternative
esign_envelope_id (anyOf 2)nullAlternative
esign_task_idstringRequired within parent
node_titleJSONRequired within parent
node_title (anyOf 1)stringAlternative
node_title (anyOf 2)nullAlternative
provider_typestringRequired within parentKnown values: docusign, dropbox_sign
sla_due_dateJSONOptional
sla_due_date (anyOf 1)stringAlternativeDefault: null
Format: date-time
sla_due_date (anyOf 2)nullAlternative
sla_duration_in_secondsJSONOptional
sla_duration_in_seconds (anyOf 1)JSONAlternative
sla_duration_in_seconds (anyOf 1) (anyOf 1)integerAlternativeDefault: null
sla_duration_in_seconds (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sla_duration_in_seconds (anyOf 2)nullAlternative
submitted_atstringRequired within parentFormat: date-time
task_typestringRequired within parentMust equal: LAUNCH_ESIGN_WORKFLOW

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type GLOBAL FORM RESPONSE

FieldTypePresenceDescription and constraints
$objectRoot
global_form_response_task_idstringRequired within parent
global_form_response_task_previewsarrayRequired within parent
global_form_response_task_previews[]ModelEach itemExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type GLOBAL FORM RESPONSE global form response task previews item
node_titleJSONRequired within parent
node_title (anyOf 1)stringAlternative
node_title (anyOf 2)nullAlternative
sla_due_dateJSONOptional
sla_due_date (anyOf 1)stringAlternativeDefault: null
Format: date-time
sla_due_date (anyOf 2)nullAlternative
sla_duration_in_secondsJSONOptional
sla_duration_in_seconds (anyOf 1)JSONAlternative
sla_duration_in_seconds (anyOf 1) (anyOf 1)integerAlternativeDefault: null
sla_duration_in_seconds (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sla_duration_in_seconds (anyOf 2)nullAlternative
submitted_atstringRequired within parentFormat: date-time
task_typestringRequired within parentMust equal: GLOBAL_FORM_RESPONSE

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type GLOBAL FORM RESPONSE global form response task previews item

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type GLOBAL FORM RESPONSE global form response task previews item

FieldTypePresenceDescription and constraints
$objectRoot
custom_form_collection_log_entry_labelJSONRequired within parent
custom_form_collection_log_entry_label (anyOf 1)stringAlternative
custom_form_collection_log_entry_label (anyOf 2)nullAlternative
custom_form_collection_log_entry_uuidstringRequired within parent
custom_form_collection_uuidstringRequired within parent
num_questionsJSONRequired within parent
num_questions (anyOf 1)integerAlternative
num_questions (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_questions_unconditionalJSONRequired within parent
num_questions_unconditional (anyOf 1)integerAlternative
num_questions_unconditional (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type ticket

FieldTypePresenceDescription and constraints
$objectRootA ticket task associated with a spend request.
contentstringRequired within parentDescription describing what the ticket is about
due_atJSONOptional
due_at (anyOf 1)stringAlternativeDue date for the ticket
Default: null
Format: date-time
due_at (anyOf 2)nullAlternative
halt_reasonJSONOptional
halt_reason (anyOf 1)stringAlternativeHuman-readable reason why the workflow agent halted (for workflow agent tickets only)
Default: null
halt_reason (anyOf 2)nullAlternative
node_titleJSONRequired within parent
node_title (anyOf 1)stringAlternative
node_title (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)stringAlternativeCurrent status of the ticket
Known values: blocked, canceled, completed, in_progress, in_review, todo, waiting_on_assignee
Default: null
status (anyOf 2)nullAlternative
submitted_atstringRequired within parentFormat: date-time
task_typestringRequired within parentMust equal: ticket
ticket_uuidstringRequired within parentFormat: uuid

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalFormat: uuid
is_shareablebooleanOptional
lock_dateJSONOptional
lock_date (anyOf 1)stringAlternativeFormat: date-time
lock_date (anyOf 2)nullAlternative
post_spend_approval_instance_policyJSONRequired within parent
post_spend_approval_instance_policy (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name
Read only: true
post_spend_approval_instance_policy (anyOf 2)nullAlternative
spend_eligibility_starts_atJSONOptional
spend_eligibility_starts_at (anyOf 1)stringAlternativeFormat: date-time
spend_eligibility_starts_at (anyOf 2)nullAlternative
spend_frequencyJSONOptional
spend_frequency (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
spend_frequency (anyOf 2)nullAlternative
unified_request_idJSONRequired within parent
unified_request_id (anyOf 1)stringAlternativeFormat: uuid
Read only: true
unified_request_id (anyOf 2)nullAlternative
unified_spend_request_typestringRequired within parentKnown values: APPROVAL_ONLY, FUND_UNARCHIVE, PROCUREMENT_SPEND_ALLOCATION, PURCHASE_ORDER, SPEND_ALLOCATION, TRAVEL
Read only: true

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
$ (allOf 2)objectAll variants apply
$ (allOf 2).blank_canvas_execution_idJSONRequired within parent
$ (allOf 2).blank_canvas_execution_id (anyOf 1)stringAlternativeBlank Canvas execution for this restoration request's approvals, or null.
Format: uuid
Read only: true
$ (allOf 2).blank_canvas_execution_id (anyOf 2)nullAlternative
$ (allOf 2).existing_spend_requestJSONRequired within parent
$ (allOf 2).existing_spend_request (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type
The original fund request linked to this restoration request.
$ (allOf 2).existing_spend_request (anyOf 2)nullAlternative
$ (allOf 2).spend_request_typestringRequired within parentPersisted request type for restoring an existing fund.
Known values: FUND_UNARCHIVE
Default: FUND_UNARCHIVE
$ (allOf 2).unified_spend_request_typestringRequired within parentUnified request classification for fund restoration, not new funding.
Known values: FUND_UNARCHIVE
Default: FUND_UNARCHIVE

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
$ (allOf 2)objectAll variants apply
$ (allOf 2).existing_spend_requestJSONRequired within parent
$ (allOf 2).existing_spend_request (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER existing spend request amount details, custom form collection response uuid, id, is shareable, lock date, post spend approval instance policy, purchase order, spend eligibility starts at, spend frequency, unified request id, unified spend request type
$ (allOf 2).existing_spend_request (anyOf 2)nullAlternative
$ (allOf 2).purchase_orderModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER purchase order
$ (allOf 2).spend_request_typestringRequired within parentKnown values: PURCHASE_ORDER
Default: PURCHASE_ORDER
$ (allOf 2).unified_spend_request_typestringRequired within parentKnown values: PURCHASE_ORDER
Default: PURCHASE_ORDER

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER existing spend request amount details, custom form collection response uuid, id, is shareable, lock date, post spend approval instance policy, purchase order, spend eligibility starts at, spend frequency, unified request id, unified spend request type, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER purchase order

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
$ (allOf 2)objectAll variants apply
$ (allOf 2).amount_detailsModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details
Read only: true
$ (allOf 2).total_amount_detailsJSONRequired within parent
$ (allOf 2).total_amount_details (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details
Read only: true
$ (allOf 2).total_amount_details (anyOf 2)nullAlternative

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeMoney amount in representative currency
Read only: true
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parent3-char currency code (e.g. 'USD', 'CAD')
Known values: 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, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, 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, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL
Read only: true
currency_signstringRequired within parentCurrency sign (e.g. '$', '€')
Read only: true
formatted_amountstringRequired within parentDeprecated - use useIntl()'s formatMoney() instead. Human-readable amount with money context
Read only: true
formatted_explicit_amountstringRequired within parentDeprecated - use useIntl()'s formatMoney() instead. Displays foreign in currencies in extended form. Used primarily for admins i.e $100 CAD
Read only: true
formatted_short_amountstringRequired within parentDeprecated - use useIntl()'s formatMoney() instead. Displays foreign currencies in short form. i.e $CA100
Read only: true
namestringRequired within parentDisplay name (e.g. 'US Dollar')
Read only: true
num_decimal_placesJSONRequired within parent
num_decimal_places (anyOf 1)integerAlternativeNumber of decimal places to render.
Read only: true
num_decimal_places (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER existing spend request amount details, custom form collection response uuid, id, is shareable, lock date, post spend approval instance policy, purchase order, spend eligibility starts at, spend frequency, unified request id, unified spend request type

FieldTypePresenceDescription and constraints
$objectRoot
amount_detailsModelOptionalExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details
Read only: true
custom_form_collection_response_uuidJSONOptional
custom_form_collection_response_uuid (anyOf 1)stringAlternativeFormat: uuid
custom_form_collection_response_uuid (anyOf 2)nullAlternative
idstringOptionalFormat: uuid
is_shareablebooleanOptional
lock_dateJSONOptional
lock_date (anyOf 1)stringAlternativeFormat: date-time
lock_date (anyOf 2)nullAlternative
post_spend_approval_instance_policyJSONRequired within parent
post_spend_approval_instance_policy (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name
Read only: true
post_spend_approval_instance_policy (anyOf 2)nullAlternative
purchase_orderJSONRequired within parent
purchase_order (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER purchase order
purchase_order (anyOf 2)nullAlternative
spend_eligibility_starts_atJSONOptional
spend_eligibility_starts_at (anyOf 1)stringAlternativeFormat: date-time
spend_eligibility_starts_at (anyOf 2)nullAlternative
spend_frequencyJSONOptional
spend_frequency (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
spend_frequency (anyOf 2)nullAlternative
unified_request_idJSONRequired within parent
unified_request_id (anyOf 1)stringAlternativeFormat: uuid
Read only: true
unified_request_id (anyOf 2)nullAlternative
unified_spend_request_typestringRequired within parentKnown values: APPROVAL_ONLY, FUND_UNARCHIVE, PROCUREMENT_SPEND_ALLOCATION, PURCHASE_ORDER, SPEND_ALLOCATION, TRAVEL
Read only: true

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER purchase order, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER purchase order

FieldTypePresenceDescription and constraints
$objectRoot
can_view_full_purchase_orderbooleanRequired within parentWhether the acting user can open the full purchase order.
Read only: true
idstringRequired within parentFormat: uuid
is_directly_issuedbooleanRequired within parentTrue when the PO was issued directly, without a program or request approval.
purchase_order_numberJSONRequired within parent
purchase_order_number (anyOf 1)stringAlternativeRead only: true
purchase_order_number (anyOf 2)nullAlternative

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
$ (allOf 2)objectAll variants apply
$ (allOf 2).existing_spend_requestJSONRequired within parent
$ (allOf 2).existing_spend_request (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER existing spend request amount details, custom form collection response uuid, id, is shareable, lock date, post spend approval instance policy, purchase order, spend eligibility starts at, spend frequency, unified request id, unified spend request type
$ (allOf 2).existing_spend_request (anyOf 2)nullAlternative
$ (allOf 2).is_shareablebooleanRequired within parent
$ (allOf 2).lock_dateJSONOptional
$ (allOf 2).lock_date (anyOf 1)stringAlternativeFormat: date-time
$ (allOf 2).lock_date (anyOf 2)nullAlternative
$ (allOf 2).lock_displayJSONRequired within parent
$ (allOf 2).lock_display (anyOf 1)stringAlternativeRead only: true
$ (allOf 2).lock_display (anyOf 2)nullAlternative
$ (allOf 2).relative_lock_duration_countJSONRequired within parent
$ (allOf 2).relative_lock_duration_count (anyOf 1)JSONAlternative
$ (allOf 2).relative_lock_duration_count (anyOf 1) (anyOf 1)integerAlternative
$ (allOf 2).relative_lock_duration_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).relative_lock_duration_count (anyOf 2)nullAlternative
$ (allOf 2).relative_lock_duration_unitJSONRequired within parent
$ (allOf 2).relative_lock_duration_unit (anyOf 1)stringAlternativeKnown values: DAYS, MONTHS, WEEKS, YEARS
$ (allOf 2).relative_lock_duration_unit (anyOf 2)nullAlternative
$ (allOf 2).resulting_spend_allocation_idJSONRequired within parent
$ (allOf 2).resulting_spend_allocation_id (anyOf 1)stringAlternativeRead only: true
$ (allOf 2).resulting_spend_allocation_id (anyOf 2)nullAlternative
$ (allOf 2).spend_allocationJSONRequired within parent
$ (allOf 2).spend_allocation (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION spend request type: SPEND LIMIT, unified spend request type: PROCUREMENT SPEND ALLOCATION spend allocation id, payment restrictions, submission policy
$ (allOf 2).spend_allocation (anyOf 2)nullAlternative
$ (allOf 2).spend_eligibility_starts_atJSONOptional
$ (allOf 2).spend_eligibility_starts_at (anyOf 1)stringAlternativeFormat: date-time
$ (allOf 2).spend_eligibility_starts_at (anyOf 2)nullAlternative
$ (allOf 2).spend_request_typestringRequired within parentKnown values: SPEND_LIMIT
Default: SPEND_LIMIT
$ (allOf 2).unified_spend_request_typestringRequired within parentKnown values: PROCUREMENT_SPEND_ALLOCATION
Default: PROCUREMENT_SPEND_ALLOCATION

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER existing spend request amount details, custom form collection response uuid, id, is shareable, lock date, post spend approval instance policy, purchase order, spend eligibility starts at, spend frequency, unified request id, unified spend request type, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION spend request type: SPEND LIMIT, unified spend request type: PROCUREMENT SPEND ALLOCATION spend allocation id, payment restrictions, submission policy

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION spend request type: SPEND LIMIT, unified spend request type: PROCUREMENT SPEND ALLOCATION spend allocation id, payment restrictions, submission policy

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentFormat: uuid
payment_restrictionsModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled
Read only: true
submission_policyJSONOptional
submission_policy (anyOf 1)ModelAlternativeExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY submission policy
submission_policy (anyOf 2)nullAlternative

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled, Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY submission policy

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
$ (allOf 2)objectAll variants apply
$ (allOf 2).resulting_spend_allocation_idJSONRequired within parent
$ (allOf 2).resulting_spend_allocation_id (anyOf 1)stringAlternativeRead only: true
$ (allOf 2).resulting_spend_allocation_id (anyOf 2)nullAlternative
$ (allOf 2).spend_allocation_outcome_settingsJSONRequired within parent
$ (allOf 2).spend_allocation_outcome_settings (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL spend request type: TRAVEL, unified spend request type: TRAVEL spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
Read only: true
$ (allOf 2).spend_allocation_outcome_settings (anyOf 2)nullAlternative
$ (allOf 2).spend_request_typestringRequired within parentKnown values: TRAVEL
Default: TRAVEL
$ (allOf 2).travel_metadataModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL spend request type: TRAVEL, unified spend request type: TRAVEL travel metadata
Read only: true
$ (allOf 2).unified_spend_request_typestringRequired within parentKnown values: TRAVEL
Default: TRAVEL

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL spend request type: TRAVEL, unified spend request type: TRAVEL spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL spend request type: TRAVEL, unified spend request type: TRAVEL travel metadata

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id
$ (allOf 2)objectAll variants apply
$ (allOf 2).assigned_spend_intentJSONOptional
$ (allOf 2).assigned_spend_intent (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST spend intent logo id, name, uuid
Spend program assigned to a request that its workflow-backed policy is still approving, or null. Display it as the request's program.
Read only: true
$ (allOf 2).assigned_spend_intent (anyOf 2)nullAlternative
$ (allOf 2).coordinatorJSONRequired within parent
$ (allOf 2).coordinator (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner
Read only: true
$ (allOf 2).coordinator (anyOf 2)nullAlternative
$ (allOf 2).laminar_session_idJSONRequired within parent
$ (allOf 2).laminar_session_id (anyOf 1)stringAlternativeLaminar chat session associated with this draft
Read only: true
$ (allOf 2).laminar_session_id (anyOf 2)nullAlternative
$ (allOf 2).nameJSONRequired within parent
$ (allOf 2).name (anyOf 1)stringAlternativeRead only: true
$ (allOf 2).name (anyOf 2)nullAlternative
$ (allOf 2).omni_chat_thread_idJSONRequired within parent
$ (allOf 2).omni_chat_thread_id (anyOf 1)stringAlternativeOmni chat thread associated with this draft
Read only: true
$ (allOf 2).omni_chat_thread_id (anyOf 2)nullAlternative
$ (allOf 2).ownerModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner
Read only: true
$ (allOf 2).payeeJSONRequired within parent
$ (allOf 2).payee (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED
$ (allOf 2).payee (anyOf 2)nullAlternative
$ (allOf 2).request_statusstringRequired within parentKnown values: APPROVED, DRAFT, REJECTED, SUBMITTED
$ (allOf 2).secondary_display_nameJSONRequired within parent
$ (allOf 2).secondary_display_name (anyOf 1)stringAlternative
$ (allOf 2).secondary_display_name (anyOf 2)nullAlternative
$ (allOf 2).spend_intentJSONRequired within parent
$ (allOf 2).spend_intent (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST spend intent logo id, name, uuid
Read only: true
$ (allOf 2).spend_intent (anyOf 2)nullAlternative
$ (allOf 2).spend_request_idstringRequired within parentFormat: uuid
$ (allOf 2).spend_request_vendor_typeJSONRequired within parent
$ (allOf 2).spend_request_vendor_type (anyOf 1)stringAlternativeKnown values: EXISTING, NEW
$ (allOf 2).spend_request_vendor_type (anyOf 2)nullAlternative
$ (allOf 2).unified_request_typestringRequired within parentKnown values: SPEND_REQUEST
Default: SPEND_REQUEST
$ (allOf 2).user_defined_nameJSONRequired within parent
$ (allOf 2).user_defined_name (anyOf 1)stringAlternativeRead only: true
$ (allOf 2).user_defined_name (anyOf 2)nullAlternative
$ (allOf 2).wbx_migrationJSONRequired within parent
$ (allOf 2).wbx_migration (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST wbx migration assigned program name, migrated at, original policy name
Policy-to-program migration details, or null for requests that have not migrated.
Read only: true
$ (allOf 2).wbx_migration (anyOf 2)nullAlternative

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST spend intent logo id, name, uuid, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST wbx migration assigned program name, migrated at, original policy name

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id

FieldTypePresenceDescription and constraints
$objectRoot
approval_instance_idJSONRequired within parent
approval_instance_id (anyOf 1)stringAlternative
approval_instance_id (anyOf 2)nullAlternative
approved_atJSONRequired within parent
approved_at (anyOf 1)stringAlternativeFormat: date-time
approved_at (anyOf 2)nullAlternative
created_atstringRequired within parentFormat: date-time
created_by_userModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner
deleted_atJSONRequired within parent
deleted_at (anyOf 1)stringAlternativeFormat: date-time
deleted_at (anyOf 2)nullAlternative
display_request_numberJSONRequired within parent
display_request_number (anyOf 1)stringAlternativeHuman-facing display number, e.g. "REQ-123"; null until the request is numbered.
Read only: true
display_request_number (anyOf 2)nullAlternative
entityModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id entity
idstringRequired within parentFormat: uuid
Read only: true
nameJSONRequired within parent
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative
ramp_urlstringRequired within parentRead only: true
reasonJSONRequired within parent
reason (anyOf 1)stringAlternative
reason (anyOf 2)nullAlternative
rejected_atJSONRequired within parent
rejected_at (anyOf 1)stringAlternativeFormat: date-time
rejected_at (anyOf 2)nullAlternative
request_durationJSONRequired within parent
request_duration (anyOf 1)JSONAlternative
request_duration (anyOf 1) (anyOf 1)integerAlternative
request_duration (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
request_duration (anyOf 2)nullAlternative
submitted_atJSONRequired within parent
submitted_at (anyOf 1)stringAlternativeFormat: date-time
submitted_at (anyOf 2)nullAlternative
wbp_infoJSONRequired within parent
wbp_info (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id
Read only: true
wbp_info (anyOf 2)nullAlternative
workflow_backed_policy_idJSONRequired within parent
workflow_backed_policy_id (anyOf 1)stringAlternativeID of the originating workflow-backed policy.
Read only: true
workflow_backed_policy_id (anyOf 2)nullAlternative

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id entity, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id entity

FieldTypePresenceDescription and constraints
$objectRoot
entity_namestringRequired within parent
idstringRequired within parentFormat: uuid

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id

FieldTypePresenceDescription and constraints
$objectRoot
approvalsarrayRequired within parentWBP approvals for this request, with status and ownership.
approvals[]ModelEach itemExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id approvals item
blank_canvas_execution_idJSONRequired within parent
blank_canvas_execution_id (anyOf 1)stringAlternativeBlank-canvas progression execution backing this request
Default: null
blank_canvas_execution_id (anyOf 2)nullAlternative
field_attributionsarrayRequired within parentPer-field attribution of how each value was provided.
field_attributions[]ModelEach itemExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id field attributions item
wbp_request_idstringRequired within parentID of the backing WBP request.
workflow_backed_policy_display_namestringRequired within parentDisplay name of the workflow-backed policy.
workflow_backed_policy_idstringRequired within parentID of the workflow-backed policy.

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id approvals item, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id field attributions item

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id approvals item

FieldTypePresenceDescription and constraints
$objectRoot
is_for_current_userJSONRequired within parent
is_for_current_user (anyOf 1)booleanAlternativeWhether the approval belongs to the requesting user. Null when not yet known
is_for_current_user (anyOf 2)nullAlternative
is_generatingbooleanRequired within parentWhether the approval's summary is still being generated
progression_node_idstringRequired within parentBlank-canvas progression node this approval is wired to.
wbp_approval_idstringRequired within parentID of the WBP approval.

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id field attributions item

FieldTypePresenceDescription and constraints
$objectRoot
actorstringRequired within parentWho wrote the field value.
Known values: agent, user
namestringRequired within parentCustom form field id.
source_detailJSONOptional
source_detail (anyOf 1)stringAlternativeShort user-facing note on where the value came from.
Default: null
source_detail (anyOf 2)nullAlternative
source_typeJSONOptional
source_type (anyOf 1)stringAlternativeWhere an agent-written value came from.
Where an agent-written value came from; null for user-written values.
Known values: attachment, email, notion, other, slack, web
Default: null
source_type (anyOf 2)nullAlternative
source_urlJSONOptional
source_url (anyOf 1)stringAlternativeLink to the exact source when one exists (e.g. Slack permalink, Notion page).
Default: null
source_url (anyOf 2)nullAlternative

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner

FieldTypePresenceDescription and constraints
$objectRoot
deleted_atJSONRequired within parent
deleted_at (anyOf 1)stringAlternativeFormat: date-time
deleted_at (anyOf 2)nullAlternative
departmentJSONRequired within parent
department (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner department department name, id
department (anyOf 2)nullAlternative
emailstringRequired within parent
first_namestringRequired within parent
full_namestringRequired within parent
has_physical_cardbooleanRequired within parentRead only: true
last_namestringRequired within parent
locationJSONRequired within parent
location (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner location id, location name
location (anyOf 2)nullAlternative
profile_picture_urlJSONRequired within parent
profile_picture_url (anyOf 1)stringAlternative
profile_picture_url (anyOf 2)nullAlternative
rolestringRequired within parentKnown values: AUDITOR, BUSINESS_ADMIN, BUSINESS_BOOKKEEPER, BUSINESS_OWNER, BUSINESS_USER, GUEST_USER, IT_ADMIN, UNBUNDLED_ADMIN, UNBUNDLED_BOOKKEEPER, UNBUNDLED_OWNER, UNBUNDLED_USER
uuidstringRequired within parentFormat: uuid

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner department department name, id, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner location id, location name

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner department department name, id

FieldTypePresenceDescription and constraints
$objectRoot
department_namestringRequired within parent
idstringRequired within parentFormat: uuid
Read only: true

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner location id, location name

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentFormat: uuid
Read only: true
location_namestringRequired within parent

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.