Skip to content

Ramp: Approvals schemas

7 Ramp schemas with complete fields and constraints.

← Approvals operations · All schemas

Add an approver to an approval instance — request body — body

FieldTypePresenceDescription and constraints
$objectRootAn approval step to add to an existing approval chain.
approver_groupsarrayRequired within parentApprover groups included in the step.
Minimum items: 1
approver_groups[]ModelEach itemExpand Add an approver to an approval instance — request body — body approver groups item
reasonstringRequired within parentReason for adding the approval step.
step_orderintegerOptionalPosition of the step in the approval chain.
Minimum: 1
step_typestringRequired within parentApproval behavior for the step.
One of: REQUIRE_ALL, REQUIRE_ANY

Referenced models: Add an approver to an approval instance — request body — body approver groups item

Add an approver to an approval instance — request body — body approver groups item

FieldTypePresenceDescription and constraints
$objectRootA group of users to add to an approval step.
typestringRequired within parentType of approver group.
One of: USER
usersarrayRequired within parentUsers included in the approver group.
Minimum items: 1
users[]ModelEach itemExpand Add an approver to an approval instance — request body — body approver groups item users item

Referenced models: Add an approver to an approval instance — request body — body approver groups item users item

Add an approver to an approval instance — request body — body approver groups item users item

FieldTypePresenceDescription and constraints
$objectRootA user to add as an approver.
emailstringOptionalEmail address of the approver.
Format: email
idstringOptionalUnique identifier of the approver.
Format: uuid

List approval data for a set of Transactions, Reimbursements, or Bills — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item

List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item

FieldTypePresenceDescription and constraints
$objectRootApproval details for a resource.
approval_historyarrayRequired within parentActions recorded for the approval chain.
Read only: true
approval_history[]ModelEach itemExpand List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item approval history item
entity_idstringRequired within parentUnique identifier of the resource.
Format: uuid
Read only: true
entity_typestringRequired within parentType of resource under approval.
Known values: bill, reimbursement, transaction
Read only: true
next_approversarrayRequired within parentUsers responsible for the next approval action.
Read only: true
next_approvers[]ModelEach itemExpand List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item next approvers item
statusstringRequired within parentCurrent status of the approval chain.
Known values: APPROVED, INITIALIZED, PENDING, REJECTED, TERMINATED

Referenced models: List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item approval history item, List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item next approvers item

List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item approval history item

FieldTypePresenceDescription and constraints
$objectRootAn action recorded in an approval's history.
action_atstringRequired within parentDate and time when the action occurred.
Format: date-time
step_statusstringRequired within parentResulting status of the approval step.
user_emailJSONRequired within parent
user_email (anyOf 1)stringAlternativeEmail address of the acting user.
Format: email
user_email (anyOf 2)nullAlternative
user_idJSONRequired within parent
user_id (anyOf 1)stringAlternativeUnique identifier of the acting user.
Format: uuid
user_id (anyOf 2)nullAlternative

List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item next approvers item

FieldTypePresenceDescription and constraints
$objectRootA user responsible for the next approval action.
user_emailstringRequired within parentEmail address of the next approver.
Format: email
user_idstringRequired within parentUnique identifier of the next approver.
Format: uuid

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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