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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
uuid | string | Required within parent | Format: uuid |
vendor_tracking_category_option_id | JSON | Required within parent | |
vendor_tracking_category_option_id (anyOf 1) | JSON | Alternative | |
vendor_tracking_category_option_id (anyOf 1) (anyOf 1) | integer | Alternative | |
vendor_tracking_category_option_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
vendor_tracking_category_option_id (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
merchant_name | string | Required within parent | |
uuid | string | Required within parent | Format: 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department | JSON | Required within parent | |
department (anyOf 1) | string | Alternative | |
department (anyOf 2) | null | Alternative | |
email | string | Required within parent | |
full_name | string | Required within parent | |
id | string | Required within parent | Format: uuid |
is_inactive | boolean | Required within parent | |
is_terminated | boolean | Required within parent | |
location | JSON | Required within parent | |
location (anyOf 1) | string | Alternative | |
location (anyOf 2) | null | Alternative | |
profile_picture_url | JSON | Required within parent | |
profile_picture_url (anyOf 1) | string | Alternative | |
profile_picture_url (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
logo_id | string | Required within parent | 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 |
name | string | Required within parent | |
uuid | string | Required within parent | Format: 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assigned_program_name | JSON | Required within parent | |
assigned_program_name (anyOf 1) | string | Alternative | Name of the spend program currently associated with the request. |
assigned_program_name (anyOf 2) | null | Alternative | |
migrated_at | string | Required within parent | Time the original request moved from its policy to a spend program. Format: date-time |
original_policy_name | string | Required within parent | Name 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
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
List unified requests with pagination — response body — item value
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the uploaded attachment. Format: uuid |