Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
denial_reasonstringRequired within parentWhy 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
statusstringRequired within parentWhether 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

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

FieldTypePresenceDescription and constraints
$objectRoot
denial_reasonstringRequired within parentWhy the action cannot be performed.
Known values: archived, no_permission, parent_blanket_purchase_order, punchout_order
statusstringRequired within parentWhether 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

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

FieldTypePresenceDescription and constraints
$objectRoot
denial_reasonstringRequired within parentWhy the action cannot be performed.
statusstringRequired within parentWhether 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

FieldTypePresenceDescription and constraints
$objectRoot
fieldsarrayRequired within parent
fields[]JSONEach item
fields[] (anyOf 1)ModelAlternativeExpand 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
fields[] (anyOf 2)ModelAlternativeExpand 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
fields[] (anyOf 3)ModelAlternativeExpand 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
fields[] (anyOf 4)ModelAlternativeExpand 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
fields[] (anyOf 5)ModelAlternativeExpand 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
fields[] (anyOf 6)ModelAlternativeExpand 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

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

FieldTypePresenceDescription and constraints
$objectRootDeprecated pre-field_type string diff; the only variant without field_type.
display_namestringRequired within parent
fieldstringRequired within parent
is_custom_fieldbooleanRequired within parentDefault: false
new_valueJSONRequired within parent
new_value (anyOf 1)stringAlternative
new_value (anyOf 2)nullAlternative
old_valueJSONRequired within parent
old_value (anyOf 1)stringAlternative
old_value (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
fieldstringRequired within parent
field_typestringRequired within parentKnown values: ACCOUNTING_FIELD
Default: ACCOUNTING_FIELD
is_custom_fieldbooleanRequired within parentDefault: false
new_valueJSONRequired within parent
new_value (anyOf 1)ModelAlternativeExpand 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
new_value (anyOf 2)nullAlternative
old_valueJSONRequired within parent
old_value (anyOf 1)ModelAlternativeExpand 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
old_value (anyOf 2)nullAlternative

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 new value tracking categories

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

FieldTypePresenceDescription and constraints
$objectRootStructured values for header accounting field diffs.
tracking_categoriesJSONOptional
tracking_categories (anyOf 1)arrayAlternativeDefault: null
tracking_categories (anyOf 1)[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE change request diff fields fields item field type: ACCOUNTING FIELD new value tracking categories tracking categories array item
tracking_categories (anyOf 2)nullAlternative

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 new value tracking categories tracking categories array 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: ACCOUNTING FIELD new value tracking categories tracking categories array item

FieldTypePresenceDescription and constraints
$objectRoot
tracking_category_idJSONRequired within parent
tracking_category_id (anyOf 1)integerAlternative
tracking_category_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tracking_category_namestringRequired within parent
tracking_category_option_namestringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
fieldstringRequired within parent
field_typestringRequired within parentKnown values: FILE
Default: FILE
is_custom_fieldbooleanRequired within parentDefault: false
new_valueJSONRequired within parent
new_value (anyOf 1)arrayAlternative
new_value (anyOf 1)[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE change request diff fields fields item field type: FILE new value array item
new_value (anyOf 2)nullAlternative
old_valueJSONRequired within parent
old_value (anyOf 1)arrayAlternative
old_value (anyOf 1)[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE change request diff fields fields item field type: FILE new value array item
old_value (anyOf 2)nullAlternative

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: FILE new value array 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: FILE new value array item

FieldTypePresenceDescription and constraints
$objectRoot
original_filenamestringRequired within parent
urlstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
fieldstringRequired within parent
field_typestringRequired within parentKnown values: LINE_ITEM
Default: LINE_ITEM
is_custom_fieldbooleanRequired within parentDefault: false
new_valueJSONRequired within parent
new_value (anyOf 1)ModelAlternativeExpand 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
new_value (anyOf 2)nullAlternative
old_valueJSONRequired within parent
old_value (anyOf 1)ModelAlternativeExpand 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
old_value (anyOf 2)nullAlternative

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: LINE ITEM new value amount, custom field values, description, due date, end date, quantity, rate, receiving type, retainage, start date, tracking categories

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

FieldTypePresenceDescription and constraints
$objectRootStructured values for a line item, used in line item diffs.
amountJSONOptional
amount (anyOf 1)stringAlternativeDefault: null
amount (anyOf 2)nullAlternative
custom_field_valuesJSONOptional
custom_field_values (anyOf 1)objectAlternativeDefault: null
Additional keys: see wildcard field
custom_field_values (anyOf 1).*stringAdditional keys
custom_field_values (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeDefault: null
description (anyOf 2)nullAlternative
due_dateJSONOptional
due_date (anyOf 1)stringAlternativeDefault: null
due_date (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeDefault: null
end_date (anyOf 2)nullAlternative
quantityJSONOptional
quantity (anyOf 1)stringAlternativeDefault: null
quantity (anyOf 2)nullAlternative
rateJSONOptional
rate (anyOf 1)stringAlternativeDefault: null
rate (anyOf 2)nullAlternative
receiving_typeJSONOptional
receiving_type (anyOf 1)stringAlternativeHow 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)nullAlternative
retainageJSONOptional
retainage (anyOf 1)stringAlternativeCalculated retainage amount.
Default: null
retainage (anyOf 2)nullAlternative
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeDefault: null
start_date (anyOf 2)nullAlternative
tracking_categoriesJSONOptional
tracking_categories (anyOf 1)objectAlternativeDefault: null
Additional keys: see wildcard field
tracking_categories (anyOf 1).*stringAdditional keys
tracking_categories (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
fieldstringRequired within parent
field_typestringRequired within parentKnown values: LINK
Default: LINK
is_custom_fieldbooleanRequired within parentDefault: false
new_valueJSONRequired within parent
new_value (anyOf 1)stringAlternative
new_value (anyOf 2)nullAlternative
old_valueJSONRequired within parent
old_value (anyOf 1)stringAlternative
old_value (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
fieldstringRequired within parent
field_typestringRequired within parentKnown values: TEXT
Default: TEXT
is_custom_fieldbooleanRequired within parentDefault: false
new_valueJSONRequired within parent
new_value (anyOf 1)stringAlternative
new_value (anyOf 2)nullAlternative
old_valueJSONRequired within parent
old_value (anyOf 1)stringAlternative
old_value (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentFormat: date-time
displayed_filenamestringRequired within parent
document_categorystringRequired within parentKnown 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_urlJSONRequired within parent
download_pdf_url (anyOf 1)stringAlternativeRead only: true
download_pdf_url (anyOf 2)nullAlternative
download_urlstringRequired within parentRead only: true
mime_typeJSONRequired within parent
mime_type (anyOf 1)stringAlternativeKnown 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)nullAlternative
network_vendor_document_idJSONRequired within parent
network_vendor_document_id (anyOf 1)stringAlternativeRead only: true
network_vendor_document_id (anyOf 2)nullAlternative
original_filenamestringRequired within parent
ramp_documentJSONRequired within parent
ramp_document (anyOf 1)ModelAlternativeExpand 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)nullAlternative
spend_request_document_uuidJSONRequired within parent
spend_request_document_uuid (anyOf 1)stringAlternativeRead only: true
spend_request_document_uuid (anyOf 2)nullAlternative
urlstringRequired within parentRead only: true
uuidstringRequired within parentFormat: uuid

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

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

FieldTypePresenceDescription and constraints
$objectRoot
clm_signing_providerJSONOptional
clm_signing_provider (anyOf 1)ModelAlternativeExpand 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
Default: null
clm_signing_provider (anyOf 2)nullAlternative
created_atstringRequired within parentFormat: date-time
idstringRequired within parent
latest_versionModelRequired within parentExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE custom form files item ramp document version type: PROCUREMENT latest version
version_countJSONRequired within parent
version_count (anyOf 1)integerAlternative
version_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
version_typestringOptionalKnown values: PROCUREMENT
Default: 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

FieldTypePresenceDescription and constraints
$objectRoot
is_workflow_completedbooleanRequired within parent
providerstringRequired within parentKnown 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

FieldTypePresenceDescription and constraints
$objectRoot
cloudfront_download_urlstringRequired within parent
cloudfront_urlstringRequired within parent
created_atstringRequired within parentFormat: date-time
external_document_urlJSONOptional
external_document_url (anyOf 1)stringAlternativeDefault: null
external_document_url (anyOf 2)nullAlternative
idstringRequired within parent
is_ocr_documentbooleanRequired within parent
original_filenamestringRequired within parent
version_numberJSONRequired within parent
version_number (anyOf 1)integerAlternative
version_number (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
amount_configModelOptionalExpand 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
Default: {"dates_visible_by_default": false, "description": null, "is_end_date_required": false, "is_required": true, "is_retainage_required": false, "is_start_date_required": false, "retainage_visible_by_default": false, "should_show_question": true, "title": "How much?", "uses_line_items": true}
estimated_amount_configModelOptionalExpand 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
Question asking whether the request total is an estimated maximum.
Default: {"description": null, "is_required": false, "should_show_question": true, "title": "Let admins know total may be lower based on usage"}
frequency_configModelOptionalExpand 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
Default: {"description": null, "is_required": true, "should_show_frequency": true, "should_show_question": true, "title": "Is it one-time or recurring?"}
funds_configModelOptionalExpand 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
Default: {"description": null, "is_required": false, "should_show_question": false, "title": "Would you like to pay for this with a virtual card?"}
multiple_purchase_orders_configModelOptionalExpand 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
Question asking whether the order needs multiple purchase orders.
Default: {"description": null, "is_required": false, "should_show_question": true, "title": "Create multiple child POs for this PO"}
request_name_configModelOptionalExpand 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
Default: {"description": null, "is_required": false, "should_show_question": false, "title": "Request name"}

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

FieldTypePresenceDescription and constraints
$objectRoot
dates_visible_by_defaultbooleanOptionalDefault: false
descriptionJSONOptional
description (anyOf 1)stringAlternativeDefault: null
description (anyOf 2)nullAlternative
is_end_date_requiredbooleanOptionalDefault: false
is_requiredbooleanOptionalDefault: true
is_retainage_requiredbooleanOptionalWhether every purchase-order line item must provide a retainage value.
Default: false
is_start_date_requiredbooleanOptionalDefault: false
retainage_visible_by_defaultbooleanOptionalWhether retainage is shown on purchase-order line items by default.
Default: false
should_show_questionbooleanOptionalDefault: true
titlestringOptionalDefault: How much?
uses_line_itemsbooleanOptionalDefault: 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

FieldTypePresenceDescription and constraints
$objectRootLets the requester mark the total as an estimated maximum. Not configurable in
program setup; shown on purchase order programs when the feature is enabled.
descriptionJSONOptional
description (anyOf 1)stringAlternativeOptional help text shown under the question.
Default: null
description (anyOf 2)nullAlternative
is_requiredbooleanOptionalWhether the requester must answer the question.
Default: false
should_show_questionbooleanOptionalWhether the request form shows the estimated maximum question.
Default: true
titlestringOptionalQuestion 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

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDefault: null
description (anyOf 2)nullAlternative
is_requiredbooleanOptionalDefault: true
should_show_frequencybooleanOptionalDefault: true
should_show_questionbooleanOptionalDefault: true
titlestringOptionalDefault: 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

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDefault: null
description (anyOf 2)nullAlternative
is_requiredbooleanOptionalDefault: false
should_show_questionbooleanOptionalDefault: false
titlestringOptionalDefault: 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

FieldTypePresenceDescription and constraints
$objectRootLets 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.
descriptionJSONOptional
description (anyOf 1)stringAlternativeOptional help text shown under the question.
Default: null
description (anyOf 2)nullAlternative
is_requiredbooleanOptionalWhether the requester must answer the question.
Default: false
should_show_questionbooleanOptionalWhether the request form shows the multiple purchase orders question.
Default: true
titlestringOptionalQuestion 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

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDefault: null
description (anyOf 2)nullAlternative
is_requiredbooleanOptionalDefault: false
should_show_questionbooleanOptionalDefault: false
titlestringOptionalDefault: 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

FieldTypePresenceDescription and constraints
$objectRoot
global_form_response_statusesarrayRequired within parentRead only: true
global_form_response_statuses[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE forms global form response statuses item
vendor_onboardingarrayRequired within parentRead only: true
vendor_onboarding[]arrayEach item
vendor_onboarding[][]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE forms vendor onboarding statuses item
vendor_onboarding_statusesarrayRequired within parentRead only: true
vendor_onboarding_statuses[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE forms vendor onboarding statuses 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 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentFormat: date-time
custom_form_collection_log_entry_labelJSONRequired within parent
custom_form_collection_log_entry_label (anyOf 1)stringAlternative
custom_form_collection_log_entry_label (anyOf 2)nullAlternative
custom_form_collection_log_entry_uuidstringRequired within parent
custom_form_collection_responseJSONRequired within parent
custom_form_collection_response (anyOf 1)ModelAlternativeExpand 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)nullAlternative
custom_form_collection_uuidstringRequired within parent
global_form_response_user_assignment_mapping_idJSONRequired within parent
global_form_response_user_assignment_mapping_id (anyOf 1)stringAlternative
global_form_response_user_assignment_mapping_id (anyOf 2)nullAlternative
needs_current_user_actionbooleanRequired within parent
node_idJSONRequired within parent
node_id (anyOf 1)stringAlternative
node_id (anyOf 2)nullAlternative
node_titleJSONRequired within parent
node_title (anyOf 1)stringAlternative
node_title (anyOf 2)nullAlternative
statusstringRequired within parentKnown values: PENDING, SUBMITTED
submitted_atJSONRequired within parent
submitted_at (anyOf 1)stringAlternativeFormat: date-time
submitted_at (anyOf 2)nullAlternative
submitted_by_userJSONRequired within parent
submitted_by_user (anyOf 1)ModelAlternativeExpand 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)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootRepresents the dump schema for a custom form collection response.
custom_form_collectionModelRequired within parentExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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_uuidstringRequired within parent
draft_revisionJSONOptional
draft_revision (anyOf 1)JSONAlternative
draft_revision (anyOf 1) (anyOf 1)integerAlternativeMonotonic 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
draft_revision (anyOf 2)nullAlternative

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 custom form collection response custom form collection, custom form collection response uuid, draft revision custom form collection

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

FieldTypePresenceDescription and constraints
$objectRootRepresents the dump schema for a custom form collection on a custom form response.
custom_form_collection_log_entryModelRequired within parentExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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
uuidstringRequired within parent

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 custom form collection response custom form collection, custom form collection response uuid, draft revision custom form collection custom form collection log entry

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

FieldTypePresenceDescription and constraints
$objectRootRepresents the dump schema for a custom form collection response log entry on a custom form response.
allow_commentsbooleanOptionalDefault: false
formsarrayRequired within parent
forms[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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
labelJSONRequired within parent
label (anyOf 1)stringAlternative
label (anyOf 2)nullAlternative
uuidstringRequired within parent

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 custom form collection response custom form collection, custom form collection response uuid, draft revision custom form collection custom form collection log entry forms 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 custom form collection response custom form collection, custom form collection response uuid, draft revision custom form collection custom form collection log entry forms item

FieldTypePresenceDescription and constraints
$objectRoot
conditionsJSONRequired within parent
conditions (anyOf 1)ModelAlternativeExpand 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)nullAlternative
descriptionJSONRequired within parent
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
fieldsarrayRequired within parent
fields[]ModelEach itemExpand 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
labelJSONRequired within parent
label (anyOf 1)stringAlternative
label (anyOf 2)nullAlternative
section_idstringRequired within parent
uuidstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
custom_form_collection_response_uuidJSONRequired within parent
custom_form_collection_response_uuid (anyOf 1)stringAlternative
custom_form_collection_response_uuid (anyOf 2)nullAlternative
statusstringRequired within parentKnown values: NOT_REQUESTED, NOT_SENT, REQUESTED, SUBMITTED
status_display_descriptionJSONRequired within parent
status_display_description (anyOf 1)stringAlternative
status_display_description (anyOf 2)nullAlternative
status_display_textstringRequired within parent
submitted_atJSONRequired within parent
submitted_at (anyOf 1)stringAlternativeFormat: date-time
submitted_at (anyOf 2)nullAlternative
typestringRequired within parentKnown 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

FieldTypePresenceDescription and constraints
$objectRoot
auto_renewalJSONRequired within parent
auto_renewal (anyOf 1)booleanAlternative
auto_renewal (anyOf 2)nullAlternative
currencyJSONOptional
currency (anyOf 1)ModelAlternativeExpand 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)nullAlternative
descriptionJSONRequired within parent
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeFormat: date
end_date (anyOf 2)nullAlternative
last_date_to_terminateJSONOptional
last_date_to_terminate (anyOf 1)stringAlternativeDefault: null
Format: date
last_date_to_terminate (anyOf 2)nullAlternative
nameJSONRequired within parent
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative
payee_agreement_idstringRequired within parent
payee_logoJSONOptional
payee_logo (anyOf 1)stringAlternativeDefault: null
payee_logo (anyOf 2)nullAlternative
payee_nameJSONOptional
payee_name (anyOf 1)stringAlternativeDefault: null
payee_name (anyOf 2)nullAlternative
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeFormat: date
start_date (anyOf 2)nullAlternative
total_valueJSONRequired within parent
total_value (anyOf 1)JSONAlternative
total_value (anyOf 1) (anyOf 1)numberAlternative
total_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_value (anyOf 2)nullAlternative
up_for_renewalbooleanRequired within parent

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 linkable agreements item currency string

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

FieldTypePresenceDescription and constraints
$stringRootWe 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

FieldTypePresenceDescription and constraints
$objectRoot
_ramp_event_typestringRequired within parent
assigned_entitiesarrayRequired within parent
assigned_entities[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item assigned entities item
completed_approval_countJSONRequired within parent
completed_approval_count (anyOf 1)JSONAlternative
completed_approval_count (anyOf 1) (anyOf 1)integerAlternativeSatisfied eligible selected principals, including delegate credit; capped at the effective target.
Default: null
completed_approval_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
completed_approval_count (anyOf 2)nullAlternative
displayed_event_textstringRequired within parent
eligible_approver_countJSONRequired within parent
eligible_approver_count (anyOf 1)JSONAlternative
eligible_approver_count (anyOf 1) (anyOf 1)integerAlternativeDistinct eligible selected people across direct selections and groups, excluding delegate-only users.
Default: null
eligible_approver_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
eligible_approver_count (anyOf 2)nullAlternative
event_orderJSONRequired within parent
event_order (anyOf 1)integerAlternative
event_order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
event_typestringRequired within parentKnown values: NOTIFY, REQUIRE, REQUIRE_ALL, ROUND_ROBIN
idstringRequired within parent
is_current_stepbooleanRequired within parent
is_delegatebooleanRequired within parentDefault: false
is_last_step_for_userbooleanRequired within parent
needs_user_actionbooleanRequired within parent
needs_user_trigger_actionbooleanRequired within parentDefault: false
notesJSONRequired within parent
notes (anyOf 1)stringAlternativeDefault: null
notes (anyOf 2)nullAlternative
raw_step_orderJSONRequired within parent
raw_step_order (anyOf 1)integerAlternative
raw_step_order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
required_approval_countJSONRequired within parent
required_approval_count (anyOf 1)JSONAlternative
required_approval_count (anyOf 1) (anyOf 1)integerAlternativeConfigured approval target; execution caps it at eligible_approver_count.
Default: null
required_approval_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
required_approval_count (anyOf 2)nullAlternative
statusstringRequired within parentKnown values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, MANUALLY_SKIPPED, PENDING, REJECTED, SKIPPED, TERMINATED
step_creator_user_idJSONRequired within parent
step_creator_user_id (anyOf 1)stringAlternativeDefault: null
step_creator_user_id (anyOf 2)nullAlternative
step_dateJSONRequired within parent
step_date (anyOf 1)stringAlternativeDefault: null
step_date (anyOf 2)nullAlternative
substepsarrayRequired within parent
substeps[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item substeps item
trigger_entity_metadataJSONOptional
trigger_entity_metadata (anyOf 1)ModelAlternativeExpand 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)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
approval_trigger_instance_error_messageJSONRequired within parent
approval_trigger_instance_error_message (anyOf 1)stringAlternativeDefault: null
approval_trigger_instance_error_message (anyOf 2)nullAlternative
approval_trigger_instance_error_redirect_urlJSONRequired within parent
approval_trigger_instance_error_redirect_url (anyOf 1)stringAlternativeDefault: null
approval_trigger_instance_error_redirect_url (anyOf 2)nullAlternative
approval_trigger_typeJSONRequired within parent
approval_trigger_type (anyOf 1)stringAlternativeKnown values: GLOBAL_FORM_RESPONSE, IRONCLAD_WORKFLOW_GATE, LAUNCH_ESIGN_WORKFLOW, LAUNCH_EXTERNAL_APPROVAL, LAUNCH_IRONCLAD_WORKFLOW, LAUNCH_THIRD_PARTY_RISK_MANAGEMENT_VENDOR_REVIEW_WORKFLOW, LAUNCH_TICKETING_WORKFLOW, LAUNCH_VENDOR_ONBOARDING, SEND_BACK, WAIT_FOR_BOOKING_COMPLETION
Default: null
approval_trigger_type (anyOf 2)nullAlternative
assigned_user_full_namestringRequired within parent
assigned_user_idJSONRequired within parent
assigned_user_id (anyOf 1)stringAlternativeDefault: null
assigned_user_id (anyOf 2)nullAlternative
can_create_esign_envelopeJSONRequired within parent
can_create_esign_envelope (anyOf 1)booleanAlternativeWhether 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)nullAlternative
delegator_user_full_nameJSONRequired within parent
delegator_user_full_name (anyOf 1)stringAlternativeDefault: null
delegator_user_full_name (anyOf 2)nullAlternative
delegator_user_idJSONRequired within parent
delegator_user_id (anyOf 1)stringAlternativeDefault: null
delegator_user_id (anyOf 2)nullAlternative
entity_full_namestringRequired within parent
entity_idJSONRequired within parent
entity_id (anyOf 1)stringAlternativeDefault: null
entity_id (anyOf 2)nullAlternative
entity_typestringRequired within parentKnown values: ANY_ADMIN, GROUP, MANAGER, TRIGGER, USER, VENDOR_OWNER, VENDOR_OWNER_MANAGER
external_urlJSONRequired within parent
external_url (anyOf 1)stringAlternativeDefault: null
external_url (anyOf 2)nullAlternative
notesJSONRequired within parent
notes (anyOf 1)stringAlternativeDefault: null
notes (anyOf 2)nullAlternative
provider_typeJSONRequired within parent
provider_type (anyOf 1)stringAlternativeDefault: null
provider_type (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
assigned_entitiesarrayRequired within parent
assigned_entities[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item assigned entities item
displayed_event_textstringRequired within parent
event_typestringRequired within parentKnown values: NOTIFY, REQUIRE, REQUIRE_ALL, ROUND_ROBIN
statusstringRequired within parentKnown values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, MANUALLY_SKIPPED, PENDING, REJECTED, SKIPPED, TERMINATED
step_dateJSONRequired within parent
step_date (anyOf 1)stringAlternativeDefault: null
step_date (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"GLOBAL_FORM_RESPONSE": "#/components/schemas/GlobalFormResponseTriggerEntityMetadata", "IRONCLAD_WORKFLOW_GATE": "#/components/schemas/IroncladWorkflowGateTriggerEntityMetadata", "LAUNCH_ESIGN_WORKFLOW": "#/components/schemas/ESignTriggerEntityMetadata", "LAUNCH_EXTERNAL_APPROVAL": "#/components/schemas/ExternalApprovalTriggerEntityMetadata", "LAUNCH_IRONCLAD_WORKFLOW": "#/components/schemas/IroncladTriggerEntityMetadata", "LAUNCH_THIRD_PARTY_RISK_MANAGEMENT_VENDOR_REVIEW_WORKFLOW": "#/components/schemas/ThirdPartyRiskManagementVendorReviewTriggerEntityMetadata", "LAUNCH_TICKETING_WORKFLOW": "#/components/schemas/TicketingTriggerEntityMetadata", "LAUNCH_VENDOR_ONBOARDING": "#/components/schemas/VendorOnboardingTriggerEntityMetadata", "SEND_BACK": "#/components/schemas/SendBackTriggerEntityMetadata"}, "propertyName": "trigger_type"}
$ (anyOf 1)ModelAlternativeExpand 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
$ (anyOf 2)ModelAlternativeExpand 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
$ (anyOf 3)ModelAlternativeExpand 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
$ (anyOf 4)ModelAlternativeExpand 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
$ (anyOf 5)ModelAlternativeExpand 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
$ (anyOf 6)ModelAlternativeExpand 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
$ (anyOf 7)ModelAlternativeExpand 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
$ (anyOf 8)ModelAlternativeExpand 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
$ (anyOf 9)ModelAlternativeExpand 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

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

FieldTypePresenceDescription and constraints
$objectRoot
custom_form_collection_log_entry_labelJSONRequired within parent
custom_form_collection_log_entry_label (anyOf 1)stringAlternative
custom_form_collection_log_entry_label (anyOf 2)nullAlternative
custom_form_collection_log_entry_uuidstringRequired within parent
custom_form_collection_response_uuidJSONRequired within parent
custom_form_collection_response_uuid (anyOf 1)stringAlternative
custom_form_collection_response_uuid (anyOf 2)nullAlternative
custom_form_collection_uuidstringRequired within parent
form_entitiesarrayRequired within parent
form_entities[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE form entities item
global_form_contextstringOptionalThe purpose of the form in the approval workflow.
Known values: PROCUREMENT, ROUTE_REQUEST
Default: PROCUREMENT
global_form_response_mappingsarrayRequired within parent
global_form_response_mappings[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value global form context: PROCUREMENT, ROUTE REQUEST, trigger type GLOBAL FORM RESPONSE global form response mappings item
trigger_typestringOptionalMust equal: 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

FieldTypePresenceDescription and constraints
$objectRoot
entityJSONRequired within parentdiscriminator: {"mapping": {"GROUP": "#/components/schemas/GroupEntity", "USER": "#/components/schemas/UserEntity"}, "propertyName": "entity_type"}
entity (anyOf 1)ModelAlternativeExpand 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
entity (anyOf 2)ModelAlternativeExpand 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

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

FieldTypePresenceDescription and constraints
$objectRoot
assigned_userJSONOptional
assigned_user (anyOf 1)ModelAlternativeExpand 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)nullAlternative
assigned_user_sourceJSONOptional
assigned_user_source (anyOf 1)stringAlternativeHow 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)nullAlternative
entity_typestringRequired within parentMust equal: GROUP
group_namestringRequired within parent
group_statusstringRequired within parentKnown values: APPROVED, PENDING, REJECTED
group_typestringRequired within parentKnown values: ABSOLUTE, DYNAMIC, MANAGER_CHAIN_TRAVERSAL, RELATIVE, SEQUENTIAL_MATRIX_RESOLVER
group_uuidstringRequired within parent
reassignment_candidatesJSONOptional
reassignment_candidates (anyOf 1)arrayAlternativeEligible users for reassignment of the active round-robin approval.
Default: null
reassignment_candidates (anyOf 1)[]ModelEach itemExpand 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)nullAlternative
relative_group_typeJSONOptional
relative_group_type (anyOf 1)stringAlternativeDefault: null
relative_group_type (anyOf 2)nullAlternative
usersarrayRequired within parent
users[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item 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

FieldTypePresenceDescription and constraints
$objectRoot
entity_typestringRequired within parentMust equal: USER
userModelRequired within parentExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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: 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 user

FieldTypePresenceDescription and constraints
$objectRoot
approval_dateJSONRequired within parent
approval_date (anyOf 1)stringAlternative
approval_date (anyOf 2)nullAlternative
delegate_forarrayRequired within parent
delegate_for[]ModelEach itemExpand 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
delegated_userJSONRequired within parent
delegated_user (anyOf 1)ModelAlternativeExpand 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
delegated_user (anyOf 2)nullAlternative
reduced_userModelRequired within parentExpand 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
statusstringRequired within parentKnown values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, PENDING, REJECTED

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 global form response mappings item

FieldTypePresenceDescription and constraints
$objectRoot
custom_form_collection_response_idJSONRequired within parent
custom_form_collection_response_id (anyOf 1)JSONAlternative
custom_form_collection_response_id (anyOf 1) (anyOf 1)integerAlternative
custom_form_collection_response_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
custom_form_collection_response_id (anyOf 2)nullAlternative
global_form_response_mapping_uuidstringRequired within parent
user_uuidstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
dependent_launch_nodesarrayOptionalNode IDs of the Ironclad launch nodes whose workflows this approval node waits on.
dependent_launch_nodes[]stringEach item
errorJSONRequired within parent
error (anyOf 1)ModelAlternativeExpand 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
The approval node's stored Ironclad error, or null when it has none.
error (anyOf 2)nullAlternative
trigger_typestringOptionalThe trigger type for an Ironclad approval node.
Must equal: IRONCLAD_WORKFLOW_GATE

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

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

FieldTypePresenceDescription and constraints
$objectRoot
errorJSONRequired within parentdiscriminator: {"mapping": {"FALLBACK_ERROR": "#/components/schemas/FallbackIroncladTriggerEntityError", "MISSING_BUSINESS_ACCESS": "#/components/schemas/IroncladMissingBusinessAccessError", "MISSING_INDIVIDUAL_ACCESS": "#/components/schemas/IroncladMissingIndividualAccessError", "MISSING_PERMISSION": "#/components/schemas/IroncladWorkflowPermissionError", "MISSING_RAMP_ID_FIELD": "#/components/schemas/IroncladMissingRampIdFieldError", "REQUESTER_USER_NOT_FOUND": "#/components/schemas/IroncladRequesterUserNotFoundError"}, "propertyName": "error_type"}
error (anyOf 1)ModelAlternativeExpand 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
error (anyOf 2)ModelAlternativeExpand 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
error (anyOf 3)ModelAlternativeExpand 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
error (anyOf 4)ModelAlternativeExpand 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
error (anyOf 5)ModelAlternativeExpand 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
error (anyOf 6)ModelAlternativeExpand 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
trigger_typestringRequired within parentKnown values: LAUNCH_IRONCLAD_WORKFLOW
Default: 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

FieldTypePresenceDescription and constraints
$objectRoot
error_messageJSONRequired within parent
error_message (anyOf 1)stringAlternative
error_message (anyOf 2)nullAlternative
error_redirect_urlJSONRequired within parent
error_redirect_url (anyOf 1)stringAlternative
error_redirect_url (anyOf 2)nullAlternative
error_typestringRequired within parentMust 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

FieldTypePresenceDescription and constraints
$objectRoot
error_typestringRequired within parentIdentifies 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

FieldTypePresenceDescription and constraints
$objectRoot
business_access_emailstringRequired within parent
error_typestringRequired within parentMust equal: MISSING_INDIVIDUAL_ACCESS
requester_emailstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
error_typestringRequired within parentMust equal: MISSING_PERMISSION
requester_emailstringRequired within parent
workflow_namestringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
error_typestringRequired within parentMust 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

FieldTypePresenceDescription and constraints
$objectRoot
error_typestringRequired within parentIdentifies a requester whose email does not match an Ironclad user.
Must equal: REQUESTER_USER_NOT_FOUND
requester_emailstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
envelope_launcher_user_idJSONOptional
envelope_launcher_user_id (anyOf 1)JSONAlternative
envelope_launcher_user_id (anyOf 1) (anyOf 1)integerAlternativeDefault: null
envelope_launcher_user_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
envelope_launcher_user_id (anyOf 2)nullAlternative
envelope_statusJSONOptional
envelope_status (anyOf 1)stringAlternativeKnown values: completed, created, declined, delivered, sent, signed, voided
Default: null
envelope_status (anyOf 2)nullAlternative
errorJSONOptional
error (anyOf 1)ModelAlternativeExpand 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
Default: null
error (anyOf 2)nullAlternative
provider_typeJSONOptional
provider_type (anyOf 1)stringAlternativeDefault: null
provider_type (anyOf 2)nullAlternative
signersarrayOptional
signers[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW signers item
spend_request_uuidJSONOptional
spend_request_uuid (anyOf 1)stringAlternativeDefault: null
spend_request_uuid (anyOf 2)nullAlternative
trigger_typestringOptionalMust equal: 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

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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