Skip to content

Ramp: Unified request schemas (part 3)

60 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 sanitized approval steps array item trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW

FieldTypePresenceDescription and constraints
$objectRoot
errorJSONRequired within parentdiscriminator: {"mapping": {"API_ERROR": "#/components/schemas/ESignAPIError", "AUTHENTICATION_ERROR": "#/components/schemas/ESignAuthenticationError", "FALLBACK_ERROR": "#/components/schemas/FallbackESignTriggerEntityError", "PROVIDER_NOT_CONFIGURED": "#/components/schemas/ESignProviderNotConfiguredError", "RATE_LIMIT_ERROR": "#/components/schemas/ESignRateLimitError", "VALIDATION_ERROR": "#/components/schemas/ESignValidationError"}, "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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type API 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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type AUTHENTICATION ERROR
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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type PROVIDER NOT CONFIGURED
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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type RATE LIMIT ERROR
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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type VALIDATION ERROR
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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type FALLBACK ERROR
trigger_typestringRequired within parentKnown values: LAUNCH_ESIGN_WORKFLOW
Default: 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 error trigger type: LAUNCH ESIGN WORKFLOW error error type API 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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type AUTHENTICATION 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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type PROVIDER NOT CONFIGURED, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 error error type RATE LIMIT 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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type VALIDATION 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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN 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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type API ERROR

FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringRequired within parent
error_typestringRequired within parentMust equal: API_ERROR
provider_typestringRequired 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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type AUTHENTICATION ERROR

FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringRequired within parent
error_typestringRequired within parentMust equal: AUTHENTICATION_ERROR
provider_typestringRequired 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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type FALLBACK ERROR

FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringRequired within parent
error_typestringRequired within parentMust equal: FALLBACK_ERROR
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 trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type PROVIDER NOT CONFIGURED

FieldTypePresenceDescription and constraints
$objectRoot
error_typestringRequired within parentMust equal: PROVIDER_NOT_CONFIGURED
provider_typestringRequired 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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type RATE LIMIT ERROR

FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringRequired within parent
error_typestringRequired within parentMust equal: RATE_LIMIT_ERROR
provider_typestringRequired 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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type VALIDATION ERROR

FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringRequired within parent
error_typestringRequired within parentMust equal: VALIDATION_ERROR
provider_typestringRequired 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 LAUNCH ESIGN WORKFLOW signers item

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parent
namestringRequired within parent
recipient_typestringOptionalKnown values: carbonCopy, signer
Default: signer
routing_orderJSONRequired within parent
routing_order (anyOf 1)JSONAlternative
routing_order (anyOf 1) (anyOf 1)integerAlternative
routing_order (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
routing_order (anyOf 2)nullAlternative
signed_datetimeJSONRequired within parent
signed_datetime (anyOf 1)stringAlternativeFormat: date-time
signed_datetime (anyOf 2)nullAlternative
statusstringRequired within parentKnown values: completed, created, declined, delivered, sent

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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

FieldTypePresenceDescription and constraints
$objectRoot
recipientsarrayRequired within parent
recipients[]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 EXTERNAL APPROVAL recipients item
service_keyJSONOptional
service_key (anyOf 1)stringAlternativeDefault: null
service_key (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)stringAlternativeDefault: null
status (anyOf 2)nullAlternative
trigger_typestringOptionalMust equal: LAUNCH_EXTERNAL_APPROVAL
urlJSONOptional
url (anyOf 1)stringAlternativeDefault: null
url (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 trigger entity metadata value trigger type LAUNCH EXTERNAL APPROVAL recipients 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 EXTERNAL APPROVAL recipients item

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parent
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 LAUNCH IRONCLAD WORKFLOW

FieldTypePresenceDescription and constraints
$objectRoot
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
error (anyOf 2)nullAlternative
ironclad_workflow_statusJSONOptional
ironclad_workflow_status (anyOf 1)stringAlternativeCurrent status of the Ironclad workflow, independent of whether the Ramp step is complete. Null when the status is not available.
Known values: active, cancelled, completed, paused
Default: null
ironclad_workflow_status (anyOf 2)nullAlternative
ironclad_workflow_urlJSONOptional
ironclad_workflow_url (anyOf 1)stringAlternativeDefault: null
ironclad_workflow_url (anyOf 2)nullAlternative
stepsarrayRequired within parent
steps[]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 IRONCLAD WORKFLOW steps item
trigger_typestringOptionalMust equal: 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, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps 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 IRONCLAD WORKFLOW steps item

FieldTypePresenceDescription and constraints
$JSONRootDiscriminated union of all Ironclad workflow step types.
discriminator: {"mapping": {"Archive": "#/components/schemas/IroncladArchiveWorkflowStep", "Create": "#/components/schemas/IroncladCreateWorkflowStep", "Review": "#/components/schemas/IroncladReviewWorkflowStep", "Sign": "#/components/schemas/IroncladSignWorkflowStep", "completed": "#/components/schemas/IroncladCompletedWorkflowStep"}, "propertyName": "step"}
$ (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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Archive
$ (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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step completed
$ (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 LAUNCH IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Create
$ (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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review
$ (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 LAUNCH IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Sign

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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Archive, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step completed, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Create, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Sign

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Archive

FieldTypePresenceDescription and constraints
$objectRoot
display_textstringRequired within parent
statusstringRequired within parentKnown values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, PENDING, REJECTED
stepstringRequired within parentMust equal: Archive

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Create

FieldTypePresenceDescription and constraints
$objectRoot
display_textstringRequired within parent
statusstringRequired within parentKnown values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, PENDING, REJECTED
stepstringRequired within parentMust equal: Create

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review

FieldTypePresenceDescription and constraints
$objectRoot
display_textstringRequired within parent
reviewersJSONRequired within parent
reviewers (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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id
reviewers (anyOf 2)nullAlternative
statusstringRequired within parentKnown values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, PENDING, REJECTED
stepstringRequired within parentMust equal: Review

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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id

FieldTypePresenceDescription and constraints
$objectRoot
approval_groupsarrayRequired within parent
approval_groups[]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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id approval groups item
rolesarrayRequired within parent
roles[]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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id roles item
titlestringRequired within parent
workflow_idstringRequired 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 sanitized approval steps array item trigger entity metadata value trigger type LAUNCH IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id roles 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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id approval groups 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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id approval groups item

FieldTypePresenceDescription and constraints
$objectRoot
reviewersarrayRequired within parent
reviewers[]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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id approval groups item reviewers item
statusJSONOptional
status (anyOf 1)stringAlternativeIronclad approval group status; only active groups can be approved.
Default: null
status (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 trigger entity metadata value trigger type LAUNCH IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id approval groups item reviewers 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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id approval groups item reviewers item

FieldTypePresenceDescription and constraints
$objectRootModel for an Ironclad reviewer based on IroncladWorkflowReviewerSchema.
display_namestringRequired within parent
reviewer_typestringRequired within parent
rolestringRequired within parent
statusstringRequired within parentKnown values: approved, pending

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id roles item

FieldTypePresenceDescription and constraints
$objectRoot
assigneesarrayRequired within parent
assignees[]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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id roles item assignees item
display_namestringRequired within parent
idstringRequired 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 sanitized approval steps array item trigger entity metadata value trigger type LAUNCH IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id roles item assignees 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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Review reviewers approval groups, roles, title, workflow id roles item assignees item

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parent
user_idstringRequired within parent
user_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 LAUNCH IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Sign

FieldTypePresenceDescription and constraints
$objectRoot
display_textstringRequired within parent
signersJSONRequired within parent
signers (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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Sign signers routing, signers, title, workflow id
signers (anyOf 2)nullAlternative
statusstringRequired within parentKnown values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, PENDING, REJECTED
stepstringRequired within parentMust equal: Sign

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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Sign signers routing, signers, title, workflow id

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Sign signers routing, signers, title, workflow id

FieldTypePresenceDescription and constraints
$objectRoot
routingstringRequired within parent
signersarrayRequired within parent
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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Sign signers routing, signers, title, workflow id signers item
titlestringRequired within parent
workflow_idstringRequired 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 sanitized approval steps array item trigger entity metadata value trigger type LAUNCH IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Sign signers routing, signers, title, workflow id 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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Sign signers routing, signers, title, workflow id signers item

FieldTypePresenceDescription and constraints
$objectRootModel for an Ironclad signer based on IroncladWorkflowSignerSchema.
emailstringRequired within parent
namestringRequired within parent
role_namestringRequired within parent
routing_orderJSONOptional
routing_order (anyOf 1)JSONAlternative
routing_order (anyOf 1) (anyOf 1)integerAlternativeDefault: null
routing_order (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
routing_order (anyOf 2)nullAlternative
signature_statusModelRequired 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 trigger type LAUNCH IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Sign signers routing, signers, title, workflow id signers item signature status

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 IRONCLAD WORKFLOW steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Sign signers routing, signers, title, workflow id signers item signature status

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step Sign signers routing, signers, title, workflow id signers item signature status

FieldTypePresenceDescription and constraints
$objectRoot
statusstringRequired within parentKnown values: declined, pending, sent, signed, viewed

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item status: ADMIN APPROVED, ADMIN REJECTED, APPROVED, COMPLETED, PENDING, REJECTED, step completed

FieldTypePresenceDescription and constraints
$objectRoot
display_textstringRequired within parent
statusstringRequired within parentKnown values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, PENDING, REJECTED
stepstringRequired within parentMust equal: completed

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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

FieldTypePresenceDescription and constraints
$objectRoot
due_dateJSONOptional
due_date (anyOf 1)stringAlternativeDefault: null
due_date (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 THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW
Default: null
error (anyOf 2)nullAlternative
external_review_linkJSONOptional
external_review_link (anyOf 1)stringAlternativeDefault: null
external_review_link (anyOf 2)nullAlternative
provider_typeJSONOptional
provider_type (anyOf 1)stringAlternativeKnown values: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA
Default: null
provider_type (anyOf 2)nullAlternative
review_idJSONOptional
review_id (anyOf 1)stringAlternativeDefault: null
review_id (anyOf 2)nullAlternative
review_statusJSONOptional
review_status (anyOf 1)stringAlternativeKnown values: APPROVED, CLOSED, CONDITIONALLY_APPROVED, PENDING_REVIEW_REQUEST_COMPLETION, PENDING_REVIEW_REQUEST_START, PRE_APPROVED, PRE_CONDITIONALLY_APPROVED, PRE_REJECTED, REJECTED, REVIEW_REQUESTED, SKIPPED
Default: null
review_status (anyOf 2)nullAlternative
stepsarrayRequired within parent
steps[]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 THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW steps item
trigger_typestringOptionalMust equal: LAUNCH_THIRD_PARTY_RISK_MANAGEMENT_VENDOR_REVIEW_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 THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error 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 THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW steps 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 THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW

FieldTypePresenceDescription and constraints
$objectRoot
errorJSONRequired within parentdiscriminator: {"mapping": {"API_ERROR": "#/components/schemas/ThirdPartyRiskManagementAPIError", "ARAVO_MULTIPLE_REPORT_ERROR": "#/components/schemas/AravoMultipleReportError", "AUTHENTICATION_ERROR": "#/components/schemas/ThirdPartyRiskManagementAuthenticationError", "FALLBACK_ERROR": "#/components/schemas/FallbackThirdPartyRiskManagementTriggerEntityError", "PROVIDER_NOT_CONFIGURED": "#/components/schemas/ThirdPartyRiskManagementProviderNotConfiguredError"}, "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 LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error error type ARAVO MULTIPLE REPORT ERROR, provider type: ARAVO
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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type FALLBACK ERROR
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 LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error error type API ERROR, provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA
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 LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error error type AUTHENTICATION ERROR, provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA
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 LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error error type PROVIDER NOT CONFIGURED, provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA
trigger_typestringRequired within parentKnown values: LAUNCH_THIRD_PARTY_RISK_MANAGEMENT_VENDOR_REVIEW_WORKFLOW
Default: LAUNCH_THIRD_PARTY_RISK_MANAGEMENT_VENDOR_REVIEW_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 error trigger type: LAUNCH ESIGN 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 LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error error type ARAVO MULTIPLE REPORT ERROR, provider type: ARAVO, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error error type API ERROR, provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error error type AUTHENTICATION ERROR, provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error error type PROVIDER NOT CONFIGURED, provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error error type API ERROR, provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA

FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringRequired within parent
error_typestringRequired within parentMust equal: API_ERROR
provider_typestringRequired within parentKnown values: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error error type ARAVO MULTIPLE REPORT ERROR, provider type: ARAVO

FieldTypePresenceDescription and constraints
$objectRoot
error_messageJSONRequired within parent
error_message (anyOf 1)stringAlternativeDefault: null
error_message (anyOf 2)nullAlternative
error_typestringRequired within parentMust equal: ARAVO_MULTIPLE_REPORT_ERROR
provider_typestringRequired within parentKnown values: ARAVO
Default: ARAVO

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error error type AUTHENTICATION ERROR, provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA

FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringRequired within parent
error_typestringRequired within parentMust equal: AUTHENTICATION_ERROR
provider_typestringRequired within parentKnown values: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 error trigger type: LAUNCH THIRD PARTY RISK MANAGEMENT VENDOR REVIEW WORKFLOW error error type PROVIDER NOT CONFIGURED, provider type: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA

FieldTypePresenceDescription and constraints
$objectRoot
error_messageJSONRequired within parent
error_message (anyOf 1)stringAlternativeDefault: null
error_message (anyOf 2)nullAlternative
error_typestringRequired within parentMust equal: PROVIDER_NOT_CONFIGURED
provider_typestringRequired within parentKnown values: ARAVO, DRATA, LOGICGATE, ONETRUST, VANTA

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 steps item

FieldTypePresenceDescription and constraints
$objectRootA single step in the TPRM vendor review workflow.

Steps are provider-specific and decoupled from the review status enum,
allowing each provider to define custom workflow progression.
display_textstringRequired within parent
statusstringRequired within parentKnown values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, 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 trigger type LAUNCH TICKETING WORKFLOW

FieldTypePresenceDescription and constraints
$objectRoot
collection_nameJSONOptional
collection_name (anyOf 1)stringAlternativeDefault: null
collection_name (anyOf 2)nullAlternative
custom_statusJSONOptional
custom_status (anyOf 1)stringAlternativeDefault: null
custom_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 TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW
Default: null
error (anyOf 2)nullAlternative
provider_typeJSONOptional
provider_type (anyOf 1)stringAlternativeDefault: null
provider_type (anyOf 2)nullAlternative
ticket_dataJSONOptional
ticket_data (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 TICKETING WORKFLOW ticket data provider type: asana, jira, linear, zendesk
Default: null
ticket_data (anyOf 2)nullAlternative
ticket_idJSONOptional
ticket_id (anyOf 1)stringAlternativeDefault: null
ticket_id (anyOf 2)nullAlternative
ticket_statusJSONOptional
ticket_status (anyOf 1)stringAlternativeKnown values: CLOSED, IN_PROGRESS, ON_HOLD, OPEN
Default: null
ticket_status (anyOf 2)nullAlternative
ticket_urlJSONOptional
ticket_url (anyOf 1)stringAlternativeDefault: null
ticket_url (anyOf 2)nullAlternative
trigger_typestringOptionalMust equal: LAUNCH_TICKETING_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 TICKETING WORKFLOW ticket data provider type: asana, jira, linear, zendesk, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 error 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 TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW

FieldTypePresenceDescription and constraints
$objectRoot
errorJSONRequired within parentdiscriminator: {"mapping": {"API_ERROR": "#/components/schemas/TicketingAPIError", "AUTHENTICATION_ERROR": "#/components/schemas/TicketingAuthenticationError", "COLLECTION_NOT_FOUND": "#/components/schemas/TicketingCollectionNotFoundError", "FALLBACK_ERROR": "#/components/schemas/FallbackTicketingTriggerEntityError", "PROVIDER_NOT_CONFIGURED": "#/components/schemas/TicketingProviderNotConfiguredError", "VALIDATION_ERROR": "#/components/schemas/TicketingValidationError"}, "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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN 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 LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type API ERROR
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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type AUTHENTICATION ERROR
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 LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type COLLECTION NOT FOUND
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 LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type PROVIDER NOT CONFIGURED
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 LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type VALIDATION ERROR
trigger_typestringRequired within parentKnown values: LAUNCH_TICKETING_WORKFLOW
Default: LAUNCH_TICKETING_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 error trigger type: LAUNCH ESIGN WORKFLOW error error type AUTHENTICATION 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 LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN 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 LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type API 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 LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type COLLECTION 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 LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type PROVIDER NOT CONFIGURED, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 error trigger type: LAUNCH TICKETING WORKFLOW error error type VALIDATION 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 LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type API ERROR

FieldTypePresenceDescription and constraints
$objectRoot
collection_idJSONRequired within parent
collection_id (anyOf 1)stringAlternativeDefault: null
collection_id (anyOf 2)nullAlternative
error_messagestringRequired within parent
error_typestringRequired within parentMust equal: API_ERROR
provider_typestringRequired 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 LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type COLLECTION NOT FOUND

FieldTypePresenceDescription and constraints
$objectRoot
collection_idstringRequired within parent
error_typestringRequired within parentMust equal: COLLECTION_NOT_FOUND
provider_typestringRequired 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 LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type PROVIDER NOT CONFIGURED

FieldTypePresenceDescription and constraints
$objectRoot
collection_idstringRequired within parent
error_typestringRequired within parentMust equal: PROVIDER_NOT_CONFIGURED
provider_typestringRequired 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 LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type VALIDATION ERROR

FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringRequired within parent
error_typestringRequired within parentMust equal: VALIDATION_ERROR
field_errorsJSONRequired within parent
field_errors (anyOf 1)objectAlternativeDefault: null
Additional keys: see wildcard field
field_errors (anyOf 1).*stringAdditional keys
field_errors (anyOf 2)nullAlternative
provider_typestringRequired 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 LAUNCH TICKETING WORKFLOW ticket data provider type: asana, jira, linear, zendesk

FieldTypePresenceDescription and constraints
$objectRoot
approval_trigger_instance_uuidJSONRequired within parent
approval_trigger_instance_uuid (anyOf 1)stringAlternative
approval_trigger_instance_uuid (anyOf 2)nullAlternative
assigneesJSONOptional
assignees (anyOf 1)arrayAlternativeDefault: null
assignees (anyOf 1)[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH TICKETING WORKFLOW ticket data provider type: asana, jira, linear, zendesk assignees array item
assignees (anyOf 2)nullAlternative
business_idJSONRequired within parent
business_id (anyOf 1)integerAlternative
business_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
collection_nameJSONRequired within parent
collection_name (anyOf 1)stringAlternative
collection_name (anyOf 2)nullAlternative
custom_statusJSONOptional
custom_status (anyOf 1)stringAlternativeDefault: null
custom_status (anyOf 2)nullAlternative
descriptionJSONRequired within parent
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
idstringRequired within parent
nameJSONRequired within parent
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative
provider_typestringRequired within parentKnown values: asana, jira, linear, zendesk
remote_dataJSONRequired within parent
remote_data (anyOf 1)objectAlternative
remote_data (anyOf 2)nullAlternative
remote_idJSONRequired within parent
remote_id (anyOf 1)stringAlternative
remote_id (anyOf 2)nullAlternative
remote_was_deletedbooleanRequired within parent
statusJSONRequired within parent
status (anyOf 1)stringAlternativeKnown values: CLOSED, IN_PROGRESS, ON_HOLD, OPEN
status (anyOf 2)nullAlternative
typeJSONRequired within parent
type (anyOf 1)stringAlternative
type (anyOf 2)nullAlternative
urlJSONRequired within parent
url (anyOf 1)stringAlternative
url (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 trigger entity metadata value trigger type LAUNCH TICKETING WORKFLOW ticket data provider type: asana, jira, linear, zendesk assignees 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 sanitized approval steps array item trigger entity metadata value trigger type LAUNCH TICKETING WORKFLOW ticket data provider type: asana, jira, linear, zendesk assignees array item

FieldTypePresenceDescription and constraints
$objectRoot
display_nameJSONOptional
display_name (anyOf 1)stringAlternativeDefault: null
display_name (anyOf 2)nullAlternative
emailJSONOptional
email (anyOf 1)stringAlternativeDefault: null
email (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 trigger entity metadata value trigger type LAUNCH VENDOR ONBOARDING

FieldTypePresenceDescription and constraints
$objectRoot
payee_uuidJSONRequired within parent
payee_uuid (anyOf 1)stringAlternative
payee_uuid (anyOf 2)nullAlternative
request_detailsarrayRequired within parent
request_details[]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 VENDOR ONBOARDING request details item
trigger_typestringRequired within parentMust equal: 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 VENDOR ONBOARDING request details 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 VENDOR ONBOARDING request details item

FieldTypePresenceDescription and constraints
$objectRoot
detail_typestringRequired within parentProcurementPayeeDetailsRequestField is a simplified enum
on the PayeeDetailsRequest that consolidates (ach, check, wire) into single payment details.
Known values: CUSTOM_FORM, PAYMENT, TAX
display_textstringRequired within parent
submitted_atJSONOptional
submitted_at (anyOf 1)stringAlternativeDefault: null
Format: date-time
submitted_at (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 trigger entity metadata value trigger type SEND BACK

FieldTypePresenceDescription and constraints
$objectRoot
assignee_group_uuidJSONOptional
assignee_group_uuid (anyOf 1)stringAlternativeWorkflow group the request was sent back to, if any.
Default: null
assignee_group_uuid (anyOf 2)nullAlternative
assignee_relative_group_typeJSONOptional
assignee_relative_group_type (anyOf 1)stringAlternativeRelative role the request was sent back to, if any.
Default: null
assignee_relative_group_type (anyOf 2)nullAlternative
assignee_userJSONOptional
assignee_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
User the request was sent back to, if any.
Default: null
assignee_user (anyOf 2)nullAlternative
instructionsJSONOptional
instructions (anyOf 1)stringAlternativeInstructions shown to the assignee.
Default: null
instructions (anyOf 2)nullAlternative
resolutionJSONOptional
resolution (anyOf 1)stringAlternativeHow the node completed; null while the send-back is still active.
Known values: RESOLVED, RETURNED, SKIPPED
Default: null
resolution (anyOf 2)nullAlternative
resolved_atJSONOptional
resolved_at (anyOf 1)stringAlternativeWhen the send-back was returned, resolved, or canceled.
Default: null
resolved_at (anyOf 2)nullAlternative
resolved_by_userJSONOptional
resolved_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
User who returned or resolved the send-back.
Default: null
resolved_by_user (anyOf 2)nullAlternative
response_bodyJSONOptional
response_body (anyOf 1)stringAlternativeMessage the assignee or admin left when completing the step.
Default: null
response_body (anyOf 2)nullAlternative
send_back_statusJSONOptional
send_back_status (anyOf 1)stringAlternativeLifecycle status for a procurement send-back cycle.
Lifecycle status of the send-back row.
Known values: ACTIVE, CANCELED, RETURNED
Default: null
send_back_status (anyOf 2)nullAlternative
send_back_uuidJSONOptional
send_back_uuid (anyOf 1)stringAlternativeUUID of the send-back row the node opened.
Default: null
send_back_uuid (anyOf 2)nullAlternative
trigger_typestringOptionalThe trigger type for a send-back node.
Must equal: SEND_BACK

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 sourcing event current rfx, id, name

FieldTypePresenceDescription and constraints
$objectRoot
current_rfxJSONRequired within parent
current_rfx (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 sourcing event current rfx, id, name current rfx id, name
Read only: true
current_rfx (anyOf 2)nullAlternative
idstringRequired within parent
namestringRequired 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 sourcing event current rfx, id, name current rfx id, 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 sourcing event current rfx, id, name current rfx id, name

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
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 spend intent config snapshot purchase order

FieldTypePresenceDescription and constraints
$objectRootSnapshot of spend intent config at SpendRequest creation time.

Stored on SpendRequest to pin creation-time config, preventing later
program changes from retroactively affecting existing requests.
purchase_orderJSONOptional
purchase_order (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 spend intent config snapshot purchase order purchase order line item custom field configs, required line item tracking category ids
Default: null
purchase_order (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 spend intent config snapshot purchase order purchase order line item custom field configs, required line item tracking category ids

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE spend intent config snapshot purchase order purchase order line item custom field configs, required line item tracking category ids

FieldTypePresenceDescription and constraints
$objectRootSnapshot of PO-specific config at SpendRequest creation time.
line_item_custom_field_configsarrayOptionalDefault: []
line_item_custom_field_configs[]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 spend intent config snapshot purchase order purchase order line item custom field configs, required line item tracking category ids line item custom field configs item
required_line_item_tracking_category_idsarrayOptionalRequired line-item tracking category IDs at request creation
required_line_item_tracking_category_ids[]JSONEach item
required_line_item_tracking_category_ids[] (anyOf 1)integerAlternative
required_line_item_tracking_category_ids[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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 spend intent config snapshot purchase order purchase order line item custom field configs, required line item tracking category ids line item custom field configs 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 spend intent config snapshot purchase order purchase order line item custom field configs, required line item tracking category ids line item custom field configs item

FieldTypePresenceDescription and constraints
$objectRootSnapshot of a PO line item custom field config at SpendRequest creation time.
custom_field_idstringRequired within parent
is_enabledbooleanRequired within parent
is_requiredbooleanRequired 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 spend request documents item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentFormat: date-time
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
document_sourcestringRequired within parentKnown values: DEVELOPER_API, DOCUSIGN, IRONCLAD, RAMP
document_typestringRequired within parentKnown values: PURCHASE_ORDER, SPEND_REQUEST
download_pdf_urlJSONRequired within parent
download_pdf_url (anyOf 1)stringAlternativeRead only: true
download_pdf_url (anyOf 2)nullAlternative
external_document_urlJSONRequired within parent
external_document_url (anyOf 1)stringAlternativeRead only: true
external_document_url (anyOf 2)nullAlternative
filetypeJSONRequired within parent
filetype (anyOf 1)stringAlternativeKnown values: base64, csv, doc, docx, eml, gif, gz, heic, html, ics, iif, jpeg, json, jsonl, md, mp3, msg, npy, ods, parquet, pdf, pgp, png, ppt, pptx, py, txt, webp, xls, xlsm, xlsx, xml, zip
Read only: true
filetype (anyOf 2)nullAlternative
idstringRequired within parentFormat: uuid
is_ocr_documentbooleanRequired within parent
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
original_filenameJSONRequired within parent
original_filename (anyOf 1)stringAlternative
original_filename (anyOf 2)nullAlternative
payee_agreement_idsarrayRequired within parentRead only: true
payee_agreement_ids[]stringEach item
procurement_document_result_responseJSONRequired within parent
procurement_document_result_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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
Read only: true
procurement_document_result_response (anyOf 2)nullAlternative
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_urlstringRequired within parentRead only: true
spend_request_download_document_urlstringRequired within parentRead only: true
spend_request_uuidJSONRequired within parent
spend_request_uuid (anyOf 1)stringAlternativeRead only: true
spend_request_uuid (anyOf 2)nullAlternative
spend_request_view_document_urlstringRequired within parentRead only: true
typeJSONRequired within parentDefault: SPEND_REQUEST_DOCUMENT

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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalKnown 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
entity_uuidJSONRequired within parent
entity_uuid (anyOf 1)stringAlternativeDefault: null
entity_uuid (anyOf 2)nullAlternative
line_itemsarrayRequired within parent
line_items[]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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY line items item
nameJSONRequired within parent
name (anyOf 1)stringAlternativeDefault: null
name (anyOf 2)nullAlternative
ocr_detected_currencyJSONRequired within parent
ocr_detected_currency (anyOf 1)stringAlternativeRaw currency value detected by OCR when Core fell back to a supported currency. Null when no currency fallback occurred.
ocr_detected_currency (anyOf 2)nullAlternative
payeeJSONRequired within parent
payee (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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY payee logo, name, uuid
Default: null
payee (anyOf 2)nullAlternative
purchase_order_autocoding_suggestionsJSONOptional
purchase_order_autocoding_suggestions (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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY purchase order autocoding suggestions autocoding run id, line item tracking category suggestions, tracking category suggestions
Purchase order accounting values suggested from the uploaded document.
purchase_order_autocoding_suggestions (anyOf 2)nullAlternative
spend_end_dateJSONRequired within parent
spend_end_date (anyOf 1)stringAlternativeDefault: null
spend_end_date (anyOf 2)nullAlternative
spend_frequencystringRequired within parentKnown values: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
spend_start_dateJSONRequired within parent
spend_start_date (anyOf 1)stringAlternativeDefault: null
spend_start_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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY line items 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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY payee logo, name, uuid, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY purchase order autocoding suggestions autocoding run id, line item tracking category suggestions, tracking category suggestions

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY line items item

FieldTypePresenceDescription and constraints
$objectRoot
custom_field_valuesarrayOptionalEnabled line-item custom field values extracted from the document.
custom_field_values[]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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY line items item custom field values item
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDefault: null
description (anyOf 2)nullAlternative
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeDefault: null
Format: date
end_date (anyOf 2)nullAlternative
line_item_typestringRequired within parentKnown values: EXPENSE, ITEM
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeDefault: null
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternative
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeDefault: null
Format: date
start_date (anyOf 2)nullAlternative
unit_priceJSONRequired within parent
unit_price (anyOf 1)JSONAlternative
unit_price (anyOf 1) (anyOf 1)numberAlternativeDefault: null
unit_price (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit_price (anyOf 2)nullAlternative
unit_quantityJSONRequired within parent
unit_quantity (anyOf 1)JSONAlternative
unit_quantity (anyOf 1) (anyOf 1)integerAlternativeUse `quantity` instead.
unit_quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit_quantity (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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY line items item custom field values item

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY line items item custom field values item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
custom_field_idstringRequired within parentID of the PO line-item custom field (the config's custom_field_id) this value is for.
valueJSONRequired within parent
value (anyOf 1)JSONAlternativeValue for the custom field. For a multi-select field, add one entry per selected value using the same custom_field_id. Omit the custom-field entry when the value is unknown; pass null only to clear an existing value.
value (anyOf 1) (anyOf 1)booleanAlternative
value (anyOf 1) (anyOf 2)JSONAlternative
value (anyOf 1) (anyOf 2) (anyOf 1)numberAlternative
value (anyOf 1) (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value (anyOf 1) (anyOf 3)stringAlternative
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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY payee logo, name, uuid

FieldTypePresenceDescription and constraints
$objectRoot
logoJSONRequired within parent
logo (anyOf 1)stringAlternativeDefault: null
logo (anyOf 2)nullAlternative
namestringRequired within parent
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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY purchase order autocoding suggestions autocoding run id, line item tracking category suggestions, tracking category suggestions

FieldTypePresenceDescription and constraints
$objectRoot
autocoding_run_idJSONOptional
autocoding_run_id (anyOf 1)stringAlternativePersisted Intake OCR preview run that produced these suggestions.
Default: null
Format: uuid
autocoding_run_id (anyOf 2)nullAlternative
line_item_tracking_category_suggestionsobjectOptionalAccounting suggestions keyed by zero-based line item index.
Additional keys: see wildcard field
line_item_tracking_category_suggestions.*arrayAdditional keys
line_item_tracking_category_suggestions.*[]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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY purchase order autocoding suggestions autocoding run id, line item tracking category suggestions, tracking category suggestions tracking category suggestions item
tracking_category_suggestionsarrayOptionalAccounting suggestions for purchase order body fields.
tracking_category_suggestions[]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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY purchase order autocoding suggestions autocoding run id, line item tracking category suggestions, tracking category suggestions tracking category suggestions 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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY purchase order autocoding suggestions autocoding run id, line item tracking category suggestions, tracking category suggestions tracking category suggestions 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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY purchase order autocoding suggestions autocoding run id, line item tracking category suggestions, tracking category suggestions tracking category suggestions item

FieldTypePresenceDescription and constraints
$objectRoot
meta_dataModelRequired 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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY purchase order autocoding suggestions autocoding run id, line item tracking category suggestions, tracking category suggestions tracking category suggestions item meta data
Attribution metadata for the suggestion.
tracking_category_idJSONRequired within parent
tracking_category_id (anyOf 1)integerAlternativeTracking category to populate.
tracking_category_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tracking_category_option_idJSONRequired within parent
tracking_category_option_id (anyOf 1)JSONAlternative
tracking_category_option_id (anyOf 1) (anyOf 1)integerAlternativeSuggested option, or null when no option was resolved.
tracking_category_option_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tracking_category_option_id (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 spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY purchase order autocoding suggestions autocoding run id, line item tracking category suggestions, tracking category suggestions tracking category suggestions item meta data

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY purchase order autocoding suggestions autocoding run id, line item tracking category suggestions, tracking category suggestions tracking category suggestions item meta data

FieldTypePresenceDescription and constraints
$objectRoot
reasonJSONOptional
reason (anyOf 1)stringAlternativeReason for the suggestion.
reason (anyOf 2)nullAlternative
workflow_condition_idJSONOptional
workflow_condition_id (anyOf 1)stringAlternativeWorkflow condition that produced the suggestion, if any.
workflow_condition_id (anyOf 2)nullAlternative
workflow_rule_uuidJSONOptional
workflow_rule_uuid (anyOf 1)stringAlternativeWorkflow rule that produced the suggestion, if any.
workflow_rule_uuid (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 workflow execution status last updated, status

FieldTypePresenceDescription and constraints
$objectRoot
last_updatedstringRequired within parent
statusstringRequired within parentKnown values: cancelled, failed, finished, finished_early, not_started, running, scheduled

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE
$ (allOf 2)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER

Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER

Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE
$ (allOf 2)objectAll variants apply
$ (allOf 2).purchase_orderModelRequired 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: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order
$ (allOf 2).purchase_order_detailModelRequired 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: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order
Read only: true
$ (allOf 2).total_amount_details_in_business_default_currencyJSONRequired within parent
$ (allOf 2).total_amount_details_in_business_default_currency (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details
Read only: true
$ (allOf 2).total_amount_details_in_business_default_currency (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, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order

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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_tracking_category_selectionsarrayRequired within parentRead only: true
accounting_tracking_category_selections[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order accounting tracking category selections item
can_view_full_purchase_orderbooleanRequired within parentWhether the acting user can open the full purchase order.
Read only: true
idstringRequired within parentFormat: uuid
is_directly_issuedbooleanRequired within parentTrue when the PO was issued directly, without a program or request approval.
is_linked_to_bills_or_provisional_billsbooleanRequired within parentWhether linked bills or unattached provisional bills prevent changing the purchase order's entity.
Read only: true
punchout_order_idJSONRequired within parent
punchout_order_id (anyOf 1)stringAlternativeFormat: uuid
Read only: true
punchout_order_id (anyOf 2)nullAlternative
purchase_order_fund_uuidJSONRequired within parent
purchase_order_fund_uuid (anyOf 1)stringAlternativeRead only: true
purchase_order_fund_uuid (anyOf 2)nullAlternative
purchase_order_line_item_log_entriesarrayRequired within parentRead only: true
purchase_order_line_item_log_entries[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order purchase order line item log entries item
purchase_order_numberJSONRequired within parent
purchase_order_number (anyOf 1)stringAlternativeRead only: true
purchase_order_number (anyOf 2)nullAlternative
should_create_fund_on_approvalbooleanRequired within parent
tax_linesarrayRequired within parentTax amounts aggregated by tax rate for the purchase order.
Read only: true
tax_lines[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order tax lines item

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

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.