Ramp: Unified request schemas (part 2)
55 Ramp schemas with complete fields and constraints.
← Unified request operations · All schemas
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: 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 available actions v2 request changes status denied
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
denial_reason | string | Required within parent | Why the action cannot be performed. Known values: archived, catalog_order, is_change_request, no_permission, not_approved, not_purchase_order, po_closed, po_external, po_has_change_order, punchout_order |
status | string | Required within parent | Whether the action can be performed. Must equal: denied |
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 available actions v2 send pdf to vendor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_SendPdfToVendorDenialReason_"}, "propertyName": "status"} |
$ (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions delete status allowed |
$ (anyOf 2) | Model | Alternative | Expand Get a unified request — response body — value / 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 available actions v2 send pdf to vendor denial reason: archived, no permission, parent blanket purchase order, punchout order, status denied |
Referenced models: Fetch a vendor agreement — response body — available actions delete status allowed, 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 available actions v2 send pdf to vendor denial reason: archived, no permission, parent blanket purchase order, punchout order, status denied
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 available actions v2 send pdf to vendor denial reason: archived, no permission, parent blanket purchase order, punchout order, status denied
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
denial_reason | string | Required within parent | Why the action cannot be performed. Known values: archived, no_permission, parent_blanket_purchase_order, punchout_order |
status | string | Required within parent | Whether the action can be performed. Must equal: denied |
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 available actions v2 upload bill
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_UploadBillDenialReason_"}, "propertyName": "status"} |
$ (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions delete status allowed |
$ (anyOf 2) | Model | Alternative | Expand Get a unified request — response body — value / 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 available actions v2 upload bill status denied |
Referenced models: Fetch a vendor agreement — response body — available actions delete status allowed, 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 available actions v2 upload bill status denied
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 available actions v2 upload bill status denied
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
denial_reason | string | Required within parent | Why the action cannot be performed. |
status | string | Required within parent | Whether the action can be performed. Must equal: denied |
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 change request diff fields
Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE change request diff fields fields item field type: ACCOUNTING FIELD, 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 change request diff fields fields item field type: FILE, 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 change request diff fields fields item display name, field, is custom field, new value, old value, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE change request diff fields fields item field type: LINE ITEM, 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 change request diff fields fields item field type: LINK, 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 change request diff fields fields item field type: TEXT
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 change request diff fields fields item display name, field, is custom field, new value, old value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Deprecated pre-field_type string diff; the only variant without field_type. |
display_name | string | Required within parent | |
field | string | Required within parent | |
is_custom_field | boolean | Required within parent | Default: false |
new_value | JSON | Required within parent | |
new_value (anyOf 1) | string | Alternative | |
new_value (anyOf 2) | null | Alternative | |
old_value | JSON | Required within parent | |
old_value (anyOf 1) | string | Alternative | |
old_value (anyOf 2) | null | Alternative |
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 change request diff fields fields item field type: ACCOUNTING FIELD
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 change request diff fields fields item field type: ACCOUNTING FIELD new value tracking categories
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Structured values for header accounting field diffs. |
tracking_categories | JSON | Optional | |
tracking_categories (anyOf 1) | array | Alternative | Default: null |
tracking_categories (anyOf 1)[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE change request diff fields fields item field type: ACCOUNTING FIELD new value tracking categories tracking categories array item |
tracking_categories (anyOf 2) | null | Alternative |
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 change request diff fields fields item field type: ACCOUNTING FIELD new value tracking categories tracking categories array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
tracking_category_id | JSON | Required within parent | |
tracking_category_id (anyOf 1) | integer | Alternative | |
tracking_category_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tracking_category_name | string | Required within parent | |
tracking_category_option_name | string | Required within parent |
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 change request diff fields fields item field type: FILE
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 change request diff fields fields item field type: FILE new value array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
original_filename | string | Required within parent | |
url | string | Required within parent |
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 change request diff fields fields item field type: LINE ITEM
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 change request diff fields fields item field type: LINE ITEM new value amount, custom field values, description, due date, end date, quantity, rate, receiving type, retainage, start date, tracking categories
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Structured values for a line item, used in line item diffs. |
amount | JSON | Optional | |
amount (anyOf 1) | string | Alternative | Default: null |
amount (anyOf 2) | null | Alternative | |
custom_field_values | JSON | Optional | |
custom_field_values (anyOf 1) | object | Alternative | Default: null Additional keys: see wildcard field |
custom_field_values (anyOf 1).* | string | Additional keys | |
custom_field_values (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Default: null |
description (anyOf 2) | null | Alternative | |
due_date | JSON | Optional | |
due_date (anyOf 1) | string | Alternative | Default: null |
due_date (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | Default: null |
end_date (anyOf 2) | null | Alternative | |
quantity | JSON | Optional | |
quantity (anyOf 1) | string | Alternative | Default: null |
quantity (anyOf 2) | null | Alternative | |
rate | JSON | Optional | |
rate (anyOf 1) | string | Alternative | Default: null |
rate (anyOf 2) | null | Alternative | |
receiving_type | JSON | Optional | |
receiving_type (anyOf 1) | string | Alternative | How a purchase order line is received and matched: by quantity or by amount. Set only when a change order switches the line's receiving type. Known values: by_amount, by_quantity Default: null |
receiving_type (anyOf 2) | null | Alternative | |
retainage | JSON | Optional | |
retainage (anyOf 1) | string | Alternative | Calculated retainage amount. Default: null |
retainage (anyOf 2) | null | Alternative | |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | Default: null |
start_date (anyOf 2) | null | Alternative | |
tracking_categories | JSON | Optional | |
tracking_categories (anyOf 1) | object | Alternative | Default: null Additional keys: see wildcard field |
tracking_categories (anyOf 1).* | string | Additional keys | |
tracking_categories (anyOf 2) | null | Alternative |
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 change request diff fields fields item field type: LINK
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_name | string | Required within parent | |
field | string | Required within parent | |
field_type | string | Required within parent | Known values: LINK Default: LINK |
is_custom_field | boolean | Required within parent | Default: false |
new_value | JSON | Required within parent | |
new_value (anyOf 1) | string | Alternative | |
new_value (anyOf 2) | null | Alternative | |
old_value | JSON | Required within parent | |
old_value (anyOf 1) | string | Alternative | |
old_value (anyOf 2) | null | Alternative |
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 change request diff fields fields item field type: TEXT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_name | string | Required within parent | |
field | string | Required within parent | |
field_type | string | Required within parent | Known values: TEXT Default: TEXT |
is_custom_field | boolean | Required within parent | Default: false |
new_value | JSON | Required within parent | |
new_value (anyOf 1) | string | Alternative | |
new_value (anyOf 2) | null | Alternative | |
old_value | JSON | Required within parent | |
old_value (anyOf 1) | string | Alternative | |
old_value (anyOf 2) | null | Alternative |
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 custom form files item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Format: date-time |
displayed_filename | string | Required within parent | |
document_category | string | Required within parent | Known values: ADDENDUM_OR_RIDER, AMENDMENT, BANK_LETTER, CAIQ_LITE, CERTIFICATE_OF_INSURANCE, CONTRACT_OTHER, DATA_PROTECTION_AGREEMENT, ECOVADIS, ENGAGEMENT_LETTER, FAQ, FORM_1099, GDPR, HIPAA, INVOICE, ISO_27001, ISO_9001, MSA, NDA, NMSDC_CERTIFICATION, ORDER_FORM, OTHER, PAYMENT_INSTRUCTIONS, PCI_DSS, PEN_TEST_REPORT, PRIVACY_POLICY, PURCHASE_ORDER, QUESTIONNAIRE, QUOTE, SECURITY_DOCUMENT, SECURITY_EXHIBIT, SIG, SLA, SOC_1_TYPE_1, SOC_1_TYPE_2, SOC_2, SOW, TAX_DOCUMENT, TAX_DOCUMENT_INTL_COR, TAX_DOCUMENT_INTL_GOV_FORM, TAX_DOCUMENT_INTL_OTHER, TAX_DOCUMENT_INTL_STATUTORY_FORM, TOS, VENDOR_CONTRACT, VENDOR_CREDIT, VOIDED_CHECK, W8, W9 |
download_pdf_url | JSON | Required within parent | |
download_pdf_url (anyOf 1) | string | Alternative | Read only: true |
download_pdf_url (anyOf 2) | null | Alternative | |
download_url | string | Required within parent | Read only: true |
mime_type | JSON | Required within parent | |
mime_type (anyOf 1) | string | Alternative | Known values: application/json, application/msword, application/pdf, application/vnd.apache.parquet, application/vnd.ms-excel, application/vnd.ms-excel.sheet.macroEnabled.12, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.wordprocessingml.document, audio/mpeg, image/gif, image/heic, image/jpeg, image/png, image/webp, text/calendar, text/csv, text/markdown, text/x-python Read only: true |
mime_type (anyOf 2) | null | Alternative | |
network_vendor_document_id | JSON | Required within parent | |
network_vendor_document_id (anyOf 1) | string | Alternative | Read only: true |
network_vendor_document_id (anyOf 2) | null | Alternative | |
original_filename | string | Required within parent | |
ramp_document | JSON | Required within parent | |
ramp_document (anyOf 1) | Model | Alternative | 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 custom form files item ramp document version type: PROCUREMENT Read only: true |
ramp_document (anyOf 2) | null | Alternative | |
spend_request_document_uuid | JSON | Required within parent | |
spend_request_document_uuid (anyOf 1) | string | Alternative | Read only: true |
spend_request_document_uuid (anyOf 2) | null | Alternative | |
url | string | Required within parent | Read only: true |
uuid | string | Required within parent | Format: uuid |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: 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 custom form files item ramp document version type: PROCUREMENT
Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE custom form files item ramp document version type: PROCUREMENT clm signing provider provider: docusign, dropbox sign, ironclad, 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 custom form files item ramp document version type: PROCUREMENT latest version
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 custom form files item ramp document version type: PROCUREMENT clm signing provider provider: docusign, dropbox sign, ironclad
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_workflow_completed | boolean | Required within parent | |
provider | string | Required within parent | Known values: docusign, dropbox_sign, ironclad |
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 custom form files item ramp document version type: PROCUREMENT latest version
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cloudfront_download_url | string | Required within parent | |
cloudfront_url | string | Required within parent | |
created_at | string | Required within parent | Format: date-time |
external_document_url | JSON | Optional | |
external_document_url (anyOf 1) | string | Alternative | Default: null |
external_document_url (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
is_ocr_document | boolean | Required within parent | |
original_filename | string | Required within parent | |
version_number | JSON | Required within parent | |
version_number (anyOf 1) | integer | Alternative | |
version_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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 default question config summary
Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE default question config summary amount config, 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 default question config summary estimated amount config, 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 default question config summary frequency config, 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 default question config summary funds config, 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 default question config summary multiple purchase orders config, 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 default question config summary request name config
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 default question config summary amount config
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dates_visible_by_default | boolean | Optional | Default: false |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Default: null |
description (anyOf 2) | null | Alternative | |
is_end_date_required | boolean | Optional | Default: false |
is_required | boolean | Optional | Default: true |
is_retainage_required | boolean | Optional | Whether every purchase-order line item must provide a retainage value. Default: false |
is_start_date_required | boolean | Optional | Default: false |
retainage_visible_by_default | boolean | Optional | Whether retainage is shown on purchase-order line items by default. Default: false |
should_show_question | boolean | Optional | Default: true |
title | string | Optional | Default: How much? |
uses_line_items | boolean | Optional | Default: true |
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 default question config summary estimated amount config
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Lets the requester mark the total as an estimated maximum. Not configurable in program setup; shown on purchase order programs when the feature is enabled. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Optional help text shown under the question. Default: null |
description (anyOf 2) | null | Alternative | |
is_required | boolean | Optional | Whether the requester must answer the question. Default: false |
should_show_question | boolean | Optional | Whether the request form shows the estimated maximum question. Default: true |
title | string | Optional | Question title shown on the request form. Default: Let admins know total may be lower based on usage |
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 default question config summary frequency config
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Default: null |
description (anyOf 2) | null | Alternative | |
is_required | boolean | Optional | Default: true |
should_show_frequency | boolean | Optional | Default: true |
should_show_question | boolean | Optional | Default: true |
title | string | Optional | Default: Is it one-time or recurring? |
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 default question config summary funds config
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Default: null |
description (anyOf 2) | null | Alternative | |
is_required | boolean | Optional | Default: false |
should_show_question | boolean | Optional | Default: false |
title | string | Optional | Default: Would you like to pay for this with a virtual card? |
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 default question config summary multiple purchase orders config
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Lets the requester ask for a blanket PO with release POs. Not configurable in program setup; only shown when the program uses line items and blanket POs are enabled for the business. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Optional help text shown under the question. Default: null |
description (anyOf 2) | null | Alternative | |
is_required | boolean | Optional | Whether the requester must answer the question. Default: false |
should_show_question | boolean | Optional | Whether the request form shows the multiple purchase orders question. Default: true |
title | string | Optional | Question title shown on the request form. Default: Create multiple child POs for this PO |
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 default question config summary request name config
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Default: null |
description (anyOf 2) | null | Alternative | |
is_required | boolean | Optional | Default: false |
should_show_question | boolean | Optional | Default: false |
title | string | Optional | Default: Request name |
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 forms
Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE forms global form response statuses item, 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 forms vendor onboarding statuses item
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 forms global form response statuses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Format: date-time |
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_response | JSON | Required within parent | |
custom_form_collection_response (anyOf 1) | Model | Alternative | 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 forms global form response statuses item custom form collection response custom form collection, custom form collection response uuid, draft revision |
custom_form_collection_response (anyOf 2) | null | Alternative | |
custom_form_collection_uuid | string | Required within parent | |
global_form_response_user_assignment_mapping_id | JSON | Required within parent | |
global_form_response_user_assignment_mapping_id (anyOf 1) | string | Alternative | |
global_form_response_user_assignment_mapping_id (anyOf 2) | null | Alternative | |
needs_current_user_action | boolean | Required within parent | |
node_id | JSON | Required within parent | |
node_id (anyOf 1) | string | Alternative | |
node_id (anyOf 2) | null | Alternative | |
node_title | JSON | Required within parent | |
node_title (anyOf 1) | string | Alternative | |
node_title (anyOf 2) | null | Alternative | |
status | string | Required within parent | Known values: PENDING, SUBMITTED |
submitted_at | JSON | Required within parent | |
submitted_at (anyOf 1) | string | Alternative | Format: date-time |
submitted_at (anyOf 2) | null | Alternative | |
submitted_by_user | JSON | Required within parent | |
submitted_by_user (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approvals paused by deleted at, email, first name, id, last name, lifecycle status, profile picture url, role |
submitted_by_user (anyOf 2) | null | Alternative |
Referenced models: Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approvals paused by deleted at, email, first name, id, last name, lifecycle status, profile picture url, role, 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 forms global form response statuses item custom form collection response custom form collection, custom form collection response uuid, draft revision
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 forms global form response statuses item custom form collection response custom form collection, custom form collection response uuid, draft revision
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the dump schema for a custom form collection response. |
custom_form_collection | 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 forms global form response statuses item custom form collection response custom form collection, custom form collection response uuid, draft revision custom form collection |
custom_form_collection_response_uuid | string | Required within parent | |
draft_revision | JSON | Optional | |
draft_revision (anyOf 1) | JSON | Alternative | |
draft_revision (anyOf 1) (anyOf 1) | integer | Alternative | Monotonic revision of the owning spend request's user-editable content, used to discard stale concurrent-edit reads; null when the response is not attached to a spend request. Default: null |
draft_revision (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
draft_revision (anyOf 2) | null | Alternative |
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 forms global form response statuses item custom form collection response custom form collection, custom form collection response uuid, draft revision custom form collection
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the dump schema for a custom form collection on a custom form response. |
custom_form_collection_log_entry | 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 forms global form response statuses item custom form collection response custom form collection, custom form collection response uuid, draft revision custom form collection custom form collection log entry |
uuid | string | Required within parent |
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 forms global form response statuses item custom form collection response custom form collection, custom form collection response uuid, draft revision custom form collection custom form collection log entry
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the dump schema for a custom form collection response log entry on a custom form response. |
allow_comments | boolean | Optional | Default: false |
forms | array | Required within parent | |
forms[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE forms global form response statuses item custom form collection response custom form collection, custom form collection response uuid, draft revision custom form collection custom form collection log entry forms item |
label | JSON | Required within parent | |
label (anyOf 1) | string | Alternative | |
label (anyOf 2) | null | Alternative | |
uuid | string | Required within parent |
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 forms global form response statuses item custom form collection response custom form collection, custom form collection response uuid, draft revision custom form collection custom form collection log entry forms item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
conditions | JSON | Required within parent | |
conditions (anyOf 1) | Model | Alternative | Expand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then |
conditions (anyOf 2) | null | Alternative | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
fields | array | Required within parent | |
fields[] | Model | Each item | Expand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item |
label | JSON | Required within parent | |
label (anyOf 1) | string | Alternative | |
label (anyOf 2) | null | Alternative | |
section_id | string | Required within parent | |
uuid | string | Required within parent |
Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item
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 forms vendor onboarding statuses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_form_collection_response_uuid | JSON | Required within parent | |
custom_form_collection_response_uuid (anyOf 1) | string | Alternative | |
custom_form_collection_response_uuid (anyOf 2) | null | Alternative | |
status | string | Required within parent | Known values: NOT_REQUESTED, NOT_SENT, REQUESTED, SUBMITTED |
status_display_description | JSON | Required within parent | |
status_display_description (anyOf 1) | string | Alternative | |
status_display_description (anyOf 2) | null | Alternative | |
status_display_text | string | Required within parent | |
submitted_at | JSON | Required within parent | |
submitted_at (anyOf 1) | string | Alternative | Format: date-time |
submitted_at (anyOf 2) | null | Alternative | |
type | string | Required within parent | Known values: CUSTOM_FORM, PAYMENT, TAX |
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 linkable agreements item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
auto_renewal | JSON | Required within parent | |
auto_renewal (anyOf 1) | boolean | Alternative | |
auto_renewal (anyOf 2) | null | Alternative | |
currency | JSON | Optional | |
currency (anyOf 1) | Model | Alternative | 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 linkable agreements item currency string Default: null |
currency (anyOf 2) | null | Alternative | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | Format: date |
end_date (anyOf 2) | null | Alternative | |
last_date_to_terminate | JSON | Optional | |
last_date_to_terminate (anyOf 1) | string | Alternative | Default: null Format: date |
last_date_to_terminate (anyOf 2) | null | Alternative | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
payee_agreement_id | string | Required within parent | |
payee_logo | JSON | Optional | |
payee_logo (anyOf 1) | string | Alternative | Default: null |
payee_logo (anyOf 2) | null | Alternative | |
payee_name | JSON | Optional | |
payee_name (anyOf 1) | string | Alternative | Default: null |
payee_name (anyOf 2) | null | Alternative | |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | Format: date |
start_date (anyOf 2) | null | Alternative | |
total_value | JSON | Required within parent | |
total_value (anyOf 1) | JSON | Alternative | |
total_value (anyOf 1) (anyOf 1) | number | Alternative | |
total_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_value (anyOf 2) | null | Alternative | |
up_for_renewal | boolean | Required within parent |
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 linkable agreements item currency string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | We attempted to dynamically create this class from the ISO4217Currency and CryptoCurrency enums. However, mypy was not able to infer the type of the Currency enum; so we manually added the currencies to the enum. 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 |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
_ramp_event_type | string | Required within parent | |
assigned_entities | array | Required within parent | |
assigned_entities[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item assigned entities item |
completed_approval_count | JSON | Required within parent | |
completed_approval_count (anyOf 1) | JSON | Alternative | |
completed_approval_count (anyOf 1) (anyOf 1) | integer | Alternative | Satisfied eligible selected principals, including delegate credit; capped at the effective target. Default: null |
completed_approval_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
completed_approval_count (anyOf 2) | null | Alternative | |
displayed_event_text | string | Required within parent | |
eligible_approver_count | JSON | Required within parent | |
eligible_approver_count (anyOf 1) | JSON | Alternative | |
eligible_approver_count (anyOf 1) (anyOf 1) | integer | Alternative | Distinct eligible selected people across direct selections and groups, excluding delegate-only users. Default: null |
eligible_approver_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
eligible_approver_count (anyOf 2) | null | Alternative | |
event_order | JSON | Required within parent | |
event_order (anyOf 1) | integer | Alternative | |
event_order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
event_type | string | Required within parent | Known values: NOTIFY, REQUIRE, REQUIRE_ALL, ROUND_ROBIN |
id | string | Required within parent | |
is_current_step | boolean | Required within parent | |
is_delegate | boolean | Required within parent | Default: false |
is_last_step_for_user | boolean | Required within parent | |
needs_user_action | boolean | Required within parent | |
needs_user_trigger_action | boolean | Required within parent | Default: false |
notes | JSON | Required within parent | |
notes (anyOf 1) | string | Alternative | Default: null |
notes (anyOf 2) | null | Alternative | |
raw_step_order | JSON | Required within parent | |
raw_step_order (anyOf 1) | integer | Alternative | |
raw_step_order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
required_approval_count | JSON | Required within parent | |
required_approval_count (anyOf 1) | JSON | Alternative | |
required_approval_count (anyOf 1) (anyOf 1) | integer | Alternative | Configured approval target; execution caps it at eligible_approver_count. Default: null |
required_approval_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
required_approval_count (anyOf 2) | null | Alternative | |
status | string | Required within parent | Known values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, MANUALLY_SKIPPED, PENDING, REJECTED, SKIPPED, TERMINATED |
step_creator_user_id | JSON | Required within parent | |
step_creator_user_id (anyOf 1) | string | Alternative | Default: null |
step_creator_user_id (anyOf 2) | null | Alternative | |
step_date | JSON | Required within parent | |
step_date (anyOf 1) | string | Alternative | Default: null |
step_date (anyOf 2) | null | Alternative | |
substeps | array | Required within parent | |
substeps[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item substeps item |
trigger_entity_metadata | JSON | Optional | |
trigger_entity_metadata (anyOf 1) | Model | Alternative | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value |
trigger_entity_metadata (anyOf 2) | null | Alternative |
Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item substeps item, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item assigned entities item, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item assigned entities item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_trigger_instance_error_message | JSON | Required within parent | |
approval_trigger_instance_error_message (anyOf 1) | string | Alternative | Default: null |
approval_trigger_instance_error_message (anyOf 2) | null | Alternative | |
approval_trigger_instance_error_redirect_url | JSON | Required within parent | |
approval_trigger_instance_error_redirect_url (anyOf 1) | string | Alternative | Default: null |
approval_trigger_instance_error_redirect_url (anyOf 2) | null | Alternative | |
approval_trigger_type | JSON | Required within parent | |
approval_trigger_type (anyOf 1) | string | Alternative | Known values: GLOBAL_FORM_RESPONSE, IRONCLAD_WORKFLOW_GATE, LAUNCH_ESIGN_WORKFLOW, LAUNCH_EXTERNAL_APPROVAL, LAUNCH_IRONCLAD_WORKFLOW, LAUNCH_THIRD_PARTY_RISK_MANAGEMENT_VENDOR_REVIEW_WORKFLOW, LAUNCH_TICKETING_WORKFLOW, LAUNCH_VENDOR_ONBOARDING, SEND_BACK, WAIT_FOR_BOOKING_COMPLETION Default: null |
approval_trigger_type (anyOf 2) | null | Alternative | |
assigned_user_full_name | string | Required within parent | |
assigned_user_id | JSON | Required within parent | |
assigned_user_id (anyOf 1) | string | Alternative | Default: null |
assigned_user_id (anyOf 2) | null | Alternative | |
can_create_esign_envelope | JSON | Required within parent | |
can_create_esign_envelope (anyOf 1) | boolean | Alternative | Whether the current viewer has a pending e-sign assignment for this trigger. Null when eligibility has not been loaded or the trigger is not e-sign. Default: null |
can_create_esign_envelope (anyOf 2) | null | Alternative | |
delegator_user_full_name | JSON | Required within parent | |
delegator_user_full_name (anyOf 1) | string | Alternative | Default: null |
delegator_user_full_name (anyOf 2) | null | Alternative | |
delegator_user_id | JSON | Required within parent | |
delegator_user_id (anyOf 1) | string | Alternative | Default: null |
delegator_user_id (anyOf 2) | null | Alternative | |
entity_full_name | string | Required within parent | |
entity_id | JSON | Required within parent | |
entity_id (anyOf 1) | string | Alternative | Default: null |
entity_id (anyOf 2) | null | Alternative | |
entity_type | string | Required within parent | Known values: ANY_ADMIN, GROUP, MANAGER, TRIGGER, USER, VENDOR_OWNER, VENDOR_OWNER_MANAGER |
external_url | JSON | Required within parent | |
external_url (anyOf 1) | string | Alternative | Default: null |
external_url (anyOf 2) | null | Alternative | |
notes | JSON | Required within parent | |
notes (anyOf 1) | string | Alternative | Default: null |
notes (anyOf 2) | null | Alternative | |
provider_type | JSON | Required within parent | |
provider_type (anyOf 1) | string | Alternative | Default: null |
provider_type (anyOf 2) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item substeps item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assigned_entities | array | Required within parent | |
assigned_entities[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item assigned entities item |
displayed_event_text | string | Required within parent | |
event_type | string | Required within parent | Known values: NOTIFY, REQUIRE, REQUIRE_ALL, ROUND_ROBIN |
status | string | Required within parent | Known values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, MANUALLY_SKIPPED, PENDING, REJECTED, SKIPPED, TERMINATED |
step_date | JSON | Required within parent | |
step_date (anyOf 1) | string | Alternative | Default: null |
step_date (anyOf 2) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value
Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH EXTERNAL APPROVAL, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH IRONCLAD WORKFLOW, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type SEND BACK, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH TICKETING WORKFLOW, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH VENDOR ONBOARDING
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE
Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE form entities item, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE global form response mappings item
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE form entities item
Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE form entities item entity entity type GROUP, group status: APPROVED, PENDING, REJECTED, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE form entities item entity entity type USER
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE form entities item entity entity type GROUP, group status: APPROVED, PENDING, REJECTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assigned_user | JSON | Optional | |
assigned_user (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approvals paused by deleted at, email, first name, id, last name, lifecycle status, profile picture url, role Chosen user. Default: null |
assigned_user (anyOf 2) | null | Alternative | |
assigned_user_source | JSON | Optional | |
assigned_user_source (anyOf 1) | string | Alternative | How the assigned user was selected; null when no user is assigned. Known values: DEFAULT_APPROVER, ROUND_ROBIN, ROUTE_REQUEST Default: null |
assigned_user_source (anyOf 2) | null | Alternative | |
entity_type | string | Required within parent | Must equal: GROUP |
group_name | string | Required within parent | |
group_status | string | Required within parent | Known values: APPROVED, PENDING, REJECTED |
group_type | string | Required within parent | Known values: ABSOLUTE, DYNAMIC, MANAGER_CHAIN_TRAVERSAL, RELATIVE, SEQUENTIAL_MATRIX_RESOLVER |
group_uuid | string | Required within parent | |
reassignment_candidates | JSON | Optional | |
reassignment_candidates (anyOf 1) | array | Alternative | Eligible users for reassignment of the active round-robin approval. Default: null |
reassignment_candidates (anyOf 1)[] | Model | Each item | Expand Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approvals paused by deleted at, email, first name, id, last name, lifecycle status, profile picture url, role |
reassignment_candidates (anyOf 2) | null | Alternative | |
relative_group_type | JSON | Optional | |
relative_group_type (anyOf 1) | string | Alternative | Default: null |
relative_group_type (anyOf 2) | null | Alternative | |
users | array | Required within parent | |
users[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE form entities item entity entity type USER user |
Referenced models: Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approvals paused by deleted at, email, first name, id, last name, lifecycle status, profile picture url, role, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE form entities item entity entity type USER user
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE form entities item entity entity type USER
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE form entities item entity entity type USER user
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE global form response mappings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_form_collection_response_id | JSON | Required within parent | |
custom_form_collection_response_id (anyOf 1) | JSON | Alternative | |
custom_form_collection_response_id (anyOf 1) (anyOf 1) | integer | Alternative | |
custom_form_collection_response_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
custom_form_collection_response_id (anyOf 2) | null | Alternative | |
global_form_response_mapping_uuid | string | Required within parent | |
user_uuid | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW
Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW error error type FALLBACK ERROR, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW error error type MISSING BUSINESS ACCESS, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW error error type MISSING INDIVIDUAL ACCESS, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW error error type MISSING RAMP ID FIELD, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW error error type REQUESTER USER NOT FOUND, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW error error type MISSING PERMISSION
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW error error type FALLBACK ERROR
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | JSON | Required within parent | |
error_message (anyOf 1) | string | Alternative | |
error_message (anyOf 2) | null | Alternative | |
error_redirect_url | JSON | Required within parent | |
error_redirect_url (anyOf 1) | string | Alternative | |
error_redirect_url (anyOf 2) | null | Alternative | |
error_type | string | Required within parent | Must equal: FALLBACK_ERROR |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW error error type MISSING BUSINESS ACCESS
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_type | string | Required within parent | Identifies a missing business-level Ironclad integration. Must equal: MISSING_BUSINESS_ACCESS |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW error error type MISSING INDIVIDUAL ACCESS
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_access_email | string | Required within parent | |
error_type | string | Required within parent | Must equal: MISSING_INDIVIDUAL_ACCESS |
requester_email | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW error error type MISSING PERMISSION
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_type | string | Required within parent | Must equal: MISSING_PERMISSION |
requester_email | string | Required within parent | |
workflow_name | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW error error type MISSING RAMP ID FIELD
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_type | string | Required within parent | Must equal: MISSING_RAMP_ID_FIELD |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type IRONCLAD WORKFLOW GATE error trigger type: LAUNCH IRONCLAD WORKFLOW error error type REQUESTER USER NOT FOUND
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_type | string | Required within parent | Identifies a requester whose email does not match an Ironclad user. Must equal: REQUESTER_USER_NOT_FOUND |
requester_email | string | Required within parent | The Ramp requester's email that was not found in Ironclad. |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW
Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW signers item, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW