Skip to content

Ramp: Fund schemas

16 Ramp schemas with complete fields and constraints.

← Fund operations · All schemas

Add members to a fund — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
user_idsarrayRequired within parentList of user ids to add or remove.
Maximum items: 100
Minimum items: 1
user_ids[]stringEach item

Create a fund — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_rulesarrayOptionalAccounting rules for the fund.
accounting_rules[]ModelEach itemExpand Create a fund — request body — body accounting rules item
display_namestringOptionalDisplay name of the fund.
is_exempt_from_policy_agentbooleanOptionalWhether this fund is exempt from policy agent review.
Default: false
is_shareablebooleanOptionalWhether the fund is shareable among multiple users.
Default: false
permitted_spend_typesModelOptionalExpand Create a fund — request body — body permitted spend types
Permitted spend types for the fund.
spend_program_idstringOptionalThe ID of the associated spend program.
Format: uuid
spending_restrictionsModelOptionalExpand 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_idstringRequired within parentUnique 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

FieldTypePresenceDescription and constraints
$objectRoot
field_idstringRequired within parentUUID of the accounting field.
Format: uuid
field_option_idstringRequired within parentUUID of the accounting field option.
Format: uuid

Create a fund — request body — body permitted spend types

FieldTypePresenceDescription and constraints
$objectRoot
physical_cardbooleanRequired within parentWhether the user's physical card can be linked to this fund.
reimbursementsbooleanRequired within parentWhether reimbursements can be submitted against this fund.
virtual_cardbooleanRequired within parentWhether virtual cards can be linked to this fund.

Create a fund — request body — body spending restrictions

FieldTypePresenceDescription and constraints
$objectRoot
allowed_category_codesarrayOptionalList of allowed Ramp category codes.
allowed_category_codes[]integerEach itemOne 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_idsarrayOptionalList of allowed vendor IDs.
allowed_vendor_ids[]stringEach itemFormat: uuid
blocked_category_codesarrayOptionalList of blocked Ramp category codes.
blocked_category_codes[]integerEach itemOne 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_codesarrayOptional
blocked_mcc_codes[]stringEach item
blocked_vendor_idsarrayOptionalList of blocked vendor IDs.
blocked_vendor_ids[]stringEach itemFormat: uuid
convert_to_entity_currencybooleanOptionalConvert limits to the currency of the fund's entity at Ramp's daily rate. Not supported for fixed-amount spend programs.
Default: false
intervalstringRequired within parentTime interval to apply limit to.
One of: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
limitModelRequired within parentExpand 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_dateJSONOptional
lock_date (anyOf 1)stringAlternativeDate 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)nullAlternative
transaction_amount_limitModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
amountintegerRequired within parentthe 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_codestringOptionalThe type of currency, in ISO 4217 format. e.g. USD for US dollars
Default: USD

Fetch a fund — response body

FieldTypePresenceDescription and constraints
$objectRoot
balanceJSONRequired within parent
balance (anyOf 1)ModelAlternativeExpand Fetch a fund — response body — balance cleared, pending, total
Current balance of the fund.
Read only: true
balance (anyOf 2)nullAlternative
cardsarrayRequired within parentCards linked to this fund.
cards[]ModelEach itemExpand Fetch a fund — response body — cards item
created_atstringRequired within parentTime at which the fund was created, in ISO 8601 format.
Format: date-time
display_namestringRequired within parentDisplay name of the fund.
entity_idJSONRequired within parent
entity_id (anyOf 1)stringAlternativeAssociated business entity of the fund.
Format: uuid
entity_id (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the fund.
Format: uuid
is_exempt_from_policy_agentbooleanRequired within parentWhether this fund is exempt from policy agent review.
is_shareablebooleanRequired within parentWhether this fund is shareable among multiple users.
membersarrayRequired within parentMembers who can spend from the fund.
members[]ModelEach itemExpand Fetch a fund — response body — members item
overrides_spend_programbooleanRequired within parentWhether the fund's settings override those of its spend program.
permitted_spend_typesModelRequired within parentExpand Fetch a fund — response body — permitted spend types
Permitted spend types for this fund.
spend_program_idJSONRequired within parent
spend_program_id (anyOf 1)stringAlternativeUnique identifier of the associated spend program.
Format: uuid
spend_program_id (anyOf 2)nullAlternative
spending_restrictionsJSONRequired within parent
spending_restrictions (anyOf 1)ModelAlternativeExpand 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)nullAlternative
statestringRequired within parentCurrent state of the fund: ACTIVE, SUSPENDED, or TERMINATED.
Known values: ACTIVE, ARCHIVED, SUSPENDED, TERMINATED
Read only: true
suspensionJSONRequired within parent
suspension (anyOf 1)ModelAlternativeExpand 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)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
clearedModelRequired within parentExpand Hold Bill — response body — amount
Cleared amount on this fund.
Read only: true
pendingModelRequired within parentExpand Hold Bill — response body — amount
Pending amount towards this fund.
Read only: true
totalModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
card_idstringRequired within parentUnique identifier of the card.
Format: uuid
created_atstringRequired within parentTime the card was created.
Format: date-time
display_namestringRequired within parentDisplay name of the card.
expirationstringRequired within parentExpiration date in MMYY format. Redacted if the card has not been activated.
Read only: true
last_fourstringRequired within parentLast four digits of the card number. Redacted if the card has not been activated.
Read only: true
user_idstringRequired within parentUnique identifier of the cardholder.
Format: uuid

Fetch a fund — response body — members item

FieldTypePresenceDescription and constraints
$objectRoot
suspensionJSONRequired within parent
suspension (anyOf 1)ModelAlternativeExpand 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)nullAlternative
user_idstringRequired within parentUnique 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

FieldTypePresenceDescription and constraints
$objectRoot
physical_card_enabledbooleanRequired within parentWhether the user's physical card can be linked to this fund.
reimbursements_enabledbooleanRequired within parentWhether reimbursements can be submitted against this fund.
virtual_card_enabledbooleanRequired within parentWhether virtual cards can be linked to this fund.

Fetch a fund — response body — spending_restrictions / interval: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

FieldTypePresenceDescription and constraints
$objectRoot
allowed_category_codesJSONRequired within parent
allowed_category_codes (anyOf 1)arrayAlternativeList of allowed Ramp category codes, or null if unrestricted.
allowed_category_codes (anyOf 1)[]JSONEach item
allowed_category_codes (anyOf 1)[] (anyOf 1)integerAlternativeKnown 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
allowed_category_codes (anyOf 2)nullAlternative
allowed_vendor_idsJSONRequired within parent
allowed_vendor_ids (anyOf 1)arrayAlternativeList of allowed vendor IDs, or null if unrestricted.
allowed_vendor_ids (anyOf 1)[]stringEach itemFormat: uuid
allowed_vendor_ids (anyOf 2)nullAlternative
auto_lock_dateJSONRequired within parent
auto_lock_date (anyOf 1)stringAlternativeDate to automatically lock the fund.
Format: date-time
auto_lock_date (anyOf 2)nullAlternative
blocked_category_codesJSONRequired within parent
blocked_category_codes (anyOf 1)arrayAlternativeList of blocked Ramp category codes, or null if unrestricted.
blocked_category_codes (anyOf 1)[]JSONEach item
blocked_category_codes (anyOf 1)[] (anyOf 1)integerAlternativeKnown 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
blocked_category_codes (anyOf 2)nullAlternative
blocked_vendor_idsJSONRequired within parent
blocked_vendor_ids (anyOf 1)arrayAlternativeList of blocked vendor IDs, or null if unrestricted.
blocked_vendor_ids (anyOf 1)[]stringEach itemFormat: uuid
blocked_vendor_ids (anyOf 2)nullAlternative
intervalstringOptionalTime interval the limit is applied on.
Known values: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
limitJSONRequired within parent
limit (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Amount limit total per interval denominated in the smallest currency unit.
Read only: true
limit (anyOf 2)nullAlternative
next_interval_resets_atJSONRequired within parent
next_interval_resets_at (anyOf 1)stringAlternativeDate and time for the next interval reset.
Format: date-time
next_interval_resets_at (anyOf 2)nullAlternative
start_of_intervalJSONRequired within parent
start_of_interval (anyOf 1)stringAlternativeDate and time for the start of the current interval.
Format: date-time
start_of_interval (anyOf 2)nullAlternative
temporary_limitJSONRequired within parent
temporary_limit (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Temporary limit total per interval.
Read only: true
temporary_limit (anyOf 2)nullAlternative
transaction_amount_limitJSONRequired within parent
transaction_amount_limit (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Max amount allowed on a single transaction.
Read only: true
transaction_amount_limit (anyOf 2)nullAlternative

Referenced models: Hold Bill — response body — amount

Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id

FieldTypePresenceDescription and constraints
$objectRoot
suspended_atJSONRequired within parent
suspended_at (anyOf 1)stringAlternativeDate and time at which the suspension was placed.
Format: date-time
suspended_at (anyOf 2)nullAlternative
suspended_by_rampbooleanRequired within parentWhether the suspension was placed by Ramp.
Read only: true
suspended_by_user_idJSONRequired within parent
suspended_by_user_id (anyOf 1)stringAlternativeUnique identifier of the user who placed the suspension.
Format: uuid
Read only: true
suspended_by_user_id (anyOf 2)nullAlternative

List funds — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Fetch a fund — response body
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_rulesarrayOptionalAccounting rules (full replace).
accounting_rules[]ModelEach itemExpand Create a fund — request body — body accounting rules item
display_namestringOptionalDisplay name for the fund.
is_exempt_from_policy_agentbooleanOptionalWhether the fund is exempt from policy agent review.
is_shareablebooleanOptionalWhether the fund supports multiple members.
permitted_spend_typesModelOptionalExpand Create a fund — request body — body permitted spend types
Permitted spend types (full replace).
spend_program_idJSONOptional
spend_program_id (anyOf 1)stringAlternativeSpend program to link (null to detach).
Format: uuid
spend_program_id (anyOf 2)nullAlternative
spending_restrictionsModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
allowed_category_codesarrayOptionalList of allowed Ramp category codes.
allowed_category_codes[]integerEach itemOne 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_idsarrayOptionalList of allowed vendor IDs.
allowed_vendor_ids[]stringEach itemFormat: uuid
blocked_category_codesarrayOptionalList of blocked Ramp category codes.
blocked_category_codes[]integerEach itemOne 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_codesarrayOptional
blocked_mcc_codes[]stringEach item
blocked_vendor_idsarrayOptionalList of blocked vendor IDs.
blocked_vendor_ids[]stringEach itemFormat: uuid
convert_to_entity_currencybooleanOptionalConvert limits to the currency of the fund's entity at Ramp's daily rate. Not supported for fixed-amount spend programs.
Default: false
intervalstringOptionalTime interval to apply limit to.
One of: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
is_temporary_increasebooleanOptionalWhether this limit change is temporary.
Default: false
limitModelOptionalExpand 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_dateJSONOptional
lock_date (anyOf 1)stringAlternativeDate 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)nullAlternative
transaction_amount_limitModelOptionalExpand 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

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.