Ramp: Spend program schemas
43 Ramp schemas with complete fields and constraints.
← Spend program operations · All schemas
Create a spend program — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Description of the spend program. |
display_name | string | Required within parent | Display name of the spend program. |
icon | string | Required within parent | The 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_shareable | boolean | Optional | Dictates whether the spend program is shareable among multiple users. Default: false |
issuance_rules | JSON | Optional | |
issuance_rules (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
issue_physical_card_if_needed | boolean | Optional | Dictates whether the spend program should issue a physical card if the user does not have one. Default: false |
permitted_spend_types | Model | Required within parent | Expand Create a spend program — request body — body permitted spend types Specifies the permitted spend types for the spend program. |
spending_restrictions | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
automatic | JSON | Optional | |
automatic (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
requestable | JSON | Optional | |
requestable (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applies_to_all | boolean | Optional | Dictates 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_ids | array | Optional | List of departments whose users are able to request or be issued this spend program. |
department_ids[] | string | Each item | Format: uuid |
location_ids | array | Optional | List of locations whose users are able to request or be issued this spend program. |
location_ids[] | string | Each item | Format: uuid |
user_custom_field_ids | array | Optional | |
user_custom_field_ids[] | string | Each item | Format: uuid |
Create a spend program — request body — body permitted spend types
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
primary_card_enabled | boolean | Required within parent | Dictates whether the user's physical card can be linked to this limit. |
reimbursements_enabled | boolean | Required within parent | Dictates whether reimbursements can be submitted against this limit. |
Create a spend program — request body — body spending restrictions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_categories | array | Optional | List of Ramp category codes allowed for the limit. |
allowed_categories[] | 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_vendors | array | Optional | List of merchants allowed for the limit. |
allowed_vendors[] | string | Each item | Format: uuid |
blocked_categories | array | Optional | List of Ramp category codes blocked for the limit. |
blocked_categories[] | 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_vendors | array | Optional | List of merchants blocked for the limit. |
blocked_vendors[] | string | Each item | Format: uuid |
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 | string | Optional | Date 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_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 spend program — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Description of the spend program. |
display_name | string | Required within parent | Display name of the spend program. |
icon | string | Required within parent | The 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 |
id | string | Required within parent | Unique identifier of the spend program. Format: uuid |
is_shareable | boolean | Required within parent | Whether this spend program is shareable. |
issue_physical_card_if_needed | boolean | Required within parent | Indicates whether the spend program should issue a physical card if the user does not have one. |
permitted_spend_types | JSON | Required within parent | |
permitted_spend_types (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
restrictions | JSON | Required within parent | |
restrictions (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_form_collection | JSON | Required within parent | |
custom_form_collection (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
description | string | Required within parent | Description of the spend program. |
display_name | string | Required within parent | Display name of the spend program. |
icon | string | Required within parent | The 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 |
id | string | Required within parent | Unique identifier of the spend program. Format: uuid |
is_shareable | boolean | Required within parent | Whether this spend program is shareable. |
issue_physical_card_if_needed | boolean | Required within parent | Indicates whether the spend program should issue a physical card if the user does not have one. |
line_item_accounting_fields | array | Required within parent | Custom accounting fields enabled for line items in this spend program. Read only: true |
line_item_accounting_fields[] | Model | Each item | Expand Fetch a spend program — response body — line item accounting fields item |
line_item_custom_fields | array | Required within parent | Custom fields enabled for line items in this spend program. Read only: true |
line_item_custom_fields[] | Model | Each item | Expand Fetch a spend program — response body — line item custom fields item |
permitted_spend_types | JSON | Required within parent | |
permitted_spend_types (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
restrictions | JSON | Required within parent | |
restrictions (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_form_collection_log_entry | JSON | Required within parent | |
custom_form_collection_log_entry (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
forms | array | Required within parent | The collection of custom forms for the custom form collection log entry. |
forms[] | Model | Each item | Expand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item |
label | JSON | Required within parent | |
label (anyOf 1) | string | Alternative | The label or name for the custom form collection log entry. |
label (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fields | array | Required within parent | The individual custom form fields associated with the custom form. |
fields[] | Model | Each item | Expand 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 |
label | JSON | Required within parent | |
label (anyOf 1) | string | Alternative | The label or name for the custom form. |
label (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_dynamic_user_group_uuids | JSON | Optional | |
allowed_dynamic_user_group_uuids (anyOf 1) | array | Alternative | Dynamic user groups whose members may be selected for this field. Default: null |
allowed_dynamic_user_group_uuids (anyOf 1)[] | string | Each item | |
allowed_dynamic_user_group_uuids (anyOf 2) | null | Alternative | |
allowed_users | JSON | Optional | |
allowed_users (anyOf 1) | array | Alternative | Eligible users resolved for this form. Null applies no additional restriction; an empty list means no eligible users. Default: null |
allowed_users (anyOf 1)[] | Model | Each item | Expand 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) | null | Alternative | |
answer_filter_workflow_definition | JSON | Optional | |
answer_filter_workflow_definition (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
approval_workflow_references | JSON | Optional | |
approval_workflow_references (anyOf 1) | array | Alternative | Approval workflow dependencies; absent or null when unavailable, otherwise complete. Default: null |
approval_workflow_references (anyOf 1)[] | Model | Each item | Expand 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) | null | Alternative | |
attachments | array | Optional | |
attachments[] | Model | Each item | Expand 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 |
conditions | JSON | Required within parent | |
conditions (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
default_answer_workflow_definition | JSON | Optional | |
default_answer_workflow_definition (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
disclaimer | JSON | Required within parent | |
disclaimer (anyOf 1) | string | Alternative | |
disclaimer (anyOf 2) | null | Alternative | |
document_category | JSON | Optional | |
document_category (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
exclude_from_ai_prefill | boolean | Optional | When True, AI intake/document prefill never generates an answer for this field. Default: false |
field | Model | Required within parent | Expand 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_id | string | Required within parent | |
field_mapping_references | array | Optional | Integration field mappings that reference this question. |
field_mapping_references[] | Model | Each item | Expand 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_id | JSON | Optional | |
global_library_field_id (anyOf 1) | string | Alternative | Default: null |
global_library_field_id (anyOf 2) | null | Alternative | |
is_mapped_to_ironclad_field | boolean | Optional | Default: false |
is_used_in_approval_workflow_approval_step | boolean | Optional | Whether an approval step selects its approver from this field. Default: false |
is_used_in_approval_workflow_condition | boolean | Optional | Broad compatibility flag for fields used in approval conditions or approval steps. Default: false |
is_used_in_custom_form_workflow_condition | boolean | Optional | Default: false |
label | string | Required within parent | |
required | boolean | Required within parent | |
required_if_conditions | JSON | Optional | |
required_if_conditions (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
short_title | JSON | Optional | |
short_title (anyOf 1) | string | Alternative | Optional concise title copied from a Global Question Library field. Default: null |
short_title (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fallback_vertices | array | Required within parent | Fallback action used when no conditional branch matches. |
fallback_vertices[] | Model | Each item | Expand 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 |
vertices | array | Required within parent | Ordered conditional branches for this field effect. |
vertices[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Known 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: ADDRESS |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: BOOLEAN |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: CONTACT |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: DATE |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: EMAIL |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_file_types | JSON | Optional | |
allowed_file_types (anyOf 1) | array | Alternative | Default: null |
allowed_file_types (anyOf 1)[] | string | Each item | Known 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) | null | Alternative | |
document_category | JSON | Optional | |
document_category (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
field_type | string | Required within parent | Must equal: FILE_UPLOAD |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: LINK |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: MERCHANT |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: MERCHANT_CATEGORY |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: MONETARY_AMOUNT |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: NUMBER |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: PARAGRAPH |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: TEXT |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
choices | array | Optional | |
choices[] | Model | Each item | Expand 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_type | string | Required within parent | Must equal: TEXT_MULTI_SELECT |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
choices | array | Optional | |
choices[] | Model | Each item | Expand 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_type | string | Required within parent | Must equal: TEXT_SINGLE_SELECT |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Field 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_type | string | Required within parent | Must equal: VENDOR |
Fetch a spend program — response body — line item accounting fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | string | Required within parent | External ID that uniquely identifies this field in the ERP. |
id | string | Required within parent | ID that uniquely identifies an accounting field within Ramp Format: uuid |
is_required | boolean | Required within parent | Whether this accounting field is required for line items in the spend program. |
name | string | Required within parent | Display name of the custom accounting field. |
type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Description of the custom field. |
description (anyOf 2) | null | Alternative | |
display_name | string | Required within parent | Display name of the custom field. |
field_type | string | Required within parent | Type of the custom field. Known values: boolean, category, currency, date, email, multi_select, number, numeric_id, paragraph, percentage, phone, select, text, url |
id | string | Required within parent | ID that uniquely identifies the custom field within Ramp. |
is_required | boolean | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
primary_card_enabled | boolean | Required within parent | Indicates whether the user's physical card can be linked to this limit. |
reimbursements_enabled | boolean | Required within parent | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_categories | array | Required within parent | List of Ramp category codes allowed for the limit. |
allowed_categories[] | JSON | Each item | |
allowed_categories[] (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_categories[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
allowed_vendors | array | Required within parent | List of merchants allowed for the limit. |
allowed_vendors[] | string | Each item | Format: uuid |
auto_lock_date | JSON | Required within parent | |
auto_lock_date (anyOf 1) | string | Alternative | Date to automatically to lock the limit. Format: date-time |
auto_lock_date (anyOf 2) | null | Alternative | |
blocked_categories | array | Required within parent | List of Ramp category codes blocked for the limit. |
blocked_categories[] | JSON | Each item | |
blocked_categories[] (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_categories[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
blocked_vendors | array | Required within parent | List of merchants blocked for the limit. |
blocked_vendors[] | string | Each item | Format: uuid |
interval | string | Required within parent | Time interval the limit is applied on. Known values: ANNUAL, CUSTOM, 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 (e.g. cents for USD). Read only: true |
limit (anyOf 2) | null | Alternative | |
next_interval_reset | JSON | Required within parent | |
next_interval_reset (anyOf 1) | string | Alternative | Date and time for the next interval reset. Format: date-time |
next_interval_reset (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
List External Approval Request nodes for a spend program — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
workflow_nodes | array | Required within parent | External Approval Request nodes in the spend program's Blank Canvas workflow that match the requested service_key. |
workflow_nodes[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | Display name configured for the node. |
next_node_id | JSON | Required within parent | |
next_node_id (anyOf 1) | string | Alternative | Identifier for the next node in the workflow, if available. |
next_node_id (anyOf 2) | null | Alternative | |
node_id | string | Required within parent | Identifier for the External Approval Request node. |
service_key | JSON | Required within parent | |
service_key (anyOf 1) | string | Alternative | External approval integration key configured on this workflow node. This matches the service_key query parameter for returned nodes. |
service_key (anyOf 2) | null | Alternative |
List spend programs — 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 Create a spend program — 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, Create a spend program — response body