Skip to content

Ramp: Unified request schemas (part 4)

42 Ramp schemas with complete fields and constraints.

← Unified request operations · All schemas

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order accounting tracking category selections item

FieldTypePresenceDescription and constraints
$objectRoot
acting_userJSONOptional
acting_user (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 members item
User who manually set this accounting tracking category selection.
acting_user (anyOf 2)nullAlternative
resolution_reasonJSONRequired within parent
resolution_reason (anyOf 1)stringAlternativeKnown values: ACCRUAL_AI_SUGGESTED_CODING, ACCRUAL_TRACKING_CATEGORY_DEFAULT_VALUE, ADVANCED_RULE, AI_AUTOCODING, BILL_LINE_ITEM_TO_PO_LINE_ITEM, CARD_RULE, CATEGORY_RULE, DEFAULT_VALUE, DEPARTMENT_RULE, DEVELOPER_API, EMPLOYEE_AGENT, ENTITY_MAPPING, ERP_MIGRATION, LOCATION_RULE, MANUAL, MAPPING_RULE, MERCHANT_AUTO_RULE, MERCHANT_CATEGORY_LEVEL_EMPLOYEE_RULE, MERCHANT_LAST_CODED_RULE, MERCHANT_LEVEL_EMPLOYEE_RULE, MERCHANT_TO_CATEGORY_RULE, MERCHANT_TO_MERCHANT_RULE, SPEND_ALLOCATION_RULE, SUBLEDGER, SUGGESTED_CODING, SUGGESTED_CODING_RULES_OVERRIDE, SUGGESTED_CODING_UPSELL, SUGGESTED_CONTEXT, SUGGESTED_CONTEXT_NO_AUTOFILL, SUGGESTED_MEMO, TMC_INTEGRATION, TRACKING_CATEGORY_DEACTIVATED, TRACKING_CATEGORY_DEFAULT_VALUE, TRAVELPERK_TAGGING, USER_LEVEL_EMPLOYEE_RULE
resolution_reason (anyOf 2)nullAlternative
tracking_categoryModelRequired within parentExpand 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 tracking category
tracking_category_idJSONRequired within parent
tracking_category_id (anyOf 1)integerAlternative
tracking_category_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tracking_category_optionModelRequired within parentExpand 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 tracking category option
workflow_condition_idJSONRequired within parent
workflow_condition_id (anyOf 1)stringAlternative
workflow_condition_id (anyOf 2)nullAlternative
workflow_rule_uuidJSONRequired within parent
workflow_rule_uuid (anyOf 1)stringAlternative
workflow_rule_uuid (anyOf 2)nullAlternative

Referenced models: 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 tracking category, 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 tracking category option, 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 members item

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order purchase order line item log entries item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_tracking_category_selectionsarrayRequired within parentRead only: true
accounting_tracking_category_selections[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order accounting tracking category selections item
amountJSONRequired within parent
amount (anyOf 1)numberAlternative
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
custom_field_valuesarrayRequired within parentRead only: true
custom_field_values[]ModelEach itemExpand Fetch a purchase order — response body — line items item custom field values item
descriptionJSONRequired within parent
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
due_dateJSONRequired within parent
due_date (anyOf 1)stringAlternativeFormat: date
due_date (anyOf 2)nullAlternative
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeFormat: date
end_date (anyOf 2)nullAlternative
existing_purchase_order_line_item_uuidJSONRequired within parent
existing_purchase_order_line_item_uuid (anyOf 1)stringAlternativeFormat: uuid
existing_purchase_order_line_item_uuid (anyOf 2)nullAlternative
idstringRequired within parentRead only: true
line_item_typestringRequired within parentKnown values: EXPENSE, ITEM
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternative
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternative
receiving_typestringOptionalHow the line is received: by quantity or by amount.
Known values: by_amount, by_quantity
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeFormat: date
start_date (anyOf 2)nullAlternative
tax_amountsarrayRequired within parentTax amounts applied to this purchase order line item.
Read only: true
tax_amounts[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order tax lines item
total_amountJSONRequired within parent
total_amount (anyOf 1)numberAlternative
total_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit_priceJSONRequired within parent
unit_price (anyOf 1)JSONAlternative
unit_price (anyOf 1) (anyOf 1)numberAlternative
unit_price (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit_price (anyOf 2)nullAlternative
unit_quantityJSONRequired within parent
unit_quantity (anyOf 1)JSONAlternative
unit_quantity (anyOf 1) (anyOf 1)numberAlternativeDeprecated: read from quantity field instead
Read only: true
unit_quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit_quantity (anyOf 2)nullAlternative
uuidstringRequired within parentRead only: true
withholding_rateJSONOptional
withholding_rate (anyOf 1)stringAlternativeRetainage withholding rate for the line item
Format: decimal
withholding_rate (anyOf 2)nullAlternative

Referenced models: Fetch a purchase order — response body — line items item custom field values item, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order accounting tracking category selections item, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order tax lines item

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order tax lines item

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeTax amount in the purchase order currency.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringRequired within parentName of the accounting tax rate.
ratestringRequired within parentAccounting tax rate as a decimal fraction.
tax_rate_uuidstringRequired within parentUUID of the accounting tax rate.
Format: uuid

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, 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 Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE
$ (allOf 2)ModelAll variants applyExpand 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

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: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE, 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

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings
$ (allOf 2)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
$ (allOf 3)objectAll variants apply
$ (allOf 3).accounting_auto_mark_ready_rule_enabledbooleanRequired within parentWhether fund transactions are automatically marked ready for accounting.
$ (allOf 3).accounting_rulesarrayRequired within parentRead only: true
$ (allOf 3).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
$ (allOf 3).approval_chain_dataModelRequired 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 approval chain data
Read only: true
$ (allOf 3).approval_eventsarrayRequired within parentRead only: true
$ (allOf 3).approval_events[]ModelEach itemExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid approval events item
$ (allOf 3).archive_dateJSONRequired within parent
$ (allOf 3).archive_date (anyOf 1)stringAlternativeDate when the spend allocation will be automatically archived.
Format: date-time
$ (allOf 3).archive_date (anyOf 2)nullAlternative
$ (allOf 3).available_actionsModelRequired 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 available actions
Read only: true
$ (allOf 3).available_actions_v2ModelRequired within parentExpand 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 available actions v2
Read only: true
$ (allOf 3).blank_canvas_execution_idJSONRequired within parent
$ (allOf 3).blank_canvas_execution_id (anyOf 1)stringAlternativeBlank Canvas execution for this request's approvals, or null.
Format: uuid
Read only: true
$ (allOf 3).blank_canvas_execution_id (anyOf 2)nullAlternative
$ (allOf 3).default_transaction_memoJSONRequired within parent
$ (allOf 3).default_transaction_memo (anyOf 1)stringAlternativeDefault memo applied to transactions using the fund.
$ (allOf 3).default_transaction_memo (anyOf 2)nullAlternative
$ (allOf 3).membersarrayRequired within parentUsers currently assigned to the fund.
$ (allOf 3).members[]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 members item
$ (allOf 3).spending_restrictionsModelRequired within parentExpand 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 spending restrictions
Current transaction restrictions configured for the fund.
Read only: true
$ (allOf 3).submission_policy_idJSONRequired within parent
$ (allOf 3).submission_policy_id (anyOf 1)stringAlternativeUUID of the fund's transaction submission policy, if configured.
Read only: true
$ (allOf 3).submission_policy_id (anyOf 2)nullAlternative
$ (allOf 3).travel_metadataJSONRequired within parent
$ (allOf 3).travel_metadata (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
Read only: true
$ (allOf 3).travel_metadata (anyOf 2)nullAlternative
$ (allOf 3).tripJSONRequired within parent
$ (allOf 3).trip (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 trip id, trip name
Read only: true
$ (allOf 3).trip (anyOf 2)nullAlternative

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 approval chain data, Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid approval events 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings, 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, 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, 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 available actions, 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 available actions v2, 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 spending restrictions, 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 travel metadata, 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 members item

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

FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)integerAlternative
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tracking_categoryModelRequired within parentExpand 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 tracking category
tracking_category_idJSONRequired within parent
tracking_category_id (anyOf 1)integerAlternative
tracking_category_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tracking_category_optionModelRequired within parentExpand 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 tracking category option

Referenced models: 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 tracking category, 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 tracking category option

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 tracking category

FieldTypePresenceDescription and constraints
$objectRoot
additional_dataJSONRequired within parent
additional_data (anyOf 1)ModelAlternativeExpand 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 tracking category additional data is payment terms, is suitetax enabled, vendor creation enabled
additional_data (anyOf 2)nullAlternative
cardholder_edits_allowedbooleanRequired within parent
default_optionJSONRequired within parent
default_option (anyOf 1)ModelAlternativeExpand 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 tracking category option
default_option (anyOf 2)nullAlternative
display_namestringRequired within parentRead only: true
display_name_shortstringRequired within parent
entity_settingsarrayRequired within parent
entity_settings[]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 tracking category entity settings item
helper_textJSONRequired within parent
helper_text (anyOf 1)stringAlternative
helper_text (anyOf 2)nullAlternative
idJSONRequired within parent
id (anyOf 1)integerAlternative
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
input_typestringRequired within parentKnown values: BOOLEAN, DATE, FREE_FORM_TEXT, SINGLE_CHOICE
is_activebooleanRequired within parent
is_custom_fieldbooleanRequired within parent
is_erp_sourcedbooleanRequired within parentWhether this tracking category participates in ERP sync, including fields supplied through CSV uploads or API integrations.
is_hiddenbooleanRequired within parent
is_internalbooleanRequired within parent
is_splittablebooleanRequired within parent
refresh_statusJSONRequired within parent
refresh_status (anyOf 1)ModelAlternativeExpand 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 tracking category refresh status state: FAILURE, IN PROGRESS, NOT STARTED, SKIPPED, SUCCESS
refresh_status (anyOf 2)nullAlternative
remote_field_locationsJSONRequired within parent
remote_field_locations (anyOf 1)arrayAlternative
remote_field_locations (anyOf 1)[]stringEach itemKnown values: BODY, EXPENSE_LINE, ITEM_LINE, LINE_ITEM
remote_field_locations (anyOf 2)nullAlternative
remote_idstringRequired within parent
remote_namestringRequired within parent
remote_typestringRequired within parentKnown values: AMORTIZATION_TEMPLATE, BILLABLE, COST_CENTER, CUSTOMERS_JOBS, DEFERRAL_CODE, EXPENSE_ENTITY, GL_ACCOUNT, INVENTORY_ITEM, JOURNAL, MERCHANT, NON_ERP, OTHER, PAYROLL_PROVIDER, PROJECT, REPORTING_TAG, SALES_TAX_CODE, SUBSIDIARY, TAX_CODE, UNIT_OF_MEASURE
settingsModelRequired within parentExpand 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 tracking category settings
Read only: true
sync_with_erpbooleanOptionalDeprecated. Use is_erp_sourced instead.
uuidstringRequired within parentFormat: uuid

Referenced models: 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 tracking category entity settings item, 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 tracking category option, 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 tracking category refresh status state: FAILURE, IN PROGRESS, NOT STARTED, SKIPPED, SUCCESS, 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 tracking category additional data is payment terms, is suitetax enabled, vendor creation enabled, 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 tracking category settings

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 tracking category additional data is payment terms, is suitetax enabled, vendor creation enabled

FieldTypePresenceDescription and constraints
$objectRoot
is_payment_termsbooleanOptional
is_suitetax_enabledbooleanOptional
vendor_creation_enabledbooleanOptional

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 tracking category entity settings item

FieldTypePresenceDescription and constraints
$objectRoot
entity_typestringOptionalKnown values: ADVANCED_INTERCOMPANY_JOURNAL_ENTRY, BILL, BILL_PAYMENT, CHECK, DEPOSIT, INVOICE, JOURNAL, PURCHASE_ORDER, TRANSACTION, UNUSED
is_requiredbooleanOptional
ramp_entity_typeJSONOptional
ramp_entity_type (anyOf 1)stringAlternativeKnown values: BILL, BILL_PAYMENT, CUSTOMER, INVOICE, PURCHASE_ORDER, REIMBURSEMENT, SPEND_PROGRAM, TRANSACTION, TRANSFER_LEDGER_ENTRY_MAPPING, VENDOR_CREDIT
ramp_entity_type (anyOf 2)nullAlternative

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 tracking category option

FieldTypePresenceDescription and constraints
$objectRoot
additional_dataJSONRequired within parent
additional_data (anyOf 1)ModelAlternativeExpand 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 tracking category option additional data account classification, cost, currency iso, description, group title, is job, is lot numbered, item receipt unapplicable, quantity decimal places, subsidiary, tax rates
additional_data (anyOf 2)nullAlternative
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeBase display name for the option. label, title, and subtitle are derived from this field. Prefer those instead of display_name field for display purposes.
display_name (anyOf 2)nullAlternative
display_name_prefixJSONOptional
display_name_prefix (anyOf 1)stringAlternativeOptional provider-supplied prefix used to distinguish options with the same title. Surfaces that need disambiguation should display `{display_name_prefix} - {title}`; otherwise use `title`.
display_name_prefix (anyOf 2)nullAlternative
idJSONRequired within parent
id (anyOf 1)integerAlternative
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
is_activebooleanRequired within parent
labelstringRequired within parentDisplays the code and title. This is meant to be used when there is only one line displayed in the UI.
parentModelOptionalExpand 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 tracking category option parent
receiving_typesModelOptionalExpand 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 tracking category option receiving types
Present only on inventory item options, in responses that look up receiving types.
Read only: true
remote_codeJSONRequired within parent
remote_code (anyOf 1)stringAlternative
remote_code (anyOf 2)nullAlternative
remote_idJSONRequired within parent
remote_id (anyOf 1)stringAlternativeThe provider-side identifier for the option. Usually ERP-owned; for universal_csv it can be updated via the PATCH endpoint.
remote_id (anyOf 2)nullAlternative
remote_namestringRequired within parentThe provider-side name for the option. Usually ERP-owned; for universal_csv it can be updated via the PATCH endpoint. Do not use this field for display purposes.
subtitleJSONRequired within parent
subtitle (anyOf 1)stringAlternativeDisplays the code, and any hierarchical relationships. This is meant to be used in conjunction with title when two lines displayed in the UI.
subtitle (anyOf 2)nullAlternative
titlestringRequired within parentThe simplest name of the option. Does not include code and hierarchical relationships. This is meant to be used in conjunction with subtitle when two lines displayed in the UI.
uuidstringRequired within parentFormat: uuid
visibilitystringRequired within parentKnown values: HIDDEN, VISIBLE

Referenced models: 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 tracking category option receiving types, 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 tracking category option additional data account classification, cost, currency iso, description, group title, is job, is lot numbered, item receipt unapplicable, quantity decimal places, subsidiary, tax rates, 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 tracking category option parent

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 tracking category option additional data account classification, cost, currency iso, description, group title, is job, is lot numbered, item receipt unapplicable, quantity decimal places, subsidiary, tax rates

FieldTypePresenceDescription and constraints
$objectRoot
account_classificationJSONOptional
account_classification (anyOf 1)stringAlternativeKnown values: ANY, ASSET, CREDCARD, EQUITY, EXPENSE, LIABILITY, REVENUE, UNKNOWN
account_classification (anyOf 2)nullAlternative
costJSONOptional
cost (anyOf 1)numberAlternative
cost (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency_isostringOptional
descriptionstringOptional
group_titlestringOptional
is_jobbooleanOptional
is_lot_numberedbooleanOptionalWhether this inventory item is lot-numbered in the ERP.
item_receipt_unapplicablebooleanOptional
quantity_decimal_placesJSONOptional
quantity_decimal_places (anyOf 1)integerAlternative
quantity_decimal_places (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
subsidiaryarrayOptional
subsidiary[]stringEach item
tax_ratesarrayOptional
tax_rates[]stringEach item

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 tracking category option parent

FieldTypePresenceDescription and constraints
$objectRoot
remote_namestringRequired within parent

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 tracking category option receiving types

FieldTypePresenceDescription and constraints
$objectRootHow a PO line coded to an inventory item may be received.
available_typesarrayRequired within parentReceiving types a PO line coded to this inventory item may use.
available_types[]stringEach itemHow a purchase order line is received and matched: by quantity or by amount.
Known values: by_amount, by_quantity
default_typestringRequired within parentHow a purchase order line is received and matched: by quantity or by amount.
The item's default receiving type. Always one of available_types.
Known values: by_amount, by_quantity
Default: by_quantity

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 tracking category refresh status state: FAILURE, IN PROGRESS, NOT STARTED, SKIPPED, SUCCESS

FieldTypePresenceDescription and constraints
$objectRoot
completed_atJSONRequired within parent
completed_at (anyOf 1)stringAlternativeFormat: date-time
completed_at (anyOf 2)nullAlternative
statestringRequired within parentKnown values: FAILURE, IN_PROGRESS, NOT_STARTED, SKIPPED, SUCCESS

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 tracking category settings

FieldTypePresenceDescription and constraints
$objectRoot
allow_noneJSONRequired within parent
allow_none (anyOf 1)booleanAlternative
allow_none (anyOf 2)nullAlternative
default_tracking_category_optionJSONRequired within parent
default_tracking_category_option (anyOf 1)ModelAlternativeExpand 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 tracking category option
default_tracking_category_option (anyOf 2)nullAlternative
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeNullable raw settings override. Do not use for display; use the top-level TrackingCategory.display_name canonical effective label.
display_name (anyOf 2)nullAlternative
display_orderJSONRequired within parent
display_order (anyOf 1)JSONAlternative
display_order (anyOf 1) (anyOf 1)integerAlternative
display_order (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
display_order (anyOf 2)nullAlternative
exclude_bill_payments_from_ai_suggestionsJSONOptional
exclude_bill_payments_from_ai_suggestions (anyOf 1)booleanAlternativeExclude bill payments from AI suggestions. Null inherits is_excluded_from_ai_suggestions.
exclude_bill_payments_from_ai_suggestions (anyOf 2)nullAlternative
exclude_bills_from_ai_suggestionsJSONOptional
exclude_bills_from_ai_suggestions (anyOf 1)booleanAlternativeExclude bills from AI suggestions. Null inherits is_excluded_from_ai_suggestions.
exclude_bills_from_ai_suggestions (anyOf 2)nullAlternative
exclude_purchase_orders_from_ai_suggestionsJSONOptional
exclude_purchase_orders_from_ai_suggestions (anyOf 1)booleanAlternativeExclude purchase orders from AI suggestions. Null inherits is_excluded_from_ai_suggestions.
exclude_purchase_orders_from_ai_suggestions (anyOf 2)nullAlternative
exclude_reimbursements_from_ai_suggestionsJSONOptional
exclude_reimbursements_from_ai_suggestions (anyOf 1)booleanAlternativeExclude reimbursements from AI suggestions. Null inherits is_excluded_from_ai_suggestions.
exclude_reimbursements_from_ai_suggestions (anyOf 2)nullAlternative
exclude_transactions_from_ai_suggestionsJSONOptional
exclude_transactions_from_ai_suggestions (anyOf 1)booleanAlternativeExclude transactions from AI suggestions. Null inherits is_excluded_from_ai_suggestions.
exclude_transactions_from_ai_suggestions (anyOf 2)nullAlternative
exclude_wallet_transfers_from_ai_suggestionsJSONOptional
exclude_wallet_transfers_from_ai_suggestions (anyOf 1)booleanAlternativeExclude wallet transfers from AI suggestions. Null inherits is_excluded_from_ai_suggestions.
exclude_wallet_transfers_from_ai_suggestions (anyOf 2)nullAlternative
helper_textJSONRequired within parent
helper_text (anyOf 1)stringAlternative
helper_text (anyOf 2)nullAlternative
is_excluded_from_ai_suggestionsbooleanRequired within parent
is_hiddenbooleanRequired within parent
is_receipt_extra_schema_enabledbooleanRequired within parent
option_filter_workflow_idJSONRequired within parent
option_filter_workflow_id (anyOf 1)stringAlternativeFormat: uuid
option_filter_workflow_id (anyOf 2)nullAlternative
receipt_extra_schema_descriptionJSONRequired within parent
receipt_extra_schema_description (anyOf 1)stringAlternativeDefault: null
receipt_extra_schema_description (anyOf 2)nullAlternative
updated_atstringRequired within parentFormat: date-time

Referenced models: 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 tracking category option

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 available actions v2

FieldTypePresenceDescription and constraints
$objectRoot
archiveModelRequired within parentExpand 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 available actions v2 archive
edit_primary_fieldsModelRequired within parentExpand 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 available actions v2 edit primary fields

Referenced models: 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 available actions v2 archive, 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 available actions v2 edit primary fields

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 available actions v2 archive

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_ArchiveDenialReason_"}, "propertyName": "status"}
$ (anyOf 1)ModelAlternativeExpand Fetch a vendor agreement — response body — available actions delete status allowed
$ (anyOf 2)ModelAlternativeExpand 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 available actions v2 archive status denied

Referenced models: Fetch a vendor agreement — response body — available actions delete status allowed, 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 available actions v2 archive status denied

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 available actions v2 archive status denied

FieldTypePresenceDescription and constraints
$objectRoot
denial_reasonstringRequired within parentWhy the action cannot be performed.
Known values: already_archived, associated_with_bills, associated_with_transactions, no_permission, not_pending, pending_change_order, request_rejected
statusstringRequired within parentWhether the action can be performed.
Must equal: denied

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 available actions v2 edit primary fields

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_EditPrimaryFieldsDenialReason_"}, "propertyName": "status"}
$ (anyOf 1)ModelAlternativeExpand Fetch a vendor agreement — response body — available actions delete status allowed
$ (anyOf 2)ModelAlternativeExpand 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 available actions v2 edit primary fields status denied

Referenced models: Fetch a vendor agreement — response body — available actions delete status allowed, 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 available actions v2 edit primary fields status denied

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 available actions v2 edit primary fields status denied

FieldTypePresenceDescription and constraints
$objectRoot
denial_reasonstringRequired within parentWhy the action cannot be performed.
Known values: approval_generation_incomplete, archived, fund_request_not_pending, no_permission
statusstringRequired within parentWhether the action can be performed.
Must equal: denied

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 spending restrictions

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONOptional
amount (anyOf 1)numberAlternative
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_detailsJSONRequired within parent
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
amount_details (anyOf 2)nullAlternative
categories_blacklistarrayOptional
categories_blacklist[]JSONEach item
categories_blacklist[] (anyOf 1)integerAlternative
categories_blacklist[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
categories_whitelistarrayOptional
categories_whitelist[]JSONEach item
categories_whitelist[] (anyOf 1)integerAlternative
categories_whitelist[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencyModelOptionalExpand 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 spending restrictions currency
intervalstringRequired within parentKnown values: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
lock_dateJSONOptional
lock_date (anyOf 1)stringAlternativeFormat: date-time
lock_date (anyOf 2)nullAlternative
lock_displayJSONOptional
lock_display (anyOf 1)stringAlternative
lock_display (anyOf 2)nullAlternative
relative_lock_duration_countJSONOptional
relative_lock_duration_count (anyOf 1)JSONAlternative
relative_lock_duration_count (anyOf 1) (anyOf 1)integerAlternative
relative_lock_duration_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
relative_lock_duration_count (anyOf 2)nullAlternative
relative_lock_duration_unitJSONOptional
relative_lock_duration_unit (anyOf 1)stringAlternativeKnown values: DAYS, MONTHS, WEEKS, YEARS
relative_lock_duration_unit (anyOf 2)nullAlternative
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeFormat: date-time
start_date (anyOf 2)nullAlternative
transaction_amount_limitJSONOptional
transaction_amount_limit (anyOf 1)JSONAlternative
transaction_amount_limit (anyOf 1) (anyOf 1)numberAlternative
transaction_amount_limit (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
transaction_amount_limit (anyOf 2)nullAlternative
vendor_blacklistarrayOptional
vendor_blacklist[]JSONEach item
vendor_blacklist[] (anyOf 1)integerAlternative
vendor_blacklist[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
vendor_whitelistarrayOptional
vendor_whitelist[]JSONEach item
vendor_whitelist[] (anyOf 1)integerAlternative
vendor_whitelist[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: 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 spending restrictions currency, 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

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 spending restrictions currency

FieldTypePresenceDescription and constraints
$objectRoot
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
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]+)?$

Get a unified request — response body — 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 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings
$ (allOf 2)ModelAll variants applyExpand 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
$ (allOf 3)objectAll variants apply
$ (allOf 3).approval_chain_dataJSONRequired within parent
$ (allOf 3).approval_chain_data (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 approval chain data
Traditional approval-chain state, or null when approvals use a Blank Canvas execution.
Read only: true
$ (allOf 3).approval_chain_data (anyOf 2)nullAlternative
$ (allOf 3).approval_eventsarrayRequired within parentApproval-chain history belonging to this restoration request.
Read only: true
$ (allOf 3).approval_events[]ModelEach itemExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid approval events item
$ (allOf 3).archival_contextJSONRequired within parent
$ (allOf 3).archival_context (anyOf 1)ModelAlternativeExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid archival context archive actor, archive reason, archive source, archived at
Provenance of the exact archival event targeted by this request.
Read only: true
$ (allOf 3).archival_context (anyOf 2)nullAlternative
$ (allOf 3).current_fund_settingsJSONRequired within parent
$ (allOf 3).current_fund_settings (anyOf 1)ModelAlternativeExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid current fund settings accounting auto mark ready rule enabled, amount details, archive date, default transaction memo, members, owner, spend allocation, spend frequency, spending restrictions, submission policy id
Current read-only settings of the original fund, not proposed changes.
Read only: true
$ (allOf 3).current_fund_settings (anyOf 2)nullAlternative
$ (allOf 3).original_spend_allocation_uuidJSONRequired within parent
$ (allOf 3).original_spend_allocation_uuid (anyOf 1)stringAlternativeIdentity of the original fund targeted for restoration, not a newly issued fund.
Format: uuid
Read only: true
$ (allOf 3).original_spend_allocation_uuid (anyOf 2)nullAlternative

Referenced models: Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid archival context archive actor, archive reason, archive source, archived at, 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 approval chain data, Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid approval events 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings, Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid current fund settings accounting auto mark ready rule enabled, amount details, archive date, default transaction memo, members, owner, spend allocation, spend frequency, spending restrictions, submission policy id, 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

Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid approval events item

FieldTypePresenceDescription and constraints
$objectRoot
_ramp_event_typestringRequired within parent
acting_user_idJSONRequired within parent
acting_user_id (anyOf 1)JSONAlternative
acting_user_id (anyOf 1) (anyOf 1)integerAlternativeDefault: null
acting_user_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
acting_user_id (anyOf 2)nullAlternative
approval_chain_eventsJSONRequired within parent
approval_chain_events (anyOf 1)arrayAlternative
approval_chain_events (anyOf 1)[]ModelEach itemExpand 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 sanitized approval steps array item
approval_chain_events (anyOf 2)nullAlternative
datestringRequired within parent
displayed_event_textstringRequired within parent
event_orderJSONRequired within parent
event_order (anyOf 1)integerAlternative
event_order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
event_typestringRequired within parent
is_change_requestbooleanRequired within parentWhether this rejection requested changes to the reimbursement.
Default: false
notesJSONRequired within parent
notes (anyOf 1)JSONAlternativeDefault: null
notes (anyOf 1) (anyOf 1)ModelAlternativeExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid approval events item notes value download, format type, url, value
notes (anyOf 1) (anyOf 2)stringAlternative
notes (anyOf 2)nullAlternative

Referenced models: Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid approval events item notes value download, format type, url, value, 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 sanitized approval steps array item

Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid approval events item notes value download, format type, url, value

FieldTypePresenceDescription and constraints
$objectRoot
downloadJSONRequired within parent
download (anyOf 1)ModelAlternativeExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid approval events item notes value download, format type, url, value download resource: GET PURCHASE ORDER SENT PDF, GET REIMBURSEMENT PAYMENT RECEIPT
Default: null
download (anyOf 2)nullAlternative
format_typestringRequired within parentKnown values: DOWNLOAD_LINK, EMAIL, ICON, LINK, PHONE, PHONE_STRIKETHROUGH, STRIKETHROUGH, STRING
urlJSONRequired within parent
url (anyOf 1)stringAlternativeDefault: null
url (anyOf 2)nullAlternative
valuestringRequired within parent

Referenced models: Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid approval events item notes value download, format type, url, value download resource: GET PURCHASE ORDER SENT PDF, GET REIMBURSEMENT PAYMENT RECEIPT

Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid approval events item notes value download, format type, url, value download resource: GET PURCHASE ORDER SENT PDF, GET REIMBURSEMENT PAYMENT RECEIPT

FieldTypePresenceDescription and constraints
$objectRoot
request_paramsobjectRequired within parentAdditional keys: see wildcard field
request_params.*JSONAdditional keys
request_params.* (anyOf 1)JSONAlternative
request_params.* (anyOf 2)nullAlternative
resourcestringRequired within parentKnown values: GET_PURCHASE_ORDER_SENT_PDF, GET_REIMBURSEMENT_PAYMENT_RECEIPT

Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid archival context archive actor, archive reason, archive source, archived at

FieldTypePresenceDescription and constraints
$objectRoot
archive_actorJSONRequired within parent
archive_actor (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 members item
User responsible for archival, or null for system archival.
archive_actor (anyOf 2)nullAlternative
archive_reasonJSONRequired within parent
archive_reason (anyOf 1)stringAlternativeExplanation recorded on the archival event, if available.
archive_reason (anyOf 2)nullAlternative
archive_sourcestringRequired within parentRecorded source of the targeted archival event.
archived_atstringRequired within parentTimestamp of the archival event this request targets.
Format: date-time

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 members item

Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE approval chain data, approval events, archival context, current fund settings, original spend allocation uuid current fund settings accounting auto mark ready rule enabled, amount details, archive date, default transaction memo, members, owner, spend allocation, spend frequency, spending restrictions, submission policy id

FieldTypePresenceDescription and constraints
$objectRoot
accounting_auto_mark_ready_rule_enabledbooleanRequired within parentWhether fund transactions are automatically marked ready for accounting.
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
Current funding amount and currency, not a proposed change.
Read only: true
archive_dateJSONRequired within parent
archive_date (anyOf 1)stringAlternativeDate when the fund will be automatically archived, if configured.
Format: date-time
archive_date (anyOf 2)nullAlternative
default_transaction_memoJSONRequired within parent
default_transaction_memo (anyOf 1)stringAlternativeDefault memo applied to transactions using the fund.
default_transaction_memo (anyOf 2)nullAlternative
membersarrayRequired within parentUsers currently assigned to the fund.
members[]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 members item
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
Current owner of the original fund.
Read only: true
spend_allocationJSONRequired within parent
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
The original fund targeted for restoration.
spend_allocation (anyOf 2)nullAlternative
spend_frequencyJSONRequired within parent
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
Current spending frequency configured for the fund.
spend_frequency (anyOf 2)nullAlternative
spending_restrictionsModelRequired within parentExpand 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 spending restrictions
Current transaction restrictions configured for the fund.
Read only: true
submission_policy_idJSONRequired within parent
submission_policy_id (anyOf 1)stringAlternativeUUID of the fund's transaction submission policy, if configured.
Read only: true
submission_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: 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: 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: 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, 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, 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 spending restrictions, 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 members 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings
$ (allOf 2)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
$ (allOf 3)objectAll variants apply
$ (allOf 3).approval_chain_dataModelRequired 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 approval chain data
Read only: true
$ (allOf 3).attendees_countJSONRequired within parent
$ (allOf 3).attendees_count (anyOf 1)integerAlternativeRead only: true
$ (allOf 3).attendees_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 3).available_actionsModelRequired 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 available actions
Read only: true
$ (allOf 3).group_tripJSONRequired within parent
$ (allOf 3).group_trip (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 group trip id
Read only: true
$ (allOf 3).group_trip (anyOf 2)nullAlternative
$ (allOf 3).membersarrayRequired within parent
$ (allOf 3).members[]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 members item
$ (allOf 3).spend_allocation_outcome_settingsJSONRequired within parent
$ (allOf 3).spend_allocation_outcome_settings (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
Read only: true
$ (allOf 3).spend_allocation_outcome_settings (anyOf 2)nullAlternative
$ (allOf 3).travel_metadataModelRequired 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
Read only: true
$ (allOf 3).tripJSONRequired within parent
$ (allOf 3).trip (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 trip id, trip name
Read only: true
$ (allOf 3).trip (anyOf 2)nullAlternative

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 approval chain data, 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings, 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 group trip id, 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, 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 available actions, 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, 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, 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, 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 members 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings ai intake thread id, ai request copilot thread id, savings
$ (allOf 2)objectAll variants apply
$ (allOf 2).allowed_overage_percentJSONRequired within parent
$ (allOf 2).allowed_overage_percent (anyOf 1)JSONAlternative
$ (allOf 2).allowed_overage_percent (anyOf 1) (anyOf 1)numberAlternativeRead only: true
$ (allOf 2).allowed_overage_percent (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).allowed_overage_percent (anyOf 2)nullAlternative
$ (allOf 2).approver_commentJSONOptional
$ (allOf 2).approver_comment (anyOf 1)stringAlternative
$ (allOf 2).approver_comment (anyOf 2)nullAlternative
$ (allOf 2).budget_pathJSONRequired within parent
$ (allOf 2).budget_path (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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid budget path amount details, path entities, path id
Read only: true
$ (allOf 2).budget_path (anyOf 2)nullAlternative
$ (allOf 2).change_request_custom_form_collection_response_uuidJSONOptional
$ (allOf 2).change_request_custom_form_collection_response_uuid (anyOf 1)stringAlternativeFormat: uuid
$ (allOf 2).change_request_custom_form_collection_response_uuid (anyOf 2)nullAlternative
$ (allOf 2).comment_thread_uuidJSONRequired within parent
$ (allOf 2).comment_thread_uuid (anyOf 1)stringAlternativeRead only: true
$ (allOf 2).comment_thread_uuid (anyOf 2)nullAlternative
$ (allOf 2).custom_form_collection_response_uuidJSONOptional
$ (allOf 2).custom_form_collection_response_uuid (anyOf 1)stringAlternativeFormat: uuid
$ (allOf 2).custom_form_collection_response_uuid (anyOf 2)nullAlternative
$ (allOf 2).deleted_by_userJSONOptional
$ (allOf 2).deleted_by_user (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
$ (allOf 2).deleted_by_user (anyOf 2)nullAlternative
$ (allOf 2).deleted_reasonJSONOptional
$ (allOf 2).deleted_reason (anyOf 1)stringAlternative
$ (allOf 2).deleted_reason (anyOf 2)nullAlternative
$ (allOf 2).display_request_numberJSONRequired within parent
$ (allOf 2).display_request_number (anyOf 1)stringAlternativeHuman-readable request number, e.g. "REQ-123"; null until one is assigned.
Read only: true
$ (allOf 2).display_request_number (anyOf 2)nullAlternative
$ (allOf 2).internal_memoJSONOptional
$ (allOf 2).internal_memo (anyOf 1)stringAlternative
$ (allOf 2).internal_memo (anyOf 2)nullAlternative
$ (allOf 2).pending_change_requestJSONOptional
$ (allOf 2).pending_change_request (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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid pending change request submitted at, uuid
$ (allOf 2).pending_change_request (anyOf 2)nullAlternative
$ (allOf 2).ramp_event_history_uuidJSONRequired within parent
$ (allOf 2).ramp_event_history_uuid (anyOf 1)stringAlternativeRead only: true
$ (allOf 2).ramp_event_history_uuid (anyOf 2)nullAlternative

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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings ai intake thread id, ai request copilot thread id, savings, 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid budget path amount details, path entities, path id, 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid pending change request submitted at, 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

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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings ai intake thread id, ai request copilot thread id, savings

FieldTypePresenceDescription and constraints
$objectRoot
ai_intake_thread_idJSONRequired within parent
ai_intake_thread_id (anyOf 1)stringAlternativeRead only: true
ai_intake_thread_id (anyOf 2)nullAlternative
ai_request_copilot_thread_idJSONRequired within parent
ai_request_copilot_thread_id (anyOf 1)stringAlternativeRead only: true
ai_request_copilot_thread_id (anyOf 2)nullAlternative
savingsarrayRequired within parentRead only: true
savings[]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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings ai intake thread id, ai request copilot thread id, savings savings item

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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings ai intake thread id, ai request copilot thread id, savings savings 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings ai intake thread id, ai request copilot thread id, savings savings item

FieldTypePresenceDescription and constraints
$objectRootResponse for a single SpendRequestSaving
amount_savedJSONRequired within parent
amount_saved (anyOf 1)numberAlternative
amount_saved (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
attributed_usersarrayOptionalDefault: []
attributed_users[]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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings ai intake thread id, ai request copilot thread id, savings savings item attributed users item
commentstringRequired within parent
created_atstringRequired within parentFormat: date-time
idstringRequired within parent
typestringRequired within parent
updated_atstringRequired within parentFormat: date-time

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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings ai intake thread id, ai request copilot thread id, savings savings item attributed users 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings ai intake thread id, ai request copilot thread id, savings savings item attributed users item

FieldTypePresenceDescription and constraints
$objectRootResponse schema for a user attributed to a saving.
full_namestringRequired within parent
idstringRequired 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid budget path amount details, path entities, path id

FieldTypePresenceDescription and constraints
$objectRoot
amount_detailsModelRequired 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid budget path amount details, path entities, path id amount details
path_entitiesarrayRequired within parent
path_entities[]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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid budget path amount details, path entities, path id path entities item
path_idstringRequired 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid budget path amount details, path entities, path id amount details, 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid budget path amount details, path entities, path id path entities 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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid budget path amount details, path entities, path id amount details

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternative
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
budget_amountJSONRequired within parent
budget_amount (anyOf 1)JSONAlternative
budget_amount (anyOf 1) (anyOf 1)numberAlternative
budget_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
budget_amount (anyOf 2)nullAlternative
committed_amountJSONRequired within parent
committed_amount (anyOf 1)numberAlternative
committed_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issued_amountJSONRequired within parent
issued_amount (anyOf 1)numberAlternative
issued_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
varianceJSONRequired within parent
variance (anyOf 1)JSONAlternative
variance (anyOf 1) (anyOf 1)numberAlternative
variance (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
variance (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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid budget path amount details, path entities, path id path entities item

FieldTypePresenceDescription and constraints
$objectRoot
budget_entity_cell_idstringRequired within parent
column_idstringRequired within parent
column_positionJSONRequired within parent
column_position (anyOf 1)integerAlternative
column_position (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
entity_id_for_filterJSONRequired within parent
entity_id_for_filter (anyOf 1)JSONAlternative
entity_id_for_filter (anyOf 1) (anyOf 1)integerAlternative
entity_id_for_filter (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
entity_id_for_filter (anyOf 2)stringAlternative
entity_namestringRequired within parent
tracking_category_uuidJSONOptional
tracking_category_uuid (anyOf 1)stringAlternativeDefault: null
tracking_category_uuid (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 ai intake thread id, ai request copilot thread id, allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid, savings allowed overage percent, approver comment, budget path, change request custom form collection response uuid, comment thread uuid, custom form collection response uuid, deleted by user, deleted reason, display request number, internal memo, pending change request, ramp event history uuid pending change request submitted at, uuid

FieldTypePresenceDescription and constraints
$objectRoot
submitted_atstringRequired within parentFormat: date-time
uuidstringRequired 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 approval chain data

FieldTypePresenceDescription and constraints
$objectRoot
approval_instance_uuidJSONRequired within parent
approval_instance_uuid (anyOf 1)stringAlternativeDefault: null
approval_instance_uuid (anyOf 2)nullAlternative
approval_trigger_instance_error_messageJSONRequired within parent
approval_trigger_instance_error_message (anyOf 1)stringAlternativeDefault: null
approval_trigger_instance_error_message (anyOf 2)nullAlternative
approval_trigger_instance_error_redirect_urlJSONRequired within parent
approval_trigger_instance_error_redirect_url (anyOf 1)stringAlternativeDefault: null
approval_trigger_instance_error_redirect_url (anyOf 2)nullAlternative
approval_trigger_typeJSONRequired within parent
approval_trigger_type (anyOf 1)stringAlternativeKnown values: GLOBAL_FORM_RESPONSE, IRONCLAD_WORKFLOW_GATE, LAUNCH_ESIGN_WORKFLOW, LAUNCH_EXTERNAL_APPROVAL, LAUNCH_IRONCLAD_WORKFLOW, LAUNCH_THIRD_PARTY_RISK_MANAGEMENT_VENDOR_REVIEW_WORKFLOW, LAUNCH_TICKETING_WORKFLOW, LAUNCH_VENDOR_ONBOARDING, SEND_BACK, WAIT_FOR_BOOKING_COMPLETION
Default: null
approval_trigger_type (anyOf 2)nullAlternative
is_delegatebooleanRequired within parentDefault: false
is_in_approval_reminder_cooldownJSONRequired within parent
is_in_approval_reminder_cooldown (anyOf 1)booleanAlternativeDefault: null
is_in_approval_reminder_cooldown (anyOf 2)nullAlternative
is_last_step_for_userbooleanRequired within parentDefault: false
needs_user_actionbooleanRequired within parentDefault: false
needs_user_trigger_actionbooleanRequired within parentDefault: false
reminder_communication_last_sent_atJSONRequired within parent
reminder_communication_last_sent_at (anyOf 1)stringAlternativeDefault: null
reminder_communication_last_sent_at (anyOf 2)nullAlternative
revert_noteJSONRequired within parent
revert_note (anyOf 1)stringAlternativeDefault: null
revert_note (anyOf 2)nullAlternative
revert_note_authorJSONRequired within parent
revert_note_author (anyOf 1)stringAlternativeDefault: null
revert_note_author (anyOf 2)nullAlternative
statusstringRequired within parentKnown values: APPROVED, INITIALIZED, PENDING, REJECTED, TERMINATED

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 available actions

FieldTypePresenceDescription and constraints
$objectRoot
archiveModelRequired 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 available actions edit
editModelRequired 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 available actions edit

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 available actions edit

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 available actions edit

FieldTypePresenceDescription and constraints
$objectRoot
can_performbooleanRequired within parent
denial_reasonJSONRequired within parent
denial_reason (anyOf 1)stringAlternative
denial_reason (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 group trip id

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired 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 members item

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parent
first_namestringRequired within parent
has_set_namebooleanOptionalRead only: true
idstringRequired within parent
is_deletedbooleanRequired within parent
is_inactivebooleanRequired within parent
is_preloadedbooleanRequired within parent
last_namestringRequired within parent
profile_picture_urlJSONRequired within parent
profile_picture_url (anyOf 1)stringAlternative
profile_picture_url (anyOf 2)nullAlternative

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.