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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
acting_user | JSON | Optional | |
acting_user (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
resolution_reason | JSON | Required within parent | |
resolution_reason (anyOf 1) | string | Alternative | Known 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) | null | Alternative | |
tracking_category | Model | Required within parent | Expand 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_id | JSON | Required within parent | |
tracking_category_id (anyOf 1) | integer | Alternative | |
tracking_category_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tracking_category_option | Model | Required within parent | Expand 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_id | JSON | Required within parent | |
workflow_condition_id (anyOf 1) | string | Alternative | |
workflow_condition_id (anyOf 2) | null | Alternative | |
workflow_rule_uuid | JSON | Required within parent | |
workflow_rule_uuid (anyOf 1) | string | Alternative | |
workflow_rule_uuid (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_tracking_category_selections | array | Required within parent | Read only: true |
accounting_tracking_category_selections[] | Model | Each item | Expand 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 |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
custom_field_values | array | Required within parent | Read only: true |
custom_field_values[] | Model | Each item | Expand Fetch a purchase order — response body — line items item custom field values item |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
due_date | JSON | Required within parent | |
due_date (anyOf 1) | string | Alternative | Format: date |
due_date (anyOf 2) | null | Alternative | |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | Format: date |
end_date (anyOf 2) | null | Alternative | |
existing_purchase_order_line_item_uuid | JSON | Required within parent | |
existing_purchase_order_line_item_uuid (anyOf 1) | string | Alternative | Format: uuid |
existing_purchase_order_line_item_uuid (anyOf 2) | null | Alternative | |
id | string | Required within parent | Read only: true |
line_item_type | string | Required within parent | Known values: EXPENSE, ITEM |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | |
receiving_type | string | Optional | How the line is received: by quantity or by amount. Known values: by_amount, by_quantity |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | Format: date |
start_date (anyOf 2) | null | Alternative | |
tax_amounts | array | Required within parent | Tax amounts applied to this purchase order line item. Read only: true |
tax_amounts[] | Model | Each item | Expand 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_amount | JSON | Required within parent | |
total_amount (anyOf 1) | number | Alternative | |
total_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unit_price | JSON | Required within parent | |
unit_price (anyOf 1) | JSON | Alternative | |
unit_price (anyOf 1) (anyOf 1) | number | Alternative | |
unit_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unit_price (anyOf 2) | null | Alternative | |
unit_quantity | JSON | Required within parent | |
unit_quantity (anyOf 1) | JSON | Alternative | |
unit_quantity (anyOf 1) (anyOf 1) | number | Alternative | Deprecated: read from quantity field instead Read only: true |
unit_quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unit_quantity (anyOf 2) | null | Alternative | |
uuid | string | Required within parent | Read only: true |
withholding_rate | JSON | Optional | |
withholding_rate (anyOf 1) | string | Alternative | Retainage withholding rate for the line item Format: decimal |
withholding_rate (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | Tax amount in the purchase order currency. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | Name of the accounting tax rate. |
rate | string | Required within parent | Accounting tax rate as a decimal fraction. |
tax_rate_uuid | string | Required within parent | UUID 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
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
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
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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_payment_terms | boolean | Optional | |
is_suitetax_enabled | boolean | Optional | |
vendor_creation_enabled | boolean | Optional |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity_type | string | Optional | Known values: ADVANCED_INTERCOMPANY_JOURNAL_ENTRY, BILL, BILL_PAYMENT, CHECK, DEPOSIT, INVOICE, JOURNAL, PURCHASE_ORDER, TRANSACTION, UNUSED |
is_required | boolean | Optional | |
ramp_entity_type | JSON | Optional | |
ramp_entity_type (anyOf 1) | string | Alternative | Known values: BILL, BILL_PAYMENT, CUSTOMER, INVOICE, PURCHASE_ORDER, REIMBURSEMENT, SPEND_PROGRAM, TRANSACTION, TRANSFER_LEDGER_ENTRY_MAPPING, VENDOR_CREDIT |
ramp_entity_type (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_data | JSON | Required within parent | |
additional_data (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Base 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) | null | Alternative | |
display_name_prefix | JSON | Optional | |
display_name_prefix (anyOf 1) | string | Alternative | Optional 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) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
is_active | boolean | Required within parent | |
label | string | Required within parent | Displays the code and title. This is meant to be used when there is only one line displayed in the UI. |
parent | Model | Optional | Expand 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_types | Model | Optional | Expand 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_code | JSON | Required within parent | |
remote_code (anyOf 1) | string | Alternative | |
remote_code (anyOf 2) | null | Alternative | |
remote_id | JSON | Required within parent | |
remote_id (anyOf 1) | string | Alternative | The provider-side identifier for the option. Usually ERP-owned; for universal_csv it can be updated via the PATCH endpoint. |
remote_id (anyOf 2) | null | Alternative | |
remote_name | string | Required within parent | The 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. |
subtitle | JSON | Required within parent | |
subtitle (anyOf 1) | string | Alternative | Displays 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) | null | Alternative | |
title | string | Required within parent | The 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. |
uuid | string | Required within parent | Format: uuid |
visibility | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_classification | JSON | Optional | |
account_classification (anyOf 1) | string | Alternative | Known values: ANY, ASSET, CREDCARD, EQUITY, EXPENSE, LIABILITY, REVENUE, UNKNOWN |
account_classification (anyOf 2) | null | Alternative | |
cost | JSON | Optional | |
cost (anyOf 1) | number | Alternative | |
cost (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency_iso | string | Optional | |
description | string | Optional | |
group_title | string | Optional | |
is_job | boolean | Optional | |
is_lot_numbered | boolean | Optional | Whether this inventory item is lot-numbered in the ERP. |
item_receipt_unapplicable | boolean | Optional | |
quantity_decimal_places | JSON | Optional | |
quantity_decimal_places (anyOf 1) | integer | Alternative | |
quantity_decimal_places (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
subsidiary | array | Optional | |
subsidiary[] | string | Each item | |
tax_rates | array | Optional | |
tax_rates[] | string | Each 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
remote_name | string | Required 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | How a PO line coded to an inventory item may be received. |
available_types | array | Required within parent | Receiving types a PO line coded to this inventory item may use. |
available_types[] | string | Each item | How a purchase order line is received and matched: by quantity or by amount. Known values: by_amount, by_quantity |
default_type | string | Required within parent | How 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completed_at | JSON | Required within parent | |
completed_at (anyOf 1) | string | Alternative | Format: date-time |
completed_at (anyOf 2) | null | Alternative | |
state | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allow_none | JSON | Required within parent | |
allow_none (anyOf 1) | boolean | Alternative | |
allow_none (anyOf 2) | null | Alternative | |
default_tracking_category_option | JSON | Required within parent | |
default_tracking_category_option (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Nullable raw settings override. Do not use for display; use the top-level TrackingCategory.display_name canonical effective label. |
display_name (anyOf 2) | null | Alternative | |
display_order | JSON | Required within parent | |
display_order (anyOf 1) | JSON | Alternative | |
display_order (anyOf 1) (anyOf 1) | integer | Alternative | |
display_order (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
display_order (anyOf 2) | null | Alternative | |
exclude_bill_payments_from_ai_suggestions | JSON | Optional | |
exclude_bill_payments_from_ai_suggestions (anyOf 1) | boolean | Alternative | Exclude bill payments from AI suggestions. Null inherits is_excluded_from_ai_suggestions. |
exclude_bill_payments_from_ai_suggestions (anyOf 2) | null | Alternative | |
exclude_bills_from_ai_suggestions | JSON | Optional | |
exclude_bills_from_ai_suggestions (anyOf 1) | boolean | Alternative | Exclude bills from AI suggestions. Null inherits is_excluded_from_ai_suggestions. |
exclude_bills_from_ai_suggestions (anyOf 2) | null | Alternative | |
exclude_purchase_orders_from_ai_suggestions | JSON | Optional | |
exclude_purchase_orders_from_ai_suggestions (anyOf 1) | boolean | Alternative | Exclude purchase orders from AI suggestions. Null inherits is_excluded_from_ai_suggestions. |
exclude_purchase_orders_from_ai_suggestions (anyOf 2) | null | Alternative | |
exclude_reimbursements_from_ai_suggestions | JSON | Optional | |
exclude_reimbursements_from_ai_suggestions (anyOf 1) | boolean | Alternative | Exclude reimbursements from AI suggestions. Null inherits is_excluded_from_ai_suggestions. |
exclude_reimbursements_from_ai_suggestions (anyOf 2) | null | Alternative | |
exclude_transactions_from_ai_suggestions | JSON | Optional | |
exclude_transactions_from_ai_suggestions (anyOf 1) | boolean | Alternative | Exclude transactions from AI suggestions. Null inherits is_excluded_from_ai_suggestions. |
exclude_transactions_from_ai_suggestions (anyOf 2) | null | Alternative | |
exclude_wallet_transfers_from_ai_suggestions | JSON | Optional | |
exclude_wallet_transfers_from_ai_suggestions (anyOf 1) | boolean | Alternative | Exclude wallet transfers from AI suggestions. Null inherits is_excluded_from_ai_suggestions. |
exclude_wallet_transfers_from_ai_suggestions (anyOf 2) | null | Alternative | |
helper_text | JSON | Required within parent | |
helper_text (anyOf 1) | string | Alternative | |
helper_text (anyOf 2) | null | Alternative | |
is_excluded_from_ai_suggestions | boolean | Required within parent | |
is_hidden | boolean | Required within parent | |
is_receipt_extra_schema_enabled | boolean | Required within parent | |
option_filter_workflow_id | JSON | Required within parent | |
option_filter_workflow_id (anyOf 1) | string | Alternative | Format: uuid |
option_filter_workflow_id (anyOf 2) | null | Alternative | |
receipt_extra_schema_description | JSON | Required within parent | |
receipt_extra_schema_description (anyOf 1) | string | Alternative | Default: null |
receipt_extra_schema_description (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | Format: date-time |
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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_ArchiveDenialReason_"}, "propertyName": "status"} |
$ (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions delete status allowed |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
denial_reason | string | Required within parent | Why the action cannot be performed. Known values: already_archived, associated_with_bills, associated_with_transactions, no_permission, not_pending, pending_change_order, request_rejected |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_EditPrimaryFieldsDenialReason_"}, "propertyName": "status"} |
$ (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions delete status allowed |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
denial_reason | string | Required within parent | Why the action cannot be performed. Known values: approval_generation_incomplete, archived, fund_request_not_pending, no_permission |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | number | Alternative | |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_details | JSON | Required within parent | |
amount_details (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
categories_blacklist | array | Optional | |
categories_blacklist[] | JSON | Each item | |
categories_blacklist[] (anyOf 1) | integer | Alternative | |
categories_blacklist[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
categories_whitelist | array | Optional | |
categories_whitelist[] | JSON | Each item | |
categories_whitelist[] (anyOf 1) | integer | Alternative | |
categories_whitelist[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | Model | Optional | Expand 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 |
interval | string | Required within parent | Known values: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY |
lock_date | JSON | Optional | |
lock_date (anyOf 1) | string | Alternative | Format: date-time |
lock_date (anyOf 2) | null | Alternative | |
lock_display | JSON | Optional | |
lock_display (anyOf 1) | string | Alternative | |
lock_display (anyOf 2) | null | Alternative | |
relative_lock_duration_count | JSON | Optional | |
relative_lock_duration_count (anyOf 1) | JSON | Alternative | |
relative_lock_duration_count (anyOf 1) (anyOf 1) | integer | Alternative | |
relative_lock_duration_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
relative_lock_duration_count (anyOf 2) | null | Alternative | |
relative_lock_duration_unit | JSON | Optional | |
relative_lock_duration_unit (anyOf 1) | string | Alternative | Known values: DAYS, MONTHS, WEEKS, YEARS |
relative_lock_duration_unit (anyOf 2) | null | Alternative | |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | Format: date-time |
start_date (anyOf 2) | null | Alternative | |
transaction_amount_limit | JSON | Optional | |
transaction_amount_limit (anyOf 1) | JSON | Alternative | |
transaction_amount_limit (anyOf 1) (anyOf 1) | number | Alternative | |
transaction_amount_limit (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
transaction_amount_limit (anyOf 2) | null | Alternative | |
vendor_blacklist | array | Optional | |
vendor_blacklist[] | JSON | Each item | |
vendor_blacklist[] (anyOf 1) | integer | Alternative | |
vendor_blacklist[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
vendor_whitelist | array | Optional | |
vendor_whitelist[] | JSON | Each item | |
vendor_whitelist[] (anyOf 1) | integer | Alternative | |
vendor_whitelist[] (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Required within parent | 3-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_sign | string | Required within parent | Currency sign (e.g. '$', '€') Read only: true |
name | string | Required within parent | Display name (e.g. 'US Dollar') Read only: true |
num_decimal_places | JSON | Required within parent | |
num_decimal_places (anyOf 1) | integer | Alternative | Number of decimal places to render. Read only: true |
num_decimal_places (anyOf 2) | string | Alternative | Pattern: ^-?[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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
_ramp_event_type | string | Required within parent | |
acting_user_id | JSON | Required within parent | |
acting_user_id (anyOf 1) | JSON | Alternative | |
acting_user_id (anyOf 1) (anyOf 1) | integer | Alternative | Default: null |
acting_user_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
acting_user_id (anyOf 2) | null | Alternative | |
approval_chain_events | JSON | Required within parent | |
approval_chain_events (anyOf 1) | array | Alternative | |
approval_chain_events (anyOf 1)[] | Model | Each item | Expand 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) | null | Alternative | |
date | string | Required within parent | |
displayed_event_text | string | Required within parent | |
event_order | JSON | Required within parent | |
event_order (anyOf 1) | integer | Alternative | |
event_order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
event_type | string | Required within parent | |
is_change_request | boolean | Required within parent | Whether this rejection requested changes to the reimbursement. Default: false |
notes | JSON | Required within parent | |
notes (anyOf 1) | JSON | Alternative | Default: null |
notes (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | string | Alternative | |
notes (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
download | JSON | Required within parent | |
download (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
format_type | string | Required within parent | Known values: DOWNLOAD_LINK, EMAIL, ICON, LINK, PHONE, PHONE_STRIKETHROUGH, STRIKETHROUGH, STRING |
url | JSON | Required within parent | |
url (anyOf 1) | string | Alternative | Default: null |
url (anyOf 2) | null | Alternative | |
value | string | Required within parent |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
request_params | object | Required within parent | Additional keys: see wildcard field |
request_params.* | JSON | Additional keys | |
request_params.* (anyOf 1) | JSON | Alternative | |
request_params.* (anyOf 2) | null | Alternative | |
resource | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archive_actor | JSON | Required within parent | |
archive_actor (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
archive_reason | JSON | Required within parent | |
archive_reason (anyOf 1) | string | Alternative | Explanation recorded on the archival event, if available. |
archive_reason (anyOf 2) | null | Alternative | |
archive_source | string | Required within parent | Recorded source of the targeted archival event. |
archived_at | string | Required within parent | Timestamp of the archival event this request targets. Format: date-time |
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
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
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
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
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 attributed users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response schema for a user attributed to a saving. |
full_name | string | Required within parent | |
id | string | Required 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
budget_amount | JSON | Required within parent | |
budget_amount (anyOf 1) | JSON | Alternative | |
budget_amount (anyOf 1) (anyOf 1) | number | Alternative | |
budget_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
budget_amount (anyOf 2) | null | Alternative | |
committed_amount | JSON | Required within parent | |
committed_amount (anyOf 1) | number | Alternative | |
committed_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issued_amount | JSON | Required within parent | |
issued_amount (anyOf 1) | number | Alternative | |
issued_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
variance | JSON | Required within parent | |
variance (anyOf 1) | JSON | Alternative | |
variance (anyOf 1) (anyOf 1) | number | Alternative | |
variance (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
variance (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
budget_entity_cell_id | string | Required within parent | |
column_id | string | Required within parent | |
column_position | JSON | Required within parent | |
column_position (anyOf 1) | integer | Alternative | |
column_position (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
entity_id_for_filter | JSON | Required within parent | |
entity_id_for_filter (anyOf 1) | JSON | Alternative | |
entity_id_for_filter (anyOf 1) (anyOf 1) | integer | Alternative | |
entity_id_for_filter (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
entity_id_for_filter (anyOf 2) | string | Alternative | |
entity_name | string | Required within parent | |
tracking_category_uuid | JSON | Optional | |
tracking_category_uuid (anyOf 1) | string | Alternative | Default: null |
tracking_category_uuid (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
submitted_at | string | Required within parent | Format: date-time |
uuid | string | Required 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_instance_uuid | JSON | Required within parent | |
approval_instance_uuid (anyOf 1) | string | Alternative | Default: null |
approval_instance_uuid (anyOf 2) | null | Alternative | |
approval_trigger_instance_error_message | JSON | Required within parent | |
approval_trigger_instance_error_message (anyOf 1) | string | Alternative | Default: null |
approval_trigger_instance_error_message (anyOf 2) | null | Alternative | |
approval_trigger_instance_error_redirect_url | JSON | Required within parent | |
approval_trigger_instance_error_redirect_url (anyOf 1) | string | Alternative | Default: null |
approval_trigger_instance_error_redirect_url (anyOf 2) | null | Alternative | |
approval_trigger_type | JSON | Required within parent | |
approval_trigger_type (anyOf 1) | string | Alternative | Known 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) | null | Alternative | |
is_delegate | boolean | Required within parent | Default: false |
is_in_approval_reminder_cooldown | JSON | Required within parent | |
is_in_approval_reminder_cooldown (anyOf 1) | boolean | Alternative | Default: null |
is_in_approval_reminder_cooldown (anyOf 2) | null | Alternative | |
is_last_step_for_user | boolean | Required within parent | Default: false |
needs_user_action | boolean | Required within parent | Default: false |
needs_user_trigger_action | boolean | Required within parent | Default: false |
reminder_communication_last_sent_at | JSON | Required within parent | |
reminder_communication_last_sent_at (anyOf 1) | string | Alternative | Default: null |
reminder_communication_last_sent_at (anyOf 2) | null | Alternative | |
revert_note | JSON | Required within parent | |
revert_note (anyOf 1) | string | Alternative | Default: null |
revert_note (anyOf 2) | null | Alternative | |
revert_note_author | JSON | Required within parent | |
revert_note_author (anyOf 1) | string | Alternative | Default: null |
revert_note_author (anyOf 2) | null | Alternative | |
status | string | Required within parent | Known 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
can_perform | boolean | Required within parent | |
denial_reason | JSON | Required within parent | |
denial_reason (anyOf 1) | string | Alternative | |
denial_reason (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | |
first_name | string | Required within parent | |
has_set_name | boolean | Optional | Read only: true |
id | string | Required within parent | |
is_deleted | boolean | Required within parent | |
is_inactive | boolean | Required within parent | |
is_preloaded | boolean | Required within parent | |
last_name | string | Required within parent | |
profile_picture_url | JSON | Required within parent | |
profile_picture_url (anyOf 1) | string | Alternative | |
profile_picture_url (anyOf 2) | null | Alternative |