Skip to content

Ramp: Unified request schemas (part 6)

10 Ramp schemas with complete fields and constraints.

← Unified request operations · All schemas

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED

FieldTypePresenceDescription and constraints
$objectRoot
approval_instance_uuidJSONRequired within parent
approval_instance_uuid (anyOf 1)stringAlternative
approval_instance_uuid (anyOf 2)nullAlternative
approval_statusstringRequired within parentKnown values: APPROVED, PENDING, REJECTED
available_actionsModelRequired within parentExpand Fetch a vendor agreement — response body — payee available actions
Read only: true
business_vendorJSONRequired within parent
business_vendor (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED business vendor uuid, vendor tracking category option id
business_vendor (anyOf 2)nullAlternative
card_merchantsarrayRequired within parentRead only: true
card_merchants[]ModelEach itemExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED card merchants item
creation_sourcestringRequired within parentHow the vendor was created.
Known values: AGENT, AP_INTAKE_COWORKER_AGENT, ASK_RAMP, BULK_IMPORT, CARD_MERCHANT, DEVELOPER_API, ERP_IMPORT, MANUAL, MANUAL_PAYEE_EDIT, PROCUREMENT_SPEND_REQUEST
dba_nameJSONRequired within parent
dba_name (anyOf 1)stringAlternative
dba_name (anyOf 2)nullAlternative
deleted_atJSONRequired within parent
deleted_at (anyOf 1)stringAlternativeFormat: date-time
deleted_at (anyOf 2)nullAlternative
image_urlJSONRequired within parent
image_url (anyOf 1)stringAlternativeRead only: true
image_url (anyOf 2)nullAlternative
is_draftbooleanRequired within parent
namestringRequired within parent
ownersarrayRequired within parent
owners[]ModelEach itemExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED owners item
uuidstringRequired within parentFormat: uuid
websiteJSONRequired within parent
website (anyOf 1)stringAlternative
website (anyOf 2)nullAlternative

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED owners item, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED business vendor uuid, vendor tracking category option id, Fetch a vendor agreement — response body — payee available actions, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED card merchants item

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED business vendor uuid, vendor tracking category option id

FieldTypePresenceDescription and constraints
$objectRoot
uuidstringRequired within parentFormat: uuid
vendor_tracking_category_option_idJSONRequired within parent
vendor_tracking_category_option_id (anyOf 1)JSONAlternative
vendor_tracking_category_option_id (anyOf 1) (anyOf 1)integerAlternative
vendor_tracking_category_option_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
vendor_tracking_category_option_id (anyOf 2)nullAlternative

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED card merchants item

FieldTypePresenceDescription and constraints
$objectRoot
merchant_namestringRequired within parent
uuidstringRequired within parentFormat: uuid

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST payee approval status: APPROVED, PENDING, REJECTED owners item

FieldTypePresenceDescription and constraints
$objectRoot
departmentJSONRequired within parent
department (anyOf 1)stringAlternative
department (anyOf 2)nullAlternative
emailstringRequired within parent
full_namestringRequired within parent
idstringRequired within parentFormat: uuid
is_inactivebooleanRequired within parent
is_terminatedbooleanRequired within parent
locationJSONRequired within parent
location (anyOf 1)stringAlternative
location (anyOf 2)nullAlternative
profile_picture_urlJSONRequired within parent
profile_picture_url (anyOf 1)stringAlternative
profile_picture_url (anyOf 2)nullAlternative

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST spend intent logo id, name, uuid

FieldTypePresenceDescription and constraints
$objectRoot
logo_idstringRequired within parentKnown 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
namestringRequired within parent
uuidstringRequired within parentFormat: uuid

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST wbx migration assigned program name, migrated at, original policy name

FieldTypePresenceDescription and constraints
$objectRoot
assigned_program_nameJSONRequired within parent
assigned_program_name (anyOf 1)stringAlternativeName of the spend program currently associated with the request.
assigned_program_name (anyOf 2)nullAlternative
migrated_atstringRequired within parentTime the original request moved from its policy to a spend program.
Format: date-time
original_policy_namestringRequired within parentName of the policy under which the request was submitted.

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL spend request type: TRAVEL, unified spend request type: TRAVEL spend allocation outcome settings spend frequency: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

FieldTypePresenceDescription and constraints
$objectRoot
amount_detailsModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details
Read only: true
is_shareablebooleanRequired within parent
lock_dateJSONRequired within parent
lock_date (anyOf 1)stringAlternativeFormat: date-time
lock_date (anyOf 2)nullAlternative
payment_restrictionsModelRequired within parentExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled
Read only: true
spend_eligibility_starts_atJSONRequired within parent
spend_eligibility_starts_at (anyOf 1)stringAlternativeFormat: date-time
spend_eligibility_starts_at (anyOf 2)nullAlternative
spend_frequencystringRequired within parentKnown values: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST amount details, total amount details amount details, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified spend request type: SPEND ALLOCATION payment restrictions primary card enabled, reimbursements enabled, virtual card enabled

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL spend request type: TRAVEL, unified spend request type: TRAVEL travel metadata

FieldTypePresenceDescription and constraints
$objectRoot
originJSONRequired within parent
origin (anyOf 1)ModelAlternativeExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata travel location
origin (anyOf 2)nullAlternative
payment_methodstringRequired within parentKnown values: NONE, SPEND_ALLOCATION
travel_locationModelRequired within parentExpand Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata travel location
travel_request_typestringRequired within parentKnown values: GROUP, INDIVIDUAL
trip_end_datestringRequired within parentFormat: date
trip_start_datestringRequired within parentFormat: date

Referenced models: Get a unified request — response body — value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL approval chain data, attendees count, available actions, group trip, members, spend allocation outcome settings, travel metadata, trip travel metadata travel location

List unified requests with pagination — response body — item value

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"APPROVAL_ONLY": "#/components/schemas/ApprovalOnlyRequest", "FUND_UNARCHIVE": "#/components/schemas/FundUnarchiveRequest", "PROCUREMENT_SPEND_ALLOCATION": "#/components/schemas/ProcurementSpendAllocationRequest", "PURCHASE_ORDER": "#/components/schemas/PurchaseOrderRequest", "SPEND_ALLOCATION": "#/components/schemas/SpendAllocationRequest", "TRAVEL": "#/components/schemas/TravelRequest"}, "propertyName": "unified_spend_request_type"}
$ (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY
$ (anyOf 2)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE
$ (anyOf 3)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION
$ (anyOf 4)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER
$ (anyOf 5)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION
$ (anyOf 6)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL

Upload an attachment to a unified request — response body

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the uploaded attachment.
Format: uuid

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.