Ramp: Unified request schemas (part 5)
47 Ramp schemas with complete fields and constraints.
← Unified request operations · All schemas
Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled, Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY submission policy, Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION accounting auto mark ready rule enabled, accounting rules, approval chain data, approval events, archive date, available actions, available actions v2, blank canvas execution id, default transaction memo, members, spending restrictions, submission policy id, travel metadata, trip accounting rules item
Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY submission policy
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Format: uuid |
is_default | boolean | Required within parent | |
name | 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 travel metadata
Referenced models: Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata travel location, Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata spend estimate line items item
Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata spend estimate line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | 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 travel metadata spend estimate line items item amount Read only: true |
category | string | Required within parent | Known values: CUSTOM, FLIGHT, LODGING, PER_DIEM |
id | string | Required within parent | |
label | 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 travel metadata spend estimate line items item amount
| 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]+)?$ |
currency | 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 travel metadata travel location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | |
city (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
lat | JSON | Optional | |
lat (anyOf 1) | JSON | Alternative | |
lat (anyOf 1) (anyOf 1) | number | Alternative | |
lat (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
lat (anyOf 2) | null | Alternative | |
lng | JSON | Optional | |
lng (anyOf 1) | JSON | Alternative | |
lng (anyOf 1) (anyOf 1) | number | Alternative | |
lng (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
lng (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | |
state (anyOf 2) | null | Alternative | |
timezone | string | Optional | |
trip_destination_id | JSON | Optional | |
trip_destination_id (anyOf 1) | string | Alternative | |
trip_destination_id (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 trip id, trip name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
trip_name | string | Required within parent |
List attachments on a procurement request — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachment_type | string | Required within parent | Type of attachment. PURCHASE_ORDER attachments are included in the purchase order PDF sent to the vendor; SPEND_REQUEST attachments are supporting documents on the request. Known values: PURCHASE_ORDER, SPEND_REQUEST |
created_at | string | Required within parent | Time at which the attachment was uploaded. Format: date-time |
download_url | JSON | Required within parent | |
download_url (anyOf 1) | string | Alternative | Pre-signed URL to download the attachment. Valid for 1 hour. Read only: true |
download_url (anyOf 2) | null | Alternative | |
filename | string | Required within parent | Original filename of the uploaded attachment. Read only: true |
id | string | Required within parent | Unique identifier of the attachment. Format: uuid |
source | string | Required within parent | Where the attachment originated from. Known values: DEVELOPER_API, DOCUSIGN, IRONCLAD, RAMP |
unified_request_id | string | Required within parent | Unique identifier of the request this attachment belongs to. Format: uuid Read only: true |
uploaded_by_user_id | JSON | Required within parent | |
uploaded_by_user_id (anyOf 1) | string | Alternative | Unique identifier of the user who uploaded the attachment. Format: uuid |
uploaded_by_user_id (anyOf 2) | null | Alternative |
List unified requests with pagination — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"SPEND_REQUEST": "#/components/schemas/UnifiedSpendRequest"}, "propertyName": "unified_request_type"} |
$ (anyOf 1) | Model | Alternative | Expand List unified requests with pagination — response body — item value |
Referenced models: List unified requests with pagination — response body — item value
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION issuance parameters is default allocation, is physical, is temporary edit requested, requesting physical card, temporary limit reset date, temporary limit start date, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION existing spend request amount details, id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION spend request type: SPEND LIMIT, unified spend request type: PROCUREMENT SPEND ALLOCATION spend allocation id, payment restrictions, submission policy, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION spending restrictions, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION prediction explanations, feedback, overall decision, prediction id, single sentence summary, system string rationale, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL spend request type: TRAVEL, unified spend request type: TRAVEL travel metadata
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | JSON | Optional | |
data (anyOf 1) | integer | Alternative | |
data (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
frequency | string | Required within parent | Known values: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION existing spend request amount details, id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION issuance parameters is default allocation, is physical, is temporary edit requested, requesting physical card, temporary limit reset date, temporary limit start date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_default_allocation | boolean | Optional | Approval sets the owner's default spend allocation (Ramp Card) limit instead of creating new funds. With requesting_physical_card, approval ships a physical primary card; otherwise it issues a virtual primary card. |
is_physical | boolean | Optional | |
is_temporary_edit_requested | boolean | Optional | |
requesting_physical_card | boolean | Optional | |
temporary_limit_reset_date | JSON | Optional | |
temporary_limit_reset_date (anyOf 1) | string | Alternative | Requested time to restore the original limit, if specified. Format: date-time |
temporary_limit_reset_date (anyOf 2) | null | Alternative | |
temporary_limit_start_date | JSON | Optional | |
temporary_limit_start_date (anyOf 1) | string | Alternative | Requested start time of the temporary limit increase, if specified. Format: date-time |
temporary_limit_start_date (anyOf 2) | null | Alternative |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
primary_card_enabled | boolean | Optional | Default: false |
reimbursements_enabled | boolean | Optional | Default: false |
virtual_card_enabled | boolean | Optional | Default: true |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
is_default | boolean | Required within parent | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION prediction explanations, feedback, overall decision, prediction id, single sentence summary, system string rationale
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
explanations | array | Optional | Per-bullet rationale strings explaining the prediction, produced by the policy agent's justification stage. Includes policy-citation-backed bullets and non-policy context bullets. Empty if the prediction predates the justification stage. |
explanations[] | string | Each item | |
feedback | array | Optional | |
feedback[] | Model | Each item | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION prediction explanations, feedback, overall decision, prediction id, single sentence summary, system string rationale feedback item |
overall_decision | string | Required within parent | |
prediction_id | string | Required within parent | |
single_sentence_summary | string | Optional | Deprecated: use explanations instead. Default: |
system_string_rationale | string | Required within parent | Deprecated: use explanations instead. The single synthesized rationale string from the policy agent's evaluation stage. |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION prediction explanations, feedback, overall decision, prediction id, single sentence summary, system string rationale feedback item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
acting_user_uuid | string | Required within parent | |
created_at | string | Required within parent | Format: date-time |
feedback_comment | JSON | Required within parent | |
feedback_comment (anyOf 1) | string | Alternative | |
feedback_comment (anyOf 2) | null | Alternative | |
feedback_type | string | Required within parent | Type of feedback provided by the user. Known values: negative, positive |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION spending restrictions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
interval | string | Required within parent | Known values: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).blank_canvas_execution_id | JSON | Required within parent | |
$ (allOf 2).blank_canvas_execution_id (anyOf 1) | string | Alternative | Format: uuid Read only: true |
$ (allOf 2).blank_canvas_execution_id (anyOf 2) | null | Alternative | |
$ (allOf 2).earliest_due_date | JSON | Required within parent | |
$ (allOf 2).earliest_due_date (anyOf 1) | string | Alternative | Format: date-time Read only: true |
$ (allOf 2).earliest_due_date (anyOf 2) | null | Alternative | |
$ (allOf 2).has_blocking_approval_requirements | JSON | Required within parent | |
$ (allOf 2).has_blocking_approval_requirements (anyOf 1) | boolean | Alternative | Read only: true |
$ (allOf 2).has_blocking_approval_requirements (anyOf 2) | null | Alternative | |
$ (allOf 2).is_expansion_request | boolean | Required within parent | Read only: true |
$ (allOf 2).is_import_only_spend_program | boolean | Required within parent | Read only: true |
$ (allOf 2).is_renewal_request | boolean | Required within parent | Read only: true |
$ (allOf 2).is_sla_due_soon | boolean | Required within parent | Read only: true |
$ (allOf 2).planned_outcome | JSON | Optional | |
$ (allOf 2).planned_outcome (anyOf 1) | string | Alternative | Selected outcome after approval, or null for program defaults. Read only: true |
$ (allOf 2).planned_outcome (anyOf 2) | null | Alternative | |
$ (allOf 2).reduced_agreements | array | Required within parent | Read only: true |
$ (allOf 2).reduced_agreements[] | Model | Each item | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks reduced agreements item |
$ (allOf 2).sla_due_date | JSON | Required within parent | |
$ (allOf 2).sla_due_date (anyOf 1) | string | Alternative | Format: date-time Read only: true |
$ (allOf 2).sla_due_date (anyOf 2) | null | Alternative | |
$ (allOf 2).sla_duration_in_seconds | JSON | Required within parent | |
$ (allOf 2).sla_duration_in_seconds (anyOf 1) | JSON | Alternative | |
$ (allOf 2).sla_duration_in_seconds (anyOf 1) (anyOf 1) | integer | Alternative | Read only: true |
$ (allOf 2).sla_duration_in_seconds (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).sla_duration_in_seconds (anyOf 2) | null | Alternative | |
$ (allOf 2).spend_end_date | JSON | Optional | |
$ (allOf 2).spend_end_date (anyOf 1) | string | Alternative | Format: date |
$ (allOf 2).spend_end_date (anyOf 2) | null | Alternative | |
$ (allOf 2).spend_frequency | JSON | Required within parent | |
$ (allOf 2).spend_frequency (anyOf 1) | Model | Alternative | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY |
$ (allOf 2).spend_frequency (anyOf 2) | null | Alternative | |
$ (allOf 2).spend_start_date | JSON | Optional | |
$ (allOf 2).spend_start_date (anyOf 1) | string | Alternative | Format: date |
$ (allOf 2).spend_start_date (anyOf 2) | null | Alternative | |
$ (allOf 2).tasks | array | Required within parent | Read only: true |
$ (allOf 2).tasks[] | Model | Each item | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item |
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks reduced agreements item, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks reduced agreements item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A reduced schema for PayeeAgreement used in unified request pagination. Contains only the essential fields needed to display agreement information in the context of a unified request pagination response. |
id | string | Required within parent | |
source | Model | Required within parent | 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 agreements item source |
status | string | Required within parent | Enum for status of `PayeeAgreementSpendRequestMapping` model A `PayeeAgreementSpendRequestMapping` object is in a `PENDING` state if the SpendRequest is in a draft state. We will upgrade the mapping to an `ACTIVE` state once the request is in a submitted state Known values: ACTIVE, PENDING |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item provider type: docusign, dropbox sign, task type LAUNCH ESIGN WORKFLOW, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type GLOBAL FORM RESPONSE, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type ticket, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA, task type LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA, task type LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
due_date | JSON | Optional | |
due_date (anyOf 1) | string | Alternative | Due date for the vendor review Default: null Format: date-time |
due_date (anyOf 2) | null | Alternative | |
external_review_link | string | Required within parent | External link to the vendor review in the TPRM provider |
node_title | JSON | Required within parent | |
node_title (anyOf 1) | string | Alternative | |
node_title (anyOf 2) | null | Alternative | |
provider_type | string | Required within parent | The TPRM provider type (e.g., Vanta) Known values: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA |
submitted_at | string | Required within parent | Format: date-time |
task_type | string | Required within parent | Must equal: LAUNCH_THIRD_PARTY_RISK_MANAGEMENT_VENDOR_REVIEW_WORKFLOW |
vendor_review_id | string | Required within parent | UUID of the vendor review |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item provider type: docusign, dropbox sign, task type LAUNCH ESIGN WORKFLOW
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
esign_envelope_id | JSON | Required within parent | |
esign_envelope_id (anyOf 1) | string | Alternative | |
esign_envelope_id (anyOf 2) | null | Alternative | |
esign_task_id | string | Required within parent | |
node_title | JSON | Required within parent | |
node_title (anyOf 1) | string | Alternative | |
node_title (anyOf 2) | null | Alternative | |
provider_type | string | Required within parent | Known values: docusign, dropbox_sign |
sla_due_date | JSON | Optional | |
sla_due_date (anyOf 1) | string | Alternative | Default: null Format: date-time |
sla_due_date (anyOf 2) | null | Alternative | |
sla_duration_in_seconds | JSON | Optional | |
sla_duration_in_seconds (anyOf 1) | JSON | Alternative | |
sla_duration_in_seconds (anyOf 1) (anyOf 1) | integer | Alternative | Default: null |
sla_duration_in_seconds (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sla_duration_in_seconds (anyOf 2) | null | Alternative | |
submitted_at | string | Required within parent | Format: date-time |
task_type | string | Required within parent | Must equal: LAUNCH_ESIGN_WORKFLOW |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type GLOBAL FORM RESPONSE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
global_form_response_task_id | string | Required within parent | |
global_form_response_task_previews | array | Required within parent | |
global_form_response_task_previews[] | Model | Each item | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type GLOBAL FORM RESPONSE global form response task previews item |
node_title | JSON | Required within parent | |
node_title (anyOf 1) | string | Alternative | |
node_title (anyOf 2) | null | Alternative | |
sla_due_date | JSON | Optional | |
sla_due_date (anyOf 1) | string | Alternative | Default: null Format: date-time |
sla_due_date (anyOf 2) | null | Alternative | |
sla_duration_in_seconds | JSON | Optional | |
sla_duration_in_seconds (anyOf 1) | JSON | Alternative | |
sla_duration_in_seconds (anyOf 1) (anyOf 1) | integer | Alternative | Default: null |
sla_duration_in_seconds (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sla_duration_in_seconds (anyOf 2) | null | Alternative | |
submitted_at | string | Required within parent | Format: date-time |
task_type | string | Required within parent | Must equal: GLOBAL_FORM_RESPONSE |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type GLOBAL FORM RESPONSE global form response task previews item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_form_collection_log_entry_label | JSON | Required within parent | |
custom_form_collection_log_entry_label (anyOf 1) | string | Alternative | |
custom_form_collection_log_entry_label (anyOf 2) | null | Alternative | |
custom_form_collection_log_entry_uuid | string | Required within parent | |
custom_form_collection_uuid | string | Required within parent | |
num_questions | JSON | Required within parent | |
num_questions (anyOf 1) | integer | Alternative | |
num_questions (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
num_questions_unconditional | JSON | Required within parent | |
num_questions_unconditional (anyOf 1) | integer | Alternative | |
num_questions_unconditional (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST blank canvas execution id, earliest due date, has blocking approval requirements, is expansion request, is import only spend program, is renewal request, is sla due soon, planned outcome, reduced agreements, sla due date, sla duration in seconds, spend end date, spend frequency, spend start date, tasks tasks item task type ticket
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A ticket task associated with a spend request. |
content | string | Required within parent | Description describing what the ticket is about |
due_at | JSON | Optional | |
due_at (anyOf 1) | string | Alternative | Due date for the ticket Default: null Format: date-time |
due_at (anyOf 2) | null | Alternative | |
halt_reason | JSON | Optional | |
halt_reason (anyOf 1) | string | Alternative | Human-readable reason why the workflow agent halted (for workflow agent tickets only) Default: null |
halt_reason (anyOf 2) | null | Alternative | |
node_title | JSON | Required within parent | |
node_title (anyOf 1) | string | Alternative | |
node_title (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | Current status of the ticket Known values: blocked, canceled, completed, in_progress, in_review, todo, waiting_on_assignee Default: null |
status (anyOf 2) | null | Alternative | |
submitted_at | string | Required within parent | Format: date-time |
task_type | string | Required within parent | Must equal: ticket |
ticket_uuid | string | Required within parent | Format: uuid |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Format: uuid |
is_shareable | boolean | Optional | |
lock_date | JSON | Optional | |
lock_date (anyOf 1) | string | Alternative | Format: date-time |
lock_date (anyOf 2) | null | Alternative | |
post_spend_approval_instance_policy | JSON | Required within parent | |
post_spend_approval_instance_policy (anyOf 1) | Model | Alternative | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name Read only: true |
post_spend_approval_instance_policy (anyOf 2) | null | Alternative | |
spend_eligibility_starts_at | JSON | Optional | |
spend_eligibility_starts_at (anyOf 1) | string | Alternative | Format: date-time |
spend_eligibility_starts_at (anyOf 2) | null | Alternative | |
spend_frequency | JSON | Optional | |
spend_frequency (anyOf 1) | Model | Alternative | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY |
spend_frequency (anyOf 2) | null | Alternative | |
unified_request_id | JSON | Required within parent | |
unified_request_id (anyOf 1) | string | Alternative | Format: uuid Read only: true |
unified_request_id (anyOf 2) | null | Alternative | |
unified_spend_request_type | string | Required within parent | Known values: APPROVAL_ONLY, FUND_UNARCHIVE, PROCUREMENT_SPEND_ALLOCATION, PURCHASE_ORDER, SPEND_ALLOCATION, TRAVEL Read only: true |
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).blank_canvas_execution_id | JSON | Required within parent | |
$ (allOf 2).blank_canvas_execution_id (anyOf 1) | string | Alternative | Blank Canvas execution for this restoration request's approvals, or null. Format: uuid Read only: true |
$ (allOf 2).blank_canvas_execution_id (anyOf 2) | null | Alternative | |
$ (allOf 2).existing_spend_request | JSON | Required within parent | |
$ (allOf 2).existing_spend_request (anyOf 1) | Model | Alternative | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type The original fund request linked to this restoration request. |
$ (allOf 2).existing_spend_request (anyOf 2) | null | Alternative | |
$ (allOf 2).spend_request_type | string | Required within parent | Persisted request type for restoring an existing fund. Known values: FUND_UNARCHIVE Default: FUND_UNARCHIVE |
$ (allOf 2).unified_spend_request_type | string | Required within parent | Unified request classification for fund restoration, not new funding. Known values: FUND_UNARCHIVE Default: FUND_UNARCHIVE |
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER existing spend request amount details, custom form collection response uuid, id, is shareable, lock date, post spend approval instance policy, purchase order, spend eligibility starts at, spend frequency, unified request id, unified spend request type, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER purchase order
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | Money amount in representative currency Read only: true |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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 |
formatted_amount | string | Required within parent | Deprecated - use useIntl()'s formatMoney() instead. Human-readable amount with money context Read only: true |
formatted_explicit_amount | string | Required within parent | Deprecated - use useIntl()'s formatMoney() instead. Displays foreign in currencies in extended form. Used primarily for admins i.e $100 CAD Read only: true |
formatted_short_amount | string | Required within parent | Deprecated - use useIntl()'s formatMoney() instead. Displays foreign currencies in short form. i.e $CA100 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]+)?$ |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER existing spend request amount details, custom form collection response uuid, id, is shareable, lock date, post spend approval instance policy, purchase order, spend eligibility starts at, spend frequency, unified request id, unified spend request type
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION post spend approval instance policy id, is default, name, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER purchase order, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, spend frequency spend frequency frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER purchase order
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
can_view_full_purchase_order | boolean | Required within parent | Whether the acting user can open the full purchase order. Read only: true |
id | string | Required within parent | Format: uuid |
is_directly_issued | boolean | Required within parent | True when the PO was issued directly, without a program or request approval. |
purchase_order_number | JSON | Required within parent | |
purchase_order_number (anyOf 1) | string | Alternative | Read only: true |
purchase_order_number (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | 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 |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).existing_spend_request | JSON | Required within parent | |
$ (allOf 2).existing_spend_request (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 spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER existing spend request amount details, custom form collection response uuid, id, is shareable, lock date, post spend approval instance policy, purchase order, spend eligibility starts at, spend frequency, unified request id, unified spend request type |
$ (allOf 2).existing_spend_request (anyOf 2) | null | Alternative | |
$ (allOf 2).is_shareable | boolean | Required within parent | |
$ (allOf 2).lock_date | JSON | Optional | |
$ (allOf 2).lock_date (anyOf 1) | string | Alternative | Format: date-time |
$ (allOf 2).lock_date (anyOf 2) | null | Alternative | |
$ (allOf 2).lock_display | JSON | Required within parent | |
$ (allOf 2).lock_display (anyOf 1) | string | Alternative | Read only: true |
$ (allOf 2).lock_display (anyOf 2) | null | Alternative | |
$ (allOf 2).relative_lock_duration_count | JSON | Required within parent | |
$ (allOf 2).relative_lock_duration_count (anyOf 1) | JSON | Alternative | |
$ (allOf 2).relative_lock_duration_count (anyOf 1) (anyOf 1) | integer | Alternative | |
$ (allOf 2).relative_lock_duration_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).relative_lock_duration_count (anyOf 2) | null | Alternative | |
$ (allOf 2).relative_lock_duration_unit | JSON | Required within parent | |
$ (allOf 2).relative_lock_duration_unit (anyOf 1) | string | Alternative | Known values: DAYS, MONTHS, WEEKS, YEARS |
$ (allOf 2).relative_lock_duration_unit (anyOf 2) | null | Alternative | |
$ (allOf 2).resulting_spend_allocation_id | JSON | Required within parent | |
$ (allOf 2).resulting_spend_allocation_id (anyOf 1) | string | Alternative | Read only: true |
$ (allOf 2).resulting_spend_allocation_id (anyOf 2) | null | Alternative | |
$ (allOf 2).spend_allocation | JSON | Required within parent | |
$ (allOf 2).spend_allocation (anyOf 1) | Model | Alternative | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION spend request type: SPEND LIMIT, unified spend request type: PROCUREMENT SPEND ALLOCATION spend allocation id, payment restrictions, submission policy |
$ (allOf 2).spend_allocation (anyOf 2) | null | Alternative | |
$ (allOf 2).spend_eligibility_starts_at | JSON | Optional | |
$ (allOf 2).spend_eligibility_starts_at (anyOf 1) | string | Alternative | Format: date-time |
$ (allOf 2).spend_eligibility_starts_at (anyOf 2) | null | Alternative | |
$ (allOf 2).spend_request_type | string | Required within parent | Known values: SPEND_LIMIT Default: SPEND_LIMIT |
$ (allOf 2).unified_spend_request_type | string | Required within parent | Known values: PROCUREMENT_SPEND_ALLOCATION Default: PROCUREMENT_SPEND_ALLOCATION |
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER existing spend request amount details, custom form collection response uuid, id, is shareable, lock date, post spend approval instance policy, purchase order, spend eligibility starts at, spend frequency, unified request id, unified spend request type, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION spend request type: SPEND LIMIT, unified spend request type: PROCUREMENT SPEND ALLOCATION spend allocation id, payment restrictions, submission policy
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION spend request type: SPEND LIMIT, unified spend request type: PROCUREMENT SPEND ALLOCATION spend allocation id, payment restrictions, submission policy
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled, Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY submission policy
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL spend request type: TRAVEL, unified spend request type: TRAVEL spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL spend request type: TRAVEL, unified spend request type: TRAVEL travel metadata
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST spend intent logo id, name, uuid, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST wbx migration assigned program name, migrated at, original policy name
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_instance_id | JSON | Required within parent | |
approval_instance_id (anyOf 1) | string | Alternative | |
approval_instance_id (anyOf 2) | null | Alternative | |
approved_at | JSON | Required within parent | |
approved_at (anyOf 1) | string | Alternative | Format: date-time |
approved_at (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Format: date-time |
created_by_user | Model | Required within parent | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner |
deleted_at | JSON | Required within parent | |
deleted_at (anyOf 1) | string | Alternative | Format: date-time |
deleted_at (anyOf 2) | null | Alternative | |
display_request_number | JSON | Required within parent | |
display_request_number (anyOf 1) | string | Alternative | Human-facing display number, e.g. "REQ-123"; null until the request is numbered. Read only: true |
display_request_number (anyOf 2) | null | Alternative | |
entity | Model | Required within parent | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id entity |
id | string | Required within parent | Format: uuid Read only: true |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
ramp_url | string | Required within parent | Read only: true |
reason | JSON | Required within parent | |
reason (anyOf 1) | string | Alternative | |
reason (anyOf 2) | null | Alternative | |
rejected_at | JSON | Required within parent | |
rejected_at (anyOf 1) | string | Alternative | Format: date-time |
rejected_at (anyOf 2) | null | Alternative | |
request_duration | JSON | Required within parent | |
request_duration (anyOf 1) | JSON | Alternative | |
request_duration (anyOf 1) (anyOf 1) | integer | Alternative | |
request_duration (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
request_duration (anyOf 2) | null | Alternative | |
submitted_at | JSON | Required within parent | |
submitted_at (anyOf 1) | string | Alternative | Format: date-time |
submitted_at (anyOf 2) | null | Alternative | |
wbp_info | JSON | Required within parent | |
wbp_info (anyOf 1) | Model | Alternative | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id Read only: true |
wbp_info (anyOf 2) | null | Alternative | |
workflow_backed_policy_id | JSON | Required within parent | |
workflow_backed_policy_id (anyOf 1) | string | Alternative | ID of the originating workflow-backed policy. Read only: true |
workflow_backed_policy_id (anyOf 2) | null | Alternative |
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id entity, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity_name | string | Required within parent | |
id | string | Required within parent | Format: uuid |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id approvals item, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id field attributions item
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id approvals item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_for_current_user | JSON | Required within parent | |
is_for_current_user (anyOf 1) | boolean | Alternative | Whether the approval belongs to the requesting user. Null when not yet known |
is_for_current_user (anyOf 2) | null | Alternative | |
is_generating | boolean | Required within parent | Whether the approval's summary is still being generated |
progression_node_id | string | Required within parent | Blank-canvas progression node this approval is wired to. |
wbp_approval_id | string | Required within parent | ID of the WBP approval. |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST approval instance id, approved at, created at, created by user, deleted at, display request number, entity, id, name, ramp url, reason, rejected at, request duration, submitted at, wbp info, workflow backed policy id wbp info approvals, blank canvas execution id, field attributions, wbp request id, workflow backed policy display name, workflow backed policy id field attributions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actor | string | Required within parent | Who wrote the field value. Known values: agent, user |
name | string | Required within parent | Custom form field id. |
source_detail | JSON | Optional | |
source_detail (anyOf 1) | string | Alternative | Short user-facing note on where the value came from. Default: null |
source_detail (anyOf 2) | null | Alternative | |
source_type | JSON | Optional | |
source_type (anyOf 1) | string | Alternative | Where an agent-written value came from. Where an agent-written value came from; null for user-written values. Known values: attachment, email, notion, other, slack, web Default: null |
source_type (anyOf 2) | null | Alternative | |
source_url | JSON | Optional | |
source_url (anyOf 1) | string | Alternative | Link to the exact source when one exists (e.g. Slack permalink, Notion page). Default: null |
source_url (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted_at | JSON | Required within parent | |
deleted_at (anyOf 1) | string | Alternative | Format: date-time |
deleted_at (anyOf 2) | null | Alternative | |
department | JSON | Required within parent | |
department (anyOf 1) | Model | Alternative | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner department department name, id |
department (anyOf 2) | null | Alternative | |
email | string | Required within parent | |
first_name | string | Required within parent | |
full_name | string | Required within parent | |
has_physical_card | boolean | Required within parent | Read only: true |
last_name | string | Required within parent | |
location | JSON | Required within parent | |
location (anyOf 1) | Model | Alternative | Expand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner location id, location name |
location (anyOf 2) | null | Alternative | |
profile_picture_url | JSON | Required within parent | |
profile_picture_url (anyOf 1) | string | Alternative | |
profile_picture_url (anyOf 2) | null | Alternative | |
role | string | Required within parent | Known values: AUDITOR, BUSINESS_ADMIN, BUSINESS_BOOKKEEPER, BUSINESS_OWNER, BUSINESS_USER, GUEST_USER, IT_ADMIN, UNBUNDLED_ADMIN, UNBUNDLED_BOOKKEEPER, UNBUNDLED_OWNER, UNBUNDLED_USER |
uuid | string | Required within parent | Format: uuid |
Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner department department name, id, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner location id, location name
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner department department name, id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department_name | string | Required within parent | |
id | string | Required within parent | Format: uuid Read only: true |
List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST owner location id, location name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Format: uuid Read only: true |
location_name | string | Required within parent |