Skip to content

Ramp: Spend program schemas

43 Ramp schemas with complete fields and constraints.

← Spend program operations · All schemas

Create a spend program — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentDescription of the spend program.
display_namestringRequired within parentDisplay name of the spend program.
iconstringRequired within parentThe template icon for the spend program.
One of: AccountingServicesIcon, AdvertisingIcon, CONTRACTORS_AND_PROFESSIONAL_SERVICES, CUSTOM, CardIcon, EducationStipendIcon, EmployeeRewardsIcon, GroundTransportationIcon, LegalFeesIcon, LodgingIcon, LunchOrderingIcon, OnboardingIcon, PerDiemCardIcon, SOFTWARE, SaasSubscriptionIcon, SoftwareTrialIcon, SuppliesIcon, TeamSocialIcon, TravelExpensesIcon, VirtualEventIcon, WellnessIcon, WorkFromHomeIcon, advertising, airlines, bills, business, car_services, contractor, education, entertainment, event_balloons, event_virtual, food, fuel_and_gas, general_expense, general_merchandise, gift, government_services, internet_and_phone, legal, lodging, lodging_room, newspaper, office, physical_card, procurement_checklist, procurement_intake, professional_services, restaurants, reward, saas_software, shipping, travel_misc, wellness
is_shareablebooleanOptionalDictates whether the spend program is shareable among multiple users.
Default: false
issuance_rulesJSONOptional
issuance_rules (anyOf 1)ModelAlternativeExpand Create a spend program — request body — body issuance rules automatic, requestable
Spend Program Issuance Rules can be set for requests or default issuance of Limits from a program. Set whether a program is requestable or issued by default for a given set of users and their attributes (department, locations, and custom fields). If you'd like to give these permissions to all employees, you can set `applies_to_all` to `True`. Feel free to ignore this if you don't want any custom requestability or issuance logic.
Default: null
issuance_rules (anyOf 2)nullAlternative
issue_physical_card_if_neededbooleanOptionalDictates whether the spend program should issue a physical card if the user does not have one.
Default: false
permitted_spend_typesModelRequired within parentExpand Create a spend program — request body — body permitted spend types
Specifies the permitted spend types for the spend program.
spending_restrictionsModelRequired within parentExpand Create a spend program — request body — body spending restrictions
A set of restrictions imposed on the spend program.

Referenced models: Create a spend program — request body — body permitted spend types, Create a spend program — request body — body issuance rules automatic, requestable, Create a spend program — request body — body spending restrictions

Create a spend program — request body — body issuance rules automatic, requestable

FieldTypePresenceDescription and constraints
$objectRoot
automaticJSONOptional
automatic (anyOf 1)ModelAlternativeExpand Create a spend program — request body — body issuance rules automatic, requestable automatic applies to all, department ids, location ids, user custom field ids
Set of rules for having spend programs issued by default to users
automatic (anyOf 2)nullAlternative
requestableJSONOptional
requestable (anyOf 1)ModelAlternativeExpand Create a spend program — request body — body issuance rules automatic, requestable automatic applies to all, department ids, location ids, user custom field ids
Set of rules for users requesting spend programs.
requestable (anyOf 2)nullAlternative

Referenced models: Create a spend program — request body — body issuance rules automatic, requestable automatic applies to all, department ids, location ids, user custom field ids

Create a spend program — request body — body issuance rules automatic, requestable automatic applies to all, department ids, location ids, user custom field ids

FieldTypePresenceDescription and constraints
$objectRoot
applies_to_allbooleanOptionalDictates whether this rule should apply to all employees or not (if True, location_ids, department_ids, and user_custom_field_ids should be null).
Default: false
department_idsarrayOptionalList of departments whose users are able to request or be issued this spend program.
department_ids[]stringEach itemFormat: uuid
location_idsarrayOptionalList of locations whose users are able to request or be issued this spend program.
location_ids[]stringEach itemFormat: uuid
user_custom_field_idsarrayOptional
user_custom_field_ids[]stringEach itemFormat: uuid

Create a spend program — request body — body permitted spend types

FieldTypePresenceDescription and constraints
$objectRoot
primary_card_enabledbooleanRequired within parentDictates whether the user's physical card can be linked to this limit.
reimbursements_enabledbooleanRequired within parentDictates whether reimbursements can be submitted against this limit.

Create a spend program — request body — body spending restrictions

FieldTypePresenceDescription and constraints
$objectRoot
allowed_categoriesarrayOptionalList of Ramp category codes allowed for the limit.
allowed_categories[]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_vendorsarrayOptionalList of merchants allowed for the limit.
allowed_vendors[]stringEach itemFormat: uuid
blocked_categoriesarrayOptionalList of Ramp category codes blocked for the limit.
blocked_categories[]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_vendorsarrayOptionalList of merchants blocked for the limit.
blocked_vendors[]stringEach itemFormat: uuid
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_datestringOptionalDate to automatically lock the card. If lock date has passed, set to a future date or to null to unlock the card.
Format: date-time
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 spend program — response body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentDescription of the spend program.
display_namestringRequired within parentDisplay name of the spend program.
iconstringRequired within parentThe template icon for the spend program.
Known values: AccountingServicesIcon, AdvertisingIcon, CONTRACTORS_AND_PROFESSIONAL_SERVICES, CUSTOM, CardIcon, EducationStipendIcon, EmployeeRewardsIcon, GroundTransportationIcon, LegalFeesIcon, LodgingIcon, LunchOrderingIcon, OnboardingIcon, PerDiemCardIcon, SOFTWARE, SaasSubscriptionIcon, SoftwareTrialIcon, SuppliesIcon, TeamSocialIcon, TravelExpensesIcon, VirtualEventIcon, WellnessIcon, WorkFromHomeIcon, advertising, airlines, bills, business, car_services, contractor, education, entertainment, event_balloons, event_virtual, food, fuel_and_gas, general_expense, general_merchandise, gift, government_services, internet_and_phone, legal, lodging, lodging_room, newspaper, office, physical_card, procurement_checklist, procurement_intake, professional_services, restaurants, reward, saas_software, shipping, travel_misc, wellness
idstringRequired within parentUnique identifier of the spend program.
Format: uuid
is_shareablebooleanRequired within parentWhether this spend program is shareable.
issue_physical_card_if_neededbooleanRequired within parentIndicates whether the spend program should issue a physical card if the user does not have one.
permitted_spend_typesJSONRequired within parent
permitted_spend_types (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — permitted spend types primary card enabled, reimbursements enabled
Permitted spend types for the spend program.
permitted_spend_types (anyOf 2)nullAlternative
restrictionsJSONRequired within parent
restrictions (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — restrictions allowed categories, allowed vendors, auto lock date, blocked categories, blocked vendors, interval, limit, next interval reset, start of interval, temporary limit, transaction amount limit
A set of restrictions imposed on the spend program.
Read only: true
restrictions (anyOf 2)nullAlternative

Referenced models: Fetch a spend program — response body — permitted spend types primary card enabled, reimbursements enabled, Fetch a spend program — response body — restrictions allowed categories, allowed vendors, auto lock date, blocked categories, blocked vendors, interval, limit, next interval reset, start of interval, temporary limit, transaction amount limit

Fetch a spend program — response body

FieldTypePresenceDescription and constraints
$objectRoot
custom_form_collectionJSONRequired within parent
custom_form_collection (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry
Custom form collection for the resource, e.g. form questions required to create a request against a spend program.
Read only: true
custom_form_collection (anyOf 2)nullAlternative
descriptionstringRequired within parentDescription of the spend program.
display_namestringRequired within parentDisplay name of the spend program.
iconstringRequired within parentThe template icon for the spend program.
Known values: AccountingServicesIcon, AdvertisingIcon, CONTRACTORS_AND_PROFESSIONAL_SERVICES, CUSTOM, CardIcon, EducationStipendIcon, EmployeeRewardsIcon, GroundTransportationIcon, LegalFeesIcon, LodgingIcon, LunchOrderingIcon, OnboardingIcon, PerDiemCardIcon, SOFTWARE, SaasSubscriptionIcon, SoftwareTrialIcon, SuppliesIcon, TeamSocialIcon, TravelExpensesIcon, VirtualEventIcon, WellnessIcon, WorkFromHomeIcon, advertising, airlines, bills, business, car_services, contractor, education, entertainment, event_balloons, event_virtual, food, fuel_and_gas, general_expense, general_merchandise, gift, government_services, internet_and_phone, legal, lodging, lodging_room, newspaper, office, physical_card, procurement_checklist, procurement_intake, professional_services, restaurants, reward, saas_software, shipping, travel_misc, wellness
idstringRequired within parentUnique identifier of the spend program.
Format: uuid
is_shareablebooleanRequired within parentWhether this spend program is shareable.
issue_physical_card_if_neededbooleanRequired within parentIndicates whether the spend program should issue a physical card if the user does not have one.
line_item_accounting_fieldsarrayRequired within parentCustom accounting fields enabled for line items in this spend program.
Read only: true
line_item_accounting_fields[]ModelEach itemExpand Fetch a spend program — response body — line item accounting fields item
line_item_custom_fieldsarrayRequired within parentCustom fields enabled for line items in this spend program.
Read only: true
line_item_custom_fields[]ModelEach itemExpand Fetch a spend program — response body — line item custom fields item
permitted_spend_typesJSONRequired within parent
permitted_spend_types (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — permitted spend types primary card enabled, reimbursements enabled
Permitted spend types for the spend program.
permitted_spend_types (anyOf 2)nullAlternative
restrictionsJSONRequired within parent
restrictions (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — restrictions allowed categories, allowed vendors, auto lock date, blocked categories, blocked vendors, interval, limit, next interval reset, start of interval, temporary limit, transaction amount limit
A set of restrictions imposed on the spend program.
Read only: true
restrictions (anyOf 2)nullAlternative

Referenced models: Fetch a spend program — response body — permitted spend types primary card enabled, reimbursements enabled, Fetch a spend program — response body — custom form collection custom form collection log entry, Fetch a spend program — response body — line item accounting fields item, Fetch a spend program — response body — line item custom fields item, Fetch a spend program — response body — restrictions allowed categories, allowed vendors, auto lock date, blocked categories, blocked vendors, interval, limit, next interval reset, start of interval, temporary limit, transaction amount limit

Fetch a spend program — response body — custom form collection custom form collection log entry

FieldTypePresenceDescription and constraints
$objectRoot
custom_form_collection_log_entryJSONRequired within parent
custom_form_collection_log_entry (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label
Latest log entry for the custom form collection.
custom_form_collection_log_entry (anyOf 2)nullAlternative

Referenced models: Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label

FieldTypePresenceDescription and constraints
$objectRoot
formsarrayRequired within parentThe collection of custom forms for the custom form collection log entry.
forms[]ModelEach itemExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item
labelJSONRequired within parent
label (anyOf 1)stringAlternativeThe label or name for the custom form collection log entry.
label (anyOf 2)nullAlternative

Referenced models: Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item

FieldTypePresenceDescription and constraints
$objectRoot
fieldsarrayRequired within parentThe individual custom form fields associated with the custom form.
fields[]ModelEach itemExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item
labelJSONRequired within parent
label (anyOf 1)stringAlternativeThe label or name for the custom form.
label (anyOf 2)nullAlternative

Referenced models: Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item

FieldTypePresenceDescription and constraints
$objectRoot
allowed_dynamic_user_group_uuidsJSONOptional
allowed_dynamic_user_group_uuids (anyOf 1)arrayAlternativeDynamic user groups whose members may be selected for this field.
Default: null
allowed_dynamic_user_group_uuids (anyOf 1)[]stringEach item
allowed_dynamic_user_group_uuids (anyOf 2)nullAlternative
allowed_usersJSONOptional
allowed_users (anyOf 1)arrayAlternativeEligible users resolved for this form. Null applies no additional restriction; an empty list means no eligible users.
Default: null
allowed_users (anyOf 1)[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item allowed users array item
allowed_users (anyOf 2)nullAlternative
answer_filter_workflow_definitionJSONOptional
answer_filter_workflow_definition (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item answer filter workflow definition fallback vertices, vertices
Workflow definition that conditionally filters this field's choices.
Default: null
answer_filter_workflow_definition (anyOf 2)nullAlternative
approval_workflow_referencesJSONOptional
approval_workflow_references (anyOf 1)arrayAlternativeApproval workflow dependencies; absent or null when unavailable, otherwise complete.
Default: null
approval_workflow_references (anyOf 1)[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item approval workflow references array item
approval_workflow_references (anyOf 2)nullAlternative
attachmentsarrayOptional
attachments[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item attachments item
conditionsJSONRequired within parent
conditions (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then
conditions (anyOf 2)nullAlternative
default_answer_workflow_definitionJSONOptional
default_answer_workflow_definition (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item answer filter workflow definition fallback vertices, vertices
Workflow definition that conditionally defaults this field's answer.
Default: null
default_answer_workflow_definition (anyOf 2)nullAlternative
descriptionJSONRequired within parent
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
disclaimerJSONRequired within parent
disclaimer (anyOf 1)stringAlternative
disclaimer (anyOf 2)nullAlternative
document_categoryJSONOptional
document_category (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item document category string
Default: null
document_category (anyOf 2)nullAlternative
exclude_from_ai_prefillbooleanOptionalWhen True, AI intake/document prefill never generates an answer for this field.
Default: false
fieldModelRequired within parentExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field
field_idstringRequired within parent
field_mapping_referencesarrayOptionalIntegration field mappings that reference this question.
field_mapping_references[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field mapping references item
global_library_field_idJSONOptional
global_library_field_id (anyOf 1)stringAlternativeDefault: null
global_library_field_id (anyOf 2)nullAlternative
is_mapped_to_ironclad_fieldbooleanOptionalDefault: false
is_used_in_approval_workflow_approval_stepbooleanOptionalWhether an approval step selects its approver from this field.
Default: false
is_used_in_approval_workflow_conditionbooleanOptionalBroad compatibility flag for fields used in approval conditions or approval steps.
Default: false
is_used_in_custom_form_workflow_conditionbooleanOptionalDefault: false
labelstringRequired within parent
requiredbooleanRequired within parent
required_if_conditionsJSONOptional
required_if_conditions (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then
Conditions that make this field required when they evaluate to true.
Default: null
required_if_conditions (anyOf 2)nullAlternative
short_titleJSONOptional
short_title (anyOf 1)stringAlternativeOptional concise title copied from a Global Question Library field.
Default: null
short_title (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item answer filter workflow definition fallback vertices, vertices, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item document category string, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item approval workflow references array item, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field mapping references item, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item attachments item, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item allowed users array item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item answer filter workflow definition fallback vertices, vertices

FieldTypePresenceDescription and constraints
$objectRoot
fallback_verticesarrayRequired within parentFallback action used when no conditional branch matches.
fallback_vertices[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION
verticesarrayRequired within parentOrdered conditional branches for this field effect.
vertices[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type SDK CONDITION

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type SDK CONDITION

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item document category string

FieldTypePresenceDescription and constraints
$stringRootKnown 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

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"ADDRESS": "#/components/schemas/CustomFormAddressFieldSchema", "BOOLEAN": "#/components/schemas/CustomFormBooleanFieldSchema", "CONTACT": "#/components/schemas/CustomFormContactFieldSchema", "DATE": "#/components/schemas/CustomFormDateFieldSchema", "DEPARTMENT": "#/components/schemas/CustomFormDepartmentFieldSchema", "EMAIL": "#/components/schemas/CustomFormEmailFieldSchema", "FILE_UPLOAD": "#/components/schemas/CustomFormFileUploadFieldSchema", "LINK": "#/components/schemas/CustomFormLinkFieldSchema", "MERCHANT": "#/components/schemas/CustomFormMerchantFieldSchema", "MERCHANT_CATEGORY": "#/components/schemas/CustomFormMerchantCategoryFieldSchema", "MONETARY_AMOUNT": "#/components/schemas/CustomFormMonetaryAmountFieldSchema", "NUMBER": "#/components/schemas/CustomFormNumberFieldSchema", "PARAGRAPH": "#/components/schemas/CustomFormParagraphFieldSchema", "TEXT": "#/components/schemas/CustomFormTextFieldSchema", "TEXT_MULTI_SELECT": "#/components/schemas/CustomFormTextMultiSelectFieldSchema", "TEXT_SINGLE_SELECT": "#/components/schemas/CustomFormTextSingleSelectFieldSchema", "USER": "#/components/schemas/CustomFormUserFieldSchema", "VENDOR": "#/components/schemas/CustomFormVendorFieldSchema"}, "propertyName": "field_type"}
$ (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type ADDRESS
$ (anyOf 2)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type BOOLEAN
$ (anyOf 3)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type CONTACT
$ (anyOf 4)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type DATE
$ (anyOf 5)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type DEPARTMENT
$ (anyOf 6)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type EMAIL
$ (anyOf 7)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type FILE UPLOAD
$ (anyOf 8)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type LINK
$ (anyOf 9)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT CATEGORY
$ (anyOf 10)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT
$ (anyOf 11)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MONETARY AMOUNT
$ (anyOf 12)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type NUMBER
$ (anyOf 13)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type PARAGRAPH
$ (anyOf 14)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type TEXT
$ (anyOf 15)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type TEXT MULTI SELECT
$ (anyOf 16)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type TEXT SINGLE SELECT
$ (anyOf 17)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type USER
$ (anyOf 18)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type VENDOR

Referenced models: Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type DEPARTMENT, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type USER, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type VENDOR, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type ADDRESS, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type BOOLEAN, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type CONTACT, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type DATE, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type EMAIL, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type FILE UPLOAD, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type LINK, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT CATEGORY, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MONETARY AMOUNT, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type NUMBER, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type PARAGRAPH, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type TEXT, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type TEXT MULTI SELECT, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type TEXT SINGLE SELECT

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type ADDRESS

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: ADDRESS
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type BOOLEAN

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: BOOLEAN
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type CONTACT

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: CONTACT
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type DATE

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: DATE
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type DEPARTMENT

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: DEPARTMENT

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type EMAIL

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: EMAIL
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type FILE UPLOAD

FieldTypePresenceDescription and constraints
$objectRoot
allowed_file_typesJSONOptional
allowed_file_types (anyOf 1)arrayAlternativeDefault: null
allowed_file_types (anyOf 1)[]stringEach itemKnown 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
allowed_file_types (anyOf 2)nullAlternative
document_categoryJSONOptional
document_category (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item document category string
Default: null
document_category (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: FILE_UPLOAD
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD mapped fields item, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item document category string

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type LINK

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: LINK
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: MERCHANT
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT mapped fields item

Referenced models: Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT CATEGORY

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: MERCHANT_CATEGORY
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item

Referenced models: Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"SPEND_ALLOCATION__MERCHANT_CATEGORY_RESTRICTIONS": "#/components/schemas/SpendAllocationMerchantCategoryRestrictionsMappedFieldSchema", "SPEND_ALLOCATION__MERCHANT_CATEGORY_RESTRICTIONS_ALLOWLIST": "#/components/schemas/SpendAllocationMerchantCategoryRestrictionsAllowListMappedFieldSchema", "SPEND_ALLOCATION__MERCHANT_CATEGORY_RESTRICTIONS_BLOCKLIST": "#/components/schemas/SpendAllocationMerchantCategoryRestrictionsBlockListMappedFieldSchema"}, "propertyName": "mapped_field"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS ALLOWLIST
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS BLOCKLIST
$ (anyOf 3)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS ALLOWLIST, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS BLOCKLIST, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: SPEND_ALLOCATION__MERCHANT_CATEGORY_RESTRICTIONS

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT mapped fields item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"SPEND_ALLOCATION__MERCHANT_RESTRICTIONS": "#/components/schemas/SpendAllocationMerchantRestrictionsMappedFieldSchema", "SPEND_ALLOCATION__MERCHANT_RESTRICTIONS_ALLOWLIST": "#/components/schemas/SpendAllocationMerchantRestrictionsAllowListMappedFieldSchema", "SPEND_ALLOCATION__MERCHANT_RESTRICTIONS_BLOCKLIST": "#/components/schemas/SpendAllocationMerchantRestrictionsBlockListMappedFieldSchema"}, "propertyName": "mapped_field"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS ALLOWLIST
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS BLOCKLIST
$ (anyOf 3)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS ALLOWLIST, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS BLOCKLIST, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: SPEND_ALLOCATION__MERCHANT_RESTRICTIONS

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type MONETARY AMOUNT

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: MONETARY_AMOUNT
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type NUMBER

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: NUMBER
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type NUMBER mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type NUMBER mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type PARAGRAPH

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: PARAGRAPH
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type PARAGRAPH mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type PARAGRAPH mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type TEXT

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: TEXT
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type TEXT MULTI SELECT

FieldTypePresenceDescription and constraints
$objectRoot
choicesarrayOptional
choices[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT MULTI SELECT choices item
field_typestringRequired within parentMust equal: TEXT_MULTI_SELECT
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT MULTI SELECT choices item, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type TEXT SINGLE SELECT

FieldTypePresenceDescription and constraints
$objectRoot
choicesarrayOptional
choices[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT MULTI SELECT choices item
field_typestringRequired within parentMust equal: TEXT_SINGLE_SELECT
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT SINGLE SELECT mapped fields item

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT MULTI SELECT choices item, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT SINGLE SELECT mapped fields item

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type USER

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentField type discriminator for a user selection field.
Must equal: USER

Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field field type VENDOR

FieldTypePresenceDescription and constraints
$objectRoot
field_typestringRequired within parentMust equal: VENDOR

Fetch a spend program — response body — line item accounting fields item

FieldTypePresenceDescription and constraints
$objectRoot
external_idstringRequired within parentExternal ID that uniquely identifies this field in the ERP.
idstringRequired within parentID that uniquely identifies an accounting field within Ramp
Format: uuid
is_requiredbooleanRequired within parentWhether this accounting field is required for line items in the spend program.
namestringRequired within parentDisplay name of the custom accounting field.
typestringRequired within parentType of the custom accounting field.
Known values: AMORTIZATION_TEMPLATE, BILLABLE, COST_CENTER, CUSTOMERS_JOBS, DEFERRAL_CODE, EXPENSE_ENTITY, GL_ACCOUNT, INVENTORY_ITEM, JOURNAL, MERCHANT, NON_ERP, OTHER, PAYROLL_PROVIDER, PROJECT, REPORTING_TAG, SALES_TAX_CODE, SUBSIDIARY, TAX_CODE, UNIT_OF_MEASURE

Fetch a spend program — response body — line item custom fields item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the custom field.
description (anyOf 2)nullAlternative
display_namestringRequired within parentDisplay name of the custom field.
field_typestringRequired within parentType of the custom field.
Known values: boolean, category, currency, date, email, multi_select, number, numeric_id, paragraph, percentage, phone, select, text, url
idstringRequired within parentID that uniquely identifies the custom field within Ramp.
is_requiredbooleanRequired within parentWhether this custom field is required for line items in the spend program.

Fetch a spend program — response body — permitted spend types primary card enabled, reimbursements enabled

FieldTypePresenceDescription and constraints
$objectRoot
primary_card_enabledbooleanRequired within parentIndicates whether the user's physical card can be linked to this limit.
reimbursements_enabledbooleanRequired within parentIndicates whether reimbursements can be submitted against this limit.

Fetch a spend program — response body — restrictions allowed categories, allowed vendors, auto lock date, blocked categories, blocked vendors, interval, limit, next interval reset, start of interval, temporary limit, transaction amount limit

FieldTypePresenceDescription and constraints
$objectRoot
allowed_categoriesarrayRequired within parentList of Ramp category codes allowed for the limit.
allowed_categories[]JSONEach item
allowed_categories[] (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_categories[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
allowed_vendorsarrayRequired within parentList of merchants allowed for the limit.
allowed_vendors[]stringEach itemFormat: uuid
auto_lock_dateJSONRequired within parent
auto_lock_date (anyOf 1)stringAlternativeDate to automatically to lock the limit.
Format: date-time
auto_lock_date (anyOf 2)nullAlternative
blocked_categoriesarrayRequired within parentList of Ramp category codes blocked for the limit.
blocked_categories[]JSONEach item
blocked_categories[] (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_categories[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
blocked_vendorsarrayRequired within parentList of merchants blocked for the limit.
blocked_vendors[]stringEach itemFormat: uuid
intervalstringRequired within parentTime interval the limit is applied on.
Known values: ANNUAL, CUSTOM, 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 (e.g. cents for USD).
Read only: true
limit (anyOf 2)nullAlternative
next_interval_resetJSONRequired within parent
next_interval_reset (anyOf 1)stringAlternativeDate and time for the next interval reset.
Format: date-time
next_interval_reset (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

List External Approval Request nodes for a spend program — response body

FieldTypePresenceDescription and constraints
$objectRoot
workflow_nodesarrayRequired within parentExternal Approval Request nodes in the spend program's Blank Canvas workflow that match the requested service_key.
workflow_nodes[]ModelEach itemExpand List External Approval Request nodes for a spend program — response body — workflow nodes item

Referenced models: List External Approval Request nodes for a spend program — response body — workflow nodes item

List External Approval Request nodes for a spend program — response body — workflow nodes item

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentDisplay name configured for the node.
next_node_idJSONRequired within parent
next_node_id (anyOf 1)stringAlternativeIdentifier for the next node in the workflow, if available.
next_node_id (anyOf 2)nullAlternative
node_idstringRequired within parentIdentifier for the External Approval Request node.
service_keyJSONRequired within parent
service_key (anyOf 1)stringAlternativeExternal approval integration key configured on this workflow node. This matches the service_key query parameter for returned nodes.
service_key (anyOf 2)nullAlternative

List spend programs — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Create a spend program — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, Create a spend program — response body

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.