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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | string | Required within parent | |
error_type | string | Required within parent | Must equal: API_ERROR |
provider_type | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type AUTHENTICATION ERROR
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | string | Required within parent | |
error_type | string | Required within parent | Must equal: AUTHENTICATION_ERROR |
provider_type | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type FALLBACK ERROR
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | string | Required within parent | |
error_type | string | Required within parent | Must equal: FALLBACK_ERROR |
provider_type | JSON | Required within parent | |
provider_type (anyOf 1) | string | Alternative | Default: null |
provider_type (anyOf 2) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type PROVIDER NOT CONFIGURED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_type | string | Required within parent | Must equal: PROVIDER_NOT_CONFIGURED |
provider_type | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type RATE LIMIT ERROR
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | string | Required within parent | |
error_type | string | Required within parent | Must equal: RATE_LIMIT_ERROR |
provider_type | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW error trigger type: LAUNCH ESIGN WORKFLOW error error type VALIDATION ERROR
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | string | Required within parent | |
error_type | string | Required within parent | Must equal: VALIDATION_ERROR |
provider_type | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH ESIGN WORKFLOW signers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | |
name | string | Required within parent | |
recipient_type | string | Optional | Known values: carbonCopy, signer Default: signer |
routing_order | JSON | Required within parent | |
routing_order (anyOf 1) | JSON | Alternative | |
routing_order (anyOf 1) (anyOf 1) | integer | Alternative | |
routing_order (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
routing_order (anyOf 2) | null | Alternative | |
signed_datetime | JSON | Required within parent | |
signed_datetime (anyOf 1) | string | Alternative | Format: date-time |
signed_datetime (anyOf 2) | null | Alternative | |
status | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
recipients | array | Required within parent | |
recipients[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH EXTERNAL APPROVAL recipients item |
service_key | JSON | Optional | |
service_key (anyOf 1) | string | Alternative | Default: null |
service_key (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | Default: null |
status (anyOf 2) | null | Alternative | |
trigger_type | string | Optional | Must equal: LAUNCH_EXTERNAL_APPROVAL |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | Default: null |
url (anyOf 2) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH EXTERNAL APPROVAL recipients item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | |
name | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_text | string | Required within parent | |
status | string | Required within parent | Known values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, PENDING, REJECTED |
step | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_text | string | Required within parent | |
status | string | Required within parent | Known values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, PENDING, REJECTED |
step | string | Required within parent | Must 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
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reviewers | array | Required within parent | |
reviewers[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value 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 |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | Ironclad approval group status; only active groups can be approved. Default: null |
status (anyOf 2) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Model for an Ironclad reviewer based on IroncladWorkflowReviewerSchema. |
display_name | string | Required within parent | |
reviewer_type | string | Required within parent | |
role | string | Required within parent | |
status | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assignees | array | Required within parent | |
assignees[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value 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_name | string | Required within parent | |
id | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | |
user_id | string | Required within parent | |
user_name | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type 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 Sign signers routing, signers, title, workflow id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
routing | string | Required within parent | |
signers | array | Required within parent | |
signers[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value 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 |
title | string | Required within parent | |
workflow_id | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type 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 signature status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
status | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_text | string | Required within parent | |
status | string | Required within parent | Known values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, PENDING, REJECTED |
step | string | Required within parent | Must 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
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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | string | Required within parent | |
error_type | string | Required within parent | Must equal: API_ERROR |
provider_type | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | JSON | Required within parent | |
error_message (anyOf 1) | string | Alternative | Default: null |
error_message (anyOf 2) | null | Alternative | |
error_type | string | Required within parent | Must equal: ARAVO_MULTIPLE_REPORT_ERROR |
provider_type | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | string | Required within parent | |
error_type | string | Required within parent | Must equal: AUTHENTICATION_ERROR |
provider_type | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | JSON | Required within parent | |
error_message (anyOf 1) | string | Alternative | Default: null |
error_message (anyOf 2) | null | Alternative | |
error_type | string | Required within parent | Must equal: PROVIDER_NOT_CONFIGURED |
provider_type | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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_text | string | Required within parent | |
status | string | Required within parent | Known 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
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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
collection_id | JSON | Required within parent | |
collection_id (anyOf 1) | string | Alternative | Default: null |
collection_id (anyOf 2) | null | Alternative | |
error_message | string | Required within parent | |
error_type | string | Required within parent | Must equal: API_ERROR |
provider_type | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type COLLECTION NOT FOUND
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
collection_id | string | Required within parent | |
error_type | string | Required within parent | Must equal: COLLECTION_NOT_FOUND |
provider_type | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type PROVIDER NOT CONFIGURED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
collection_id | string | Required within parent | |
error_type | string | Required within parent | Must equal: PROVIDER_NOT_CONFIGURED |
provider_type | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH TICKETING WORKFLOW error trigger type: LAUNCH TICKETING WORKFLOW error error type VALIDATION ERROR
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | string | Required within parent | |
error_type | string | Required within parent | Must equal: VALIDATION_ERROR |
field_errors | JSON | Required within parent | |
field_errors (anyOf 1) | object | Alternative | Default: null Additional keys: see wildcard field |
field_errors (anyOf 1).* | string | Additional keys | |
field_errors (anyOf 2) | null | Alternative | |
provider_type | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH TICKETING WORKFLOW ticket data provider type: asana, jira, linear, zendesk
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_trigger_instance_uuid | JSON | Required within parent | |
approval_trigger_instance_uuid (anyOf 1) | string | Alternative | |
approval_trigger_instance_uuid (anyOf 2) | null | Alternative | |
assignees | JSON | Optional | |
assignees (anyOf 1) | array | Alternative | Default: null |
assignees (anyOf 1)[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH TICKETING WORKFLOW ticket data provider type: asana, jira, linear, zendesk assignees array item |
assignees (anyOf 2) | null | Alternative | |
business_id | JSON | Required within parent | |
business_id (anyOf 1) | integer | Alternative | |
business_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
collection_name | JSON | Required within parent | |
collection_name (anyOf 1) | string | Alternative | |
collection_name (anyOf 2) | null | Alternative | |
custom_status | JSON | Optional | |
custom_status (anyOf 1) | string | Alternative | Default: null |
custom_status (anyOf 2) | null | Alternative | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
provider_type | string | Required within parent | Known values: asana, jira, linear, zendesk |
remote_data | JSON | Required within parent | |
remote_data (anyOf 1) | object | Alternative | |
remote_data (anyOf 2) | null | Alternative | |
remote_id | JSON | Required within parent | |
remote_id (anyOf 1) | string | Alternative | |
remote_id (anyOf 2) | null | Alternative | |
remote_was_deleted | boolean | Required within parent | |
status | JSON | Required within parent | |
status (anyOf 1) | string | Alternative | Known values: CLOSED, IN_PROGRESS, ON_HOLD, OPEN |
status (anyOf 2) | null | Alternative | |
type | JSON | Required within parent | |
type (anyOf 1) | string | Alternative | |
type (anyOf 2) | null | Alternative | |
url | JSON | Required within parent | |
url (anyOf 1) | string | Alternative | |
url (anyOf 2) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH TICKETING WORKFLOW ticket data provider type: asana, jira, linear, zendesk assignees array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_name | JSON | Optional | |
display_name (anyOf 1) | string | Alternative | Default: null |
display_name (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Default: null |
email (anyOf 2) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH VENDOR ONBOARDING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payee_uuid | JSON | Required within parent | |
payee_uuid (anyOf 1) | string | Alternative | |
payee_uuid (anyOf 2) | null | Alternative | |
request_details | array | Required within parent | |
request_details[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH VENDOR ONBOARDING request details item |
trigger_type | string | Required within parent | Must equal: LAUNCH_VENDOR_ONBOARDING |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type LAUNCH VENDOR ONBOARDING request details item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
detail_type | string | Required within parent | ProcurementPayeeDetailsRequestField is a simplified enum on the PayeeDetailsRequest that consolidates (ach, check, wire) into single payment details. Known values: CUSTOM_FORM, PAYMENT, TAX |
display_text | string | Required within parent | |
submitted_at | JSON | Optional | |
submitted_at (anyOf 1) | string | Alternative | Default: null Format: date-time |
submitted_at (anyOf 2) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value trigger type SEND BACK
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assignee_group_uuid | JSON | Optional | |
assignee_group_uuid (anyOf 1) | string | Alternative | Workflow group the request was sent back to, if any. Default: null |
assignee_group_uuid (anyOf 2) | null | Alternative | |
assignee_relative_group_type | JSON | Optional | |
assignee_relative_group_type (anyOf 1) | string | Alternative | Relative role the request was sent back to, if any. Default: null |
assignee_relative_group_type (anyOf 2) | null | Alternative | |
assignee_user | JSON | Optional | |
assignee_user (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approvals paused by deleted at, email, first name, id, last name, lifecycle status, profile picture url, role User the request was sent back to, if any. Default: null |
assignee_user (anyOf 2) | null | Alternative | |
instructions | JSON | Optional | |
instructions (anyOf 1) | string | Alternative | Instructions shown to the assignee. Default: null |
instructions (anyOf 2) | null | Alternative | |
resolution | JSON | Optional | |
resolution (anyOf 1) | string | Alternative | How the node completed; null while the send-back is still active. Known values: RESOLVED, RETURNED, SKIPPED Default: null |
resolution (anyOf 2) | null | Alternative | |
resolved_at | JSON | Optional | |
resolved_at (anyOf 1) | string | Alternative | When the send-back was returned, resolved, or canceled. Default: null |
resolved_at (anyOf 2) | null | Alternative | |
resolved_by_user | JSON | Optional | |
resolved_by_user (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approvals paused by deleted at, email, first name, id, last name, lifecycle status, profile picture url, role User who returned or resolved the send-back. Default: null |
resolved_by_user (anyOf 2) | null | Alternative | |
response_body | JSON | Optional | |
response_body (anyOf 1) | string | Alternative | Message the assignee or admin left when completing the step. Default: null |
response_body (anyOf 2) | null | Alternative | |
send_back_status | JSON | Optional | |
send_back_status (anyOf 1) | string | Alternative | Lifecycle 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) | null | Alternative | |
send_back_uuid | JSON | Optional | |
send_back_uuid (anyOf 1) | string | Alternative | UUID of the send-back row the node opened. Default: null |
send_back_uuid (anyOf 2) | null | Alternative | |
trigger_type | string | Optional | The trigger type for a send-back node. Must equal: SEND_BACK |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sourcing event current rfx, id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
current_rfx | JSON | Required within parent | |
current_rfx (anyOf 1) | Model | Alternative | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sourcing event current rfx, id, name current rfx id, name Read only: true |
current_rfx (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
name | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sourcing event current rfx, id, name current rfx id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
name | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE spend intent config snapshot purchase order
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Snapshot 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_order | JSON | Optional | |
purchase_order (anyOf 1) | Model | Alternative | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE spend intent config snapshot purchase order purchase order line item custom field configs, required line item tracking category ids
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Snapshot of PO-specific config at SpendRequest creation time. |
line_item_custom_field_configs | array | Optional | Default: [] |
line_item_custom_field_configs[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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_ids | array | Optional | Required line-item tracking category IDs at request creation |
required_line_item_tracking_category_ids[] | JSON | Each item | |
required_line_item_tracking_category_ids[] (anyOf 1) | integer | Alternative | |
required_line_item_tracking_category_ids[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Snapshot of a PO line item custom field config at SpendRequest creation time. |
custom_field_id | string | Required within parent | |
is_enabled | boolean | Required within parent | |
is_required | boolean | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE spend request documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Format: date-time |
document_category | string | Required within parent | Known values: ADDENDUM_OR_RIDER, AMENDMENT, BANK_LETTER, CAIQ_LITE, CERTIFICATE_OF_INSURANCE, CONTRACT_OTHER, DATA_PROTECTION_AGREEMENT, ECOVADIS, ENGAGEMENT_LETTER, FAQ, FORM_1099, GDPR, HIPAA, INVOICE, ISO_27001, ISO_9001, MSA, NDA, NMSDC_CERTIFICATION, ORDER_FORM, OTHER, PAYMENT_INSTRUCTIONS, PCI_DSS, PEN_TEST_REPORT, PRIVACY_POLICY, PURCHASE_ORDER, QUESTIONNAIRE, QUOTE, SECURITY_DOCUMENT, SECURITY_EXHIBIT, SIG, SLA, SOC_1_TYPE_1, SOC_1_TYPE_2, SOC_2, SOW, TAX_DOCUMENT, TAX_DOCUMENT_INTL_COR, TAX_DOCUMENT_INTL_GOV_FORM, TAX_DOCUMENT_INTL_OTHER, TAX_DOCUMENT_INTL_STATUTORY_FORM, TOS, VENDOR_CONTRACT, VENDOR_CREDIT, VOIDED_CHECK, W8, W9 |
document_source | string | Required within parent | Known values: DEVELOPER_API, DOCUSIGN, IRONCLAD, RAMP |
document_type | string | Required within parent | Known values: PURCHASE_ORDER, SPEND_REQUEST |
download_pdf_url | JSON | Required within parent | |
download_pdf_url (anyOf 1) | string | Alternative | Read only: true |
download_pdf_url (anyOf 2) | null | Alternative | |
external_document_url | JSON | Required within parent | |
external_document_url (anyOf 1) | string | Alternative | Read only: true |
external_document_url (anyOf 2) | null | Alternative | |
filetype | JSON | Required within parent | |
filetype (anyOf 1) | string | Alternative | Known 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) | null | Alternative | |
id | string | Required within parent | Format: uuid |
is_ocr_document | boolean | Required within parent | |
mime_type | JSON | Required within parent | |
mime_type (anyOf 1) | string | Alternative | Known values: application/json, application/msword, application/pdf, application/vnd.apache.parquet, application/vnd.ms-excel, application/vnd.ms-excel.sheet.macroEnabled.12, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.wordprocessingml.document, audio/mpeg, image/gif, image/heic, image/jpeg, image/png, image/webp, text/calendar, text/csv, text/markdown, text/x-python Read only: true |
mime_type (anyOf 2) | null | Alternative | |
original_filename | JSON | Required within parent | |
original_filename (anyOf 1) | string | Alternative | |
original_filename (anyOf 2) | null | Alternative | |
payee_agreement_ids | array | Required within parent | Read only: true |
payee_agreement_ids[] | string | Each item | |
procurement_document_result_response | JSON | Required within parent | |
procurement_document_result_response (anyOf 1) | Model | Alternative | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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) | null | Alternative | |
ramp_document | JSON | Required within parent | |
ramp_document (anyOf 1) | Model | Alternative | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE custom form files item ramp document version type: PROCUREMENT Read only: true |
ramp_document (anyOf 2) | null | Alternative | |
spend_request_document_url | string | Required within parent | Read only: true |
spend_request_download_document_url | string | Required within parent | Read only: true |
spend_request_uuid | JSON | Required within parent | |
spend_request_uuid (anyOf 1) | string | Alternative | Read only: true |
spend_request_uuid (anyOf 2) | null | Alternative | |
spend_request_view_document_url | string | Required within parent | Read only: true |
type | JSON | Required within parent | Default: 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL |
entity_uuid | JSON | Required within parent | |
entity_uuid (anyOf 1) | string | Alternative | Default: null |
entity_uuid (anyOf 2) | null | Alternative | |
line_items | array | Required within parent | |
line_items[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY line items item |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Default: null |
name (anyOf 2) | null | Alternative | |
ocr_detected_currency | JSON | Required within parent | |
ocr_detected_currency (anyOf 1) | string | Alternative | Raw currency value detected by OCR when Core fell back to a supported currency. Null when no currency fallback occurred. |
ocr_detected_currency (anyOf 2) | null | Alternative | |
payee | JSON | Required within parent | |
payee (anyOf 1) | Model | Alternative | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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) | null | Alternative | |
purchase_order_autocoding_suggestions | JSON | Optional | |
purchase_order_autocoding_suggestions (anyOf 1) | Model | Alternative | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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) | null | Alternative | |
spend_end_date | JSON | Required within parent | |
spend_end_date (anyOf 1) | string | Alternative | Default: null |
spend_end_date (anyOf 2) | null | Alternative | |
spend_frequency | string | Required within parent | Known values: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY |
spend_start_date | JSON | Required within parent | |
spend_start_date (anyOf 1) | string | Alternative | Default: null |
spend_start_date (anyOf 2) | null | Alternative |
Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_field_values | array | Optional | Enabled line-item custom field values extracted from the document. |
custom_field_values[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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 |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Default: null |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | Default: null Format: date |
end_date (anyOf 2) | null | Alternative | |
line_item_type | string | Required within parent | Known values: EXPENSE, ITEM |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | Default: null |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | Default: null Format: date |
start_date (anyOf 2) | null | Alternative | |
unit_price | JSON | Required within parent | |
unit_price (anyOf 1) | JSON | Alternative | |
unit_price (anyOf 1) (anyOf 1) | number | Alternative | Default: null |
unit_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unit_price (anyOf 2) | null | Alternative | |
unit_quantity | JSON | Required within parent | |
unit_quantity (anyOf 1) | JSON | Alternative | |
unit_quantity (anyOf 1) (anyOf 1) | integer | Alternative | Use `quantity` instead. |
unit_quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unit_quantity (anyOf 2) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
custom_field_id | string | Required within parent | ID of the PO line-item custom field (the config's custom_field_id) this value is for. |
value | JSON | Required within parent | |
value (anyOf 1) | JSON | Alternative | Value 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) | boolean | Alternative | |
value (anyOf 1) (anyOf 2) | JSON | Alternative | |
value (anyOf 1) (anyOf 2) (anyOf 1) | number | Alternative | |
value (anyOf 1) (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
value (anyOf 1) (anyOf 3) | string | Alternative | |
value (anyOf 2) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE spend request documents item procurement document result response spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY payee logo, name, uuid
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
logo | JSON | Required within parent | |
logo (anyOf 1) | string | Alternative | Default: null |
logo (anyOf 2) | null | Alternative | |
name | string | Required within parent | |
uuid | string | Required within parent |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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 purchase order autocoding suggestions autocoding run id, line item tracking category suggestions, tracking category suggestions tracking category suggestions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
meta_data | Model | Required within parent | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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_id | JSON | Required within parent | |
tracking_category_id (anyOf 1) | integer | Alternative | Tracking category to populate. |
tracking_category_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tracking_category_option_id | JSON | Required within parent | |
tracking_category_option_id (anyOf 1) | JSON | Alternative | |
tracking_category_option_id (anyOf 1) (anyOf 1) | integer | Alternative | Suggested option, or null when no option was resolved. |
tracking_category_option_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tracking_category_option_id (anyOf 2) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reason | JSON | Optional | |
reason (anyOf 1) | string | Alternative | Reason for the suggestion. |
reason (anyOf 2) | null | Alternative | |
workflow_condition_id | JSON | Optional | |
workflow_condition_id (anyOf 1) | string | Alternative | Workflow condition that produced the suggestion, if any. |
workflow_condition_id (anyOf 2) | null | Alternative | |
workflow_rule_uuid | JSON | Optional | |
workflow_rule_uuid (anyOf 1) | string | Alternative | Workflow rule that produced the suggestion, if any. |
workflow_rule_uuid (anyOf 2) | null | Alternative |
Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE workflow execution status last updated, status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
last_updated | string | Required within parent | |
status | string | Required within parent | Known 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
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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_tracking_category_selections | array | Required within parent | Read only: true |
accounting_tracking_category_selections[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order accounting tracking category selections item |
can_view_full_purchase_order | boolean | Required within parent | Whether the acting user can open the full purchase order. Read only: true |
id | string | Required within parent | Format: uuid |
is_directly_issued | boolean | Required within parent | True when the PO was issued directly, without a program or request approval. |
is_linked_to_bills_or_provisional_bills | boolean | Required within parent | Whether linked bills or unattached provisional bills prevent changing the purchase order's entity. Read only: true |
punchout_order_id | JSON | Required within parent | |
punchout_order_id (anyOf 1) | string | Alternative | Format: uuid Read only: true |
punchout_order_id (anyOf 2) | null | Alternative | |
purchase_order_fund_uuid | JSON | Required within parent | |
purchase_order_fund_uuid (anyOf 1) | string | Alternative | Read only: true |
purchase_order_fund_uuid (anyOf 2) | null | Alternative | |
purchase_order_line_item_log_entries | array | Required within parent | Read only: true |
purchase_order_line_item_log_entries[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order purchase order line item log entries item |
purchase_order_number | JSON | Required within parent | |
purchase_order_number (anyOf 1) | string | Alternative | Read only: true |
purchase_order_number (anyOf 2) | null | Alternative | |
should_create_fund_on_approval | boolean | Required within parent | |
tax_lines | array | Required within parent | Tax amounts aggregated by tax rate for the purchase order. Read only: true |
tax_lines[] | Model | Each item | Expand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER agreement contract type: ONE TIME, PERPETUAL, RENEWABLE purchase order, purchase order detail, total amount details in business default currency purchase order tax lines item |
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