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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An approval step to add to an existing approval chain. |
approver_groups | array | Required within parent | Approver groups included in the step. Minimum items: 1 |
approver_groups[] | Model | Each item | Expand Add an approver to an approval instance — request body — body approver groups item |
reason | string | Required within parent | Reason for adding the approval step. |
step_order | integer | Optional | Position of the step in the approval chain. Minimum: 1 |
step_type | string | Required within parent | Approval 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A group of users to add to an approval step. |
type | string | Required within parent | Type of approver group. One of: USER |
users | array | Required within parent | Users included in the approver group. Minimum items: 1 |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A user to add as an approver. |
email | string | Optional | Email address of the approver. Format: email |
id | string | Optional | Unique identifier of the approver. Format: uuid |
List approval data for a set of Transactions, Reimbursements, or Bills — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Approval details for a resource. |
approval_history | array | Required within parent | Actions recorded for the approval chain. Read only: true |
approval_history[] | Model | Each item | Expand List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item approval history item |
entity_id | string | Required within parent | Unique identifier of the resource. Format: uuid Read only: true |
entity_type | string | Required within parent | Type of resource under approval. Known values: bill, reimbursement, transaction Read only: true |
next_approvers | array | Required within parent | Users responsible for the next approval action. Read only: true |
next_approvers[] | Model | Each item | Expand List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item next approvers item |
status | string | Required within parent | Current 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An action recorded in an approval's history. |
action_at | string | Required within parent | Date and time when the action occurred. Format: date-time |
step_status | string | Required within parent | Resulting status of the approval step. |
user_email | JSON | Required within parent | |
user_email (anyOf 1) | string | Alternative | Email address of the acting user. Format: email |
user_email (anyOf 2) | null | Alternative | |
user_id | JSON | Required within parent | |
user_id (anyOf 1) | string | Alternative | Unique identifier of the acting user. Format: uuid |
user_id (anyOf 2) | null | Alternative |
List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item next approvers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A user responsible for the next approval action. |
user_email | string | Required within parent | Email address of the next approver. Format: email |
user_id | string | Required within parent | Unique identifier of the next approver. Format: uuid |