Ramp: Fund schemas
16 Ramp schemas with complete fields and constraints.
← Fund operations · All schemas
Add members to a fund — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
user_ids | array | Required within parent | List of user ids to add or remove. Maximum items: 100 Minimum items: 1 |
user_ids[] | string | Each item |
Create a fund — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_rules | array | Optional | Accounting rules for the fund. |
accounting_rules[] | Model | Each item | Expand Create a fund — request body — body accounting rules item |
display_name | string | Optional | Display name of the fund. |
is_exempt_from_policy_agent | boolean | Optional | Whether this fund is exempt from policy agent review. Default: false |
is_shareable | boolean | Optional | Whether the fund is shareable among multiple users. Default: false |
permitted_spend_types | Model | Optional | Expand Create a fund — request body — body permitted spend types Permitted spend types for the fund. |
spend_program_id | string | Optional | The ID of the associated spend program. Format: uuid |
spending_restrictions | Model | Optional | Expand Create a fund — request body — body spending restrictions Spending restrictions for the fund. If spend_program_id is provided and this field is omitted, the fund inherits the program's spending restrictions. |
user_id | string | Required within parent | Unique identifier of the fund owner. Format: uuid |
Referenced models: Create a fund — request body — body accounting rules item, Create a fund — request body — body permitted spend types, Create a fund — request body — body spending restrictions
Create a fund — request body — body accounting rules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_id | string | Required within parent | UUID of the accounting field. Format: uuid |
field_option_id | string | Required within parent | UUID of the accounting field option. Format: uuid |
Create a fund — request body — body permitted spend types
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
physical_card | boolean | Required within parent | Whether the user's physical card can be linked to this fund. |
reimbursements | boolean | Required within parent | Whether reimbursements can be submitted against this fund. |
virtual_card | boolean | Required within parent | Whether virtual cards can be linked to this fund. |
Create a fund — request body — body spending restrictions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_category_codes | array | Optional | List of allowed Ramp category codes. |
allowed_category_codes[] | integer | Each item | One of: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9 |
allowed_vendor_ids | array | Optional | List of allowed vendor IDs. |
allowed_vendor_ids[] | string | Each item | Format: uuid |
blocked_category_codes | array | Optional | List of blocked Ramp category codes. |
blocked_category_codes[] | integer | Each item | One of: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9 |
blocked_mcc_codes | array | Optional | |
blocked_mcc_codes[] | string | Each item | |
blocked_vendor_ids | array | Optional | List of blocked vendor IDs. |
blocked_vendor_ids[] | string | Each item | Format: uuid |
convert_to_entity_currency | boolean | Optional | Convert limits to the currency of the fund's entity at Ramp's daily rate. Not supported for fixed-amount spend programs. Default: false |
interval | string | Required within parent | Time interval to apply limit to. One of: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY |
limit | Model | Required within parent | Expand Create a fund — request body — body spending restrictions limit Total amount limit per interval denominated in the smallest currency unit (e.g. cents for USD). |
lock_date | JSON | Optional | |
lock_date (anyOf 1) | string | Alternative | Date to automatically suspend the fund. If lock date has passed, set to a future date or to null to unsuspend. Format: date-time |
lock_date (anyOf 2) | null | Alternative | |
transaction_amount_limit | Model | Optional | Expand Create a fund — request body — body spending restrictions limit Max amount per transaction denominated in the smallest currency unit (e.g. cents for USD). |
Referenced models: Create a fund — request body — body spending restrictions limit
Create a fund — request body — body spending restrictions limit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | integer | Required within parent | the amount of money represented in the smallest denomination of the currency. For example, when the currency is USD, then the amount is expressed in cents. |
currency_code | string | Optional | The type of currency, in ISO 4217 format. e.g. USD for US dollars Default: USD |
Fetch a fund — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
balance | JSON | Required within parent | |
balance (anyOf 1) | Model | Alternative | Expand Fetch a fund — response body — balance cleared, pending, total Current balance of the fund. Read only: true |
balance (anyOf 2) | null | Alternative | |
cards | array | Required within parent | Cards linked to this fund. |
cards[] | Model | Each item | Expand Fetch a fund — response body — cards item |
created_at | string | Required within parent | Time at which the fund was created, in ISO 8601 format. Format: date-time |
display_name | string | Required within parent | Display name of the fund. |
entity_id | JSON | Required within parent | |
entity_id (anyOf 1) | string | Alternative | Associated business entity of the fund. Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of the fund. Format: uuid |
is_exempt_from_policy_agent | boolean | Required within parent | Whether this fund is exempt from policy agent review. |
is_shareable | boolean | Required within parent | Whether this fund is shareable among multiple users. |
members | array | Required within parent | Members who can spend from the fund. |
members[] | Model | Each item | Expand Fetch a fund — response body — members item |
overrides_spend_program | boolean | Required within parent | Whether the fund's settings override those of its spend program. |
permitted_spend_types | Model | Required within parent | Expand Fetch a fund — response body — permitted spend types Permitted spend types for this fund. |
spend_program_id | JSON | Required within parent | |
spend_program_id (anyOf 1) | string | Alternative | Unique identifier of the associated spend program. Format: uuid |
spend_program_id (anyOf 2) | null | Alternative | |
spending_restrictions | JSON | Required within parent | |
spending_restrictions (anyOf 1) | Model | Alternative | Expand Fetch a fund — response body — spending_restrictions / interval: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY Spending restrictions on this fund. Read only: true |
spending_restrictions (anyOf 2) | null | Alternative | |
state | string | Required within parent | Current state of the fund: ACTIVE, SUSPENDED, or TERMINATED. Known values: ACTIVE, ARCHIVED, SUSPENDED, TERMINATED Read only: true |
suspension | JSON | Required within parent | |
suspension (anyOf 1) | Model | Alternative | Expand Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id Suspension details at the fund level, or null if the fund is not suspended. Read only: true |
suspension (anyOf 2) | null | Alternative |
Referenced models: Fetch a fund — response body — cards item, Fetch a fund — response body — members item, Fetch a fund — response body — permitted spend types, Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id, Fetch a fund — response body — balance cleared, pending, total, Fetch a fund — response body — spending_restrictions / interval: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
Fetch a fund — response body — balance cleared, pending, total
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cleared | Model | Required within parent | Expand Hold Bill — response body — amount Cleared amount on this fund. Read only: true |
pending | Model | Required within parent | Expand Hold Bill — response body — amount Pending amount towards this fund. Read only: true |
total | Model | Required within parent | Expand Hold Bill — response body — amount Total amount spent on this fund. Read only: true |
Referenced models: Hold Bill — response body — amount
Fetch a fund — response body — cards item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
card_id | string | Required within parent | Unique identifier of the card. Format: uuid |
created_at | string | Required within parent | Time the card was created. Format: date-time |
display_name | string | Required within parent | Display name of the card. |
expiration | string | Required within parent | Expiration date in MMYY format. Redacted if the card has not been activated. Read only: true |
last_four | string | Required within parent | Last four digits of the card number. Redacted if the card has not been activated. Read only: true |
user_id | string | Required within parent | Unique identifier of the cardholder. Format: uuid |
Fetch a fund — response body — members item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
suspension | JSON | Required within parent | |
suspension (anyOf 1) | Model | Alternative | Expand Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id Suspension details for this member, or null if not suspended. Read only: true |
suspension (anyOf 2) | null | Alternative | |
user_id | string | Required within parent | Unique identifier of the fund member. Format: uuid |
Referenced models: Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id
Fetch a fund — response body — permitted spend types
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
physical_card_enabled | boolean | Required within parent | Whether the user's physical card can be linked to this fund. |
reimbursements_enabled | boolean | Required within parent | Whether reimbursements can be submitted against this fund. |
virtual_card_enabled | boolean | Required within parent | Whether virtual cards can be linked to this fund. |
Fetch a fund — response body — spending_restrictions / interval: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_category_codes | JSON | Required within parent | |
allowed_category_codes (anyOf 1) | array | Alternative | List of allowed Ramp category codes, or null if unrestricted. |
allowed_category_codes (anyOf 1)[] | JSON | Each item | |
allowed_category_codes (anyOf 1)[] (anyOf 1) | integer | Alternative | Known values: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9 |
allowed_category_codes (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
allowed_category_codes (anyOf 2) | null | Alternative | |
allowed_vendor_ids | JSON | Required within parent | |
allowed_vendor_ids (anyOf 1) | array | Alternative | List of allowed vendor IDs, or null if unrestricted. |
allowed_vendor_ids (anyOf 1)[] | string | Each item | Format: uuid |
allowed_vendor_ids (anyOf 2) | null | Alternative | |
auto_lock_date | JSON | Required within parent | |
auto_lock_date (anyOf 1) | string | Alternative | Date to automatically lock the fund. Format: date-time |
auto_lock_date (anyOf 2) | null | Alternative | |
blocked_category_codes | JSON | Required within parent | |
blocked_category_codes (anyOf 1) | array | Alternative | List of blocked Ramp category codes, or null if unrestricted. |
blocked_category_codes (anyOf 1)[] | JSON | Each item | |
blocked_category_codes (anyOf 1)[] (anyOf 1) | integer | Alternative | Known values: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9 |
blocked_category_codes (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
blocked_category_codes (anyOf 2) | null | Alternative | |
blocked_vendor_ids | JSON | Required within parent | |
blocked_vendor_ids (anyOf 1) | array | Alternative | List of blocked vendor IDs, or null if unrestricted. |
blocked_vendor_ids (anyOf 1)[] | string | Each item | Format: uuid |
blocked_vendor_ids (anyOf 2) | null | Alternative | |
interval | string | Optional | Time interval the limit is applied on. Known values: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY |
limit | JSON | Required within parent | |
limit (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount Amount limit total per interval denominated in the smallest currency unit. Read only: true |
limit (anyOf 2) | null | Alternative | |
next_interval_resets_at | JSON | Required within parent | |
next_interval_resets_at (anyOf 1) | string | Alternative | Date and time for the next interval reset. Format: date-time |
next_interval_resets_at (anyOf 2) | null | Alternative | |
start_of_interval | JSON | Required within parent | |
start_of_interval (anyOf 1) | string | Alternative | Date and time for the start of the current interval. Format: date-time |
start_of_interval (anyOf 2) | null | Alternative | |
temporary_limit | JSON | Required within parent | |
temporary_limit (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount Temporary limit total per interval. Read only: true |
temporary_limit (anyOf 2) | null | Alternative | |
transaction_amount_limit | JSON | Required within parent | |
transaction_amount_limit (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount Max amount allowed on a single transaction. Read only: true |
transaction_amount_limit (anyOf 2) | null | Alternative |
Referenced models: Hold Bill — response body — amount
Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
suspended_at | JSON | Required within parent | |
suspended_at (anyOf 1) | string | Alternative | Date and time at which the suspension was placed. Format: date-time |
suspended_at (anyOf 2) | null | Alternative | |
suspended_by_ramp | boolean | Required within parent | Whether the suspension was placed by Ramp. Read only: true |
suspended_by_user_id | JSON | Required within parent | |
suspended_by_user_id (anyOf 1) | string | Alternative | Unique identifier of the user who placed the suspension. Format: uuid Read only: true |
suspended_by_user_id (anyOf 2) | null | Alternative |
List funds — 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 Fetch a fund — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Fetch a fund — response body
Update a fund — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_rules | array | Optional | Accounting rules (full replace). |
accounting_rules[] | Model | Each item | Expand Create a fund — request body — body accounting rules item |
display_name | string | Optional | Display name for the fund. |
is_exempt_from_policy_agent | boolean | Optional | Whether the fund is exempt from policy agent review. |
is_shareable | boolean | Optional | Whether the fund supports multiple members. |
permitted_spend_types | Model | Optional | Expand Create a fund — request body — body permitted spend types Permitted spend types (full replace). |
spend_program_id | JSON | Optional | |
spend_program_id (anyOf 1) | string | Alternative | Spend program to link (null to detach). Format: uuid |
spend_program_id (anyOf 2) | null | Alternative | |
spending_restrictions | Model | Optional | Expand Update a fund — request body — body spending restrictions Spending restriction overrides (partial merge). When the fund is linked to a spend program, provided sub-fields override the program's default values. |
Referenced models: Create a fund — request body — body accounting rules item, Create a fund — request body — body permitted spend types, Update a fund — request body — body spending restrictions
Update a fund — request body — body spending restrictions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_category_codes | array | Optional | List of allowed Ramp category codes. |
allowed_category_codes[] | integer | Each item | One of: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9 |
allowed_vendor_ids | array | Optional | List of allowed vendor IDs. |
allowed_vendor_ids[] | string | Each item | Format: uuid |
blocked_category_codes | array | Optional | List of blocked Ramp category codes. |
blocked_category_codes[] | integer | Each item | One of: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9 |
blocked_mcc_codes | array | Optional | |
blocked_mcc_codes[] | string | Each item | |
blocked_vendor_ids | array | Optional | List of blocked vendor IDs. |
blocked_vendor_ids[] | string | Each item | Format: uuid |
convert_to_entity_currency | boolean | Optional | Convert limits to the currency of the fund's entity at Ramp's daily rate. Not supported for fixed-amount spend programs. Default: false |
interval | string | Optional | Time interval to apply limit to. One of: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY |
is_temporary_increase | boolean | Optional | Whether this limit change is temporary. Default: false |
limit | Model | Optional | Expand Create a fund — request body — body spending restrictions limit Total amount limit per interval denominated in the smallest currency unit (e.g. cents for USD). |
lock_date | JSON | Optional | |
lock_date (anyOf 1) | string | Alternative | Date to automatically suspend the fund. If lock date has passed, set to a future date or to null to unsuspend. Format: date-time |
lock_date (anyOf 2) | null | Alternative | |
transaction_amount_limit | Model | Optional | Expand Create a fund — request body — body spending restrictions limit Max amount per transaction denominated in the smallest currency unit (e.g. cents for USD). |
Referenced models: Create a fund — request body — body spending restrictions limit