Skip to content

Ramp: Reimbursement schemas

8 Ramp schemas with complete fields and constraints.

← Reimbursement operations · All schemas

Create a mileage reimbursement — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
distanceJSONRequired within parent
distance (oneOf 1)stringAlternativeFormat: decimal
distance (oneOf 2)numberAlternative
distance_unitsstringOptionalOne of: KILOMETERS, MILES
end_locationstringOptional
memostringOptional
reimbursee_idstringRequired within parentFormat: uuid
spend_allocation_idJSONOptional
spend_allocation_id (anyOf 1)stringAlternativeUnique identifier of the fund to attribute the mileage reimbursement to
Format: uuid
spend_allocation_id (anyOf 2)nullAlternative
start_locationstringOptional
trip_datestringRequired within parentFormat: date
waypointsarrayOptional
waypoints[]stringEach item

Fetch a reimbursement — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_dateJSONRequired within parent
accounting_date (anyOf 1)stringAlternativeThe date for accounting purposes. An accounting date override takes precedence. Otherwise, uses the transaction date or reviewed date according to accounting sync settings when enabled for the business; falls back to the transaction date otherwise.
Format: date-time
Read only: true
accounting_date (anyOf 2)nullAlternative
accounting_field_selectionsarrayRequired within parentList of accounting fields selected to code the reimbursement.
accounting_field_selections[]ModelEach itemExpand Fetch a reimbursement — response body — accounting field selections item
approved_atJSONRequired within parent
approved_at (anyOf 1)stringAlternativeTime at which the reimbursement is approved. Presented in ISO8601 format.
Format: date-time
approved_at (anyOf 2)nullAlternative
attendeesarrayRequired within parentList of attendees for the reimbursement.
attendees[]ModelEach itemExpand Fetch a transaction — response body — attendees item
created_atstringRequired within parentTime at which the reimbursement is created. Presented in ISO8601 format.
Format: date-time
directionstringRequired within parentThe direction of the reimbursement. It could be either BUSINESS_TO_USER or USER_TO_BUSINESS.
Known values: BUSINESS_TO_USER, USER_TO_BUSINESS
distanceJSONRequired within parent
distance (anyOf 1)JSONAlternative
distance (anyOf 1) (anyOf 1)numberAlternativeThe distance of the reimbursement in miles, for mileage reimbursements.
distance (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
distance (anyOf 2)nullAlternative
employee_idJSONRequired within parent
employee_id (anyOf 1)stringAlternativeEmployee ID of the person who made the reimbursement.
employee_id (anyOf 2)nullAlternative
end_locationJSONRequired within parent
end_location (anyOf 1)stringAlternativeEnding location of the trip, for mileage reimbursements.
end_location (anyOf 2)nullAlternative
entity_amountJSONRequired within parent
entity_amount (anyOf 1)ModelAlternativeExpand Fetch a reimbursement — response body — entity amount currency, minor unit conversion rate, value
Replaces legacy `amount` and `currency`. The amount that the payor entity pays, in the entity's settlement currency. Null if the reimbursement does not have an amount yet.
Read only: true
entity_amount (anyOf 2)nullAlternative
entity_idJSONRequired within parent
entity_id (anyOf 1)stringAlternativeUnique identifier of the associated business entity.
Format: uuid
entity_id (anyOf 2)nullAlternative
fund_idJSONRequired within parent
fund_id (anyOf 1)stringAlternativeThe Fund to which the reimbursement is attributed, if it exists.
Format: uuid
Read only: true
fund_id (anyOf 2)nullAlternative
funding_sourceJSONOptional
funding_source (anyOf 1)stringAlternativeFunding classification returned on list and fetch responses. PENDING means the funding source is not yet known before payment. Null means the funding source could not be determined. RAMP_FUNDED does not confirm settlement.
Known values: NOT_RAMP_FUNDED, PAID_OUTSIDE_RAMP, PENDING, RAMP_FUNDED
Read only: true
funding_source (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the reimbursement.
Format: uuid
line_itemsarrayRequired within parentList of line items related to the reimbursement.
line_items[]ModelEach itemExpand Fetch a reimbursement — response body — line items item
memoJSONRequired within parent
memo (anyOf 1)stringAlternativeReimbursement memo
memo (anyOf 2)nullAlternative
merchantJSONRequired within parent
merchant (anyOf 1)stringAlternativeThe name of the merchant that the reimbursement is associated with.
merchant (anyOf 2)nullAlternative
merchant_amountJSONRequired within parent
merchant_amount (anyOf 1)ModelAlternativeExpand Fetch a reimbursement — response body — entity amount currency, minor unit conversion rate, value
Replaces legacy `original_reimbursement_amount`. The amount originally submitted for the reimbursement, in the currency it was submitted in. Equal to `entity_amount` when no currency conversion occurred. Null when the original amount data is unavailable or invalid.
Read only: true
merchant_amount (anyOf 2)nullAlternative
merchant_idJSONRequired within parent
merchant_id (anyOf 1)stringAlternativeThe unique identifier of the merchant. Note that this field may be empty when merchant is populated if Ramp does not recognize the merchant.
Format: uuid
merchant_id (anyOf 2)nullAlternative
payee_amountJSONRequired within parent
payee_amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Amount and currency received by the payee.
payee_amount (anyOf 2)nullAlternative
payment_batch_idJSONRequired within parent
payment_batch_id (anyOf 1)stringAlternativeThe unique identifier of the reimbursement payment batch that the reimbursement is associated with.
Format: uuid
payment_batch_id (anyOf 2)nullAlternative
payment_idJSONRequired within parent
payment_id (anyOf 1)stringAlternativeThe unique identifier of the payment batch that the reimbursement is associated with, once paid.
payment_id (anyOf 2)nullAlternative
payment_processed_atJSONRequired within parent
payment_processed_at (anyOf 1)stringAlternativeTime of reimbursement payment. Presented in ISO8601 format.
Format: date-time
payment_processed_at (anyOf 2)nullAlternative
receiptsarrayRequired within parentRead only: true
receipts[]stringEach itemFormat: uuid
spend_limit_idJSONRequired within parent
spend_limit_id (anyOf 1)stringAlternativeAlias of `fund_id` (Fund). The Fund to which the reimbursement is attributed, if it exists.
Format: uuid
Read only: true
spend_limit_id (anyOf 2)nullAlternative
start_locationJSONRequired within parent
start_location (anyOf 1)stringAlternativeStarting location of the trip, for mileage reimbursements.
start_location (anyOf 2)nullAlternative
statestringRequired within parentcurrent state of the reimbursement.
Known values: APPROVED, AWAITING_EXPORT, AWAITING_PAYMENT, AWAITING_PUSH_PAYMENT, CANCELED, DELETED, DRAFT, EXPORTED, EXPORT_FAILED, EXPORT_INITIATED, EXPORT_MARKED_AS_FAILED, EXPORT_SUCCESSFUL, FAILED_REIMBURSEMENT, INIT, MANUALLY_REIMBURSED, MISSING_ACH, PAYROLL_FAILED, PAYROLL_SUBMITTED, PENDING, PROCESSING, PUSH_PAYMENT_FAILED, PUSH_PAYMENT_INITIATED, REIMBURSED, REIMBURSED_VIA_PAYROLL, REIMBURSED_VIA_PUSH, REJECTED
submitted_atJSONRequired within parent
submitted_at (anyOf 1)stringAlternativeTime when reimbursement was most recently submitted
Format: date-time
submitted_at (anyOf 2)nullAlternative
sync_statusstringRequired within parentCurrent sync status of the reimbursement.
Known values: NOT_SYNC_READY, SYNCED, SYNC_READY
Read only: true
synced_atJSONRequired within parent
synced_at (anyOf 1)stringAlternativeTime when reimbursement has been synced. Will be None if the reimbursement is not synced.
Format: date-time
synced_at (anyOf 2)nullAlternative
trace_idModelOptionalExpand Fetch a reimbursement — response body — trace id
The bank-facing accountability reference for this reimbursement payment, when available. Depending on the payment rail, this may be a trace ID, IMAD number, or reference number. This field is returned on reimbursement detail responses.
Read only: true
transaction_dateJSONRequired within parent
transaction_date (anyOf 1)stringAlternativeFormat: date
transaction_date (anyOf 2)nullAlternative
trip_idJSONRequired within parent
trip_id (anyOf 1)stringAlternativeTrip ID associated with the reimbursement if a Trip ID is available.
Format: uuid
trip_id (anyOf 2)nullAlternative
typestringRequired within parentThe type of the reimbursement.
Known values: MILEAGE, OUT_OF_POCKET, PAYBACK_FULL, PAYBACK_PARTIAL, PER_DIEM
updated_atJSONRequired within parent
updated_at (anyOf 1)stringAlternativeTime at which the reimbursement was last updated. Presented in ISO8601 format.
Format: date-time
updated_at (anyOf 2)nullAlternative
user_emailstringRequired within parentEmail of the person who made the reimbursement.
user_full_namestringRequired within parentFull name of the person who made the reimbursement.
user_idstringRequired within parentUnique identifier of the person who made the reimbursement.
Format: uuid
vehicle_mileage_classJSONRequired within parent
vehicle_mileage_class (anyOf 1)stringAlternativeVehicle class selected for a mileage reimbursement in countries with vehicle-class mileage rates. Null for non-mileage reimbursements or when no class applies.
Known values: AUSTRIA_BICYCLE, AUSTRIA_CAR, AUSTRIA_CAR_WITH_PASSENGER, AUSTRIA_MOTORBIKE, CZECH_CAR, CZECH_MOTORCYCLE, DENMARK_BIKE_SCOOTER, DENMARK_CAR_MOTORCYCLE, FINLAND_ATV, FINLAND_CAR, FINLAND_CAR_HEAVY_CARGO, FINLAND_CAR_TOWING_CARAVAN, FINLAND_CAR_TOWING_HEAVY_LOAD, FINLAND_CAR_TOWING_TRAILER, FINLAND_CAR_TRANSPORTING_DOG, FINLAND_CAR_UNPAVED_ROADS, FINLAND_COMPANY_CAR, FINLAND_MOPED, FINLAND_MOTORBOAT_50_HP_OR_LESS, FINLAND_MOTORBOAT_OVER_50_HP, FINLAND_MOTORCYCLE, FINLAND_OTHER, FINLAND_SNOWMOBILE, FRANCE_3_CV_AND_LESS, FRANCE_3_CV_AND_LESS_ELECTRIC, FRANCE_4_CV, FRANCE_4_CV_ELECTRIC, FRANCE_5_CV, FRANCE_5_CV_ELECTRIC, FRANCE_6_CV, FRANCE_6_CV_ELECTRIC, FRANCE_7_CV_AND_MORE, FRANCE_7_CV_AND_MORE_ELECTRIC, IRELAND_1200_CC_AND_LESS, IRELAND_1201_CC_TO_1500_CC, IRELAND_1501_CC_AND_MORE, NETHERLANDS_CAR_DIESEL, NETHERLANDS_CAR_FULLY_ELECTRIC, NETHERLANDS_CAR_GASOLINE, NETHERLANDS_CAR_OTHER_FUELS, NETHERLANDS_CAR_PLUG_IN_HYBRID, NETHERLANDS_CYCLING_WALKING, NETHERLANDS_MOPED_SCOOTER_ELECTRIC, NETHERLANDS_MOPED_SCOOTER_PETROL, NETHERLANDS_MOTORCYCLE_ELECTRIC, NETHERLANDS_MOTORCYCLE_GASOLINE, NETHERLANDS_PUBLIC_TRANSPORT, NEW_ZEALAND_DIESEL, NEW_ZEALAND_ELECTRIC, NEW_ZEALAND_PETROL, NEW_ZEALAND_PETROL_HYBRID, NORWAY_CAR, NORWAY_HEAVY_MOTORCYCLE, NORWAY_MOPED_LIGHT_MOTORCYCLE, POLAND_900_CC_AND_LESS, POLAND_900_CC_AND_MORE, UK_BICYCLES, UK_CARS_AND_VANS, UK_COMPANY_DIESEL_1600_CC_AND_LESS, UK_COMPANY_DIESEL_1601_TO_2000_CC, UK_COMPANY_DIESEL_OVER_2000_CC, UK_COMPANY_ELECTRIC_HOME, UK_COMPANY_ELECTRIC_PUBLIC, UK_COMPANY_LPG_1400_CC_AND_LESS, UK_COMPANY_LPG_1401_TO_2000_CC, UK_COMPANY_LPG_OVER_2000_CC, UK_COMPANY_PETROL_1400_CC_AND_LESS, UK_COMPANY_PETROL_1401_TO_2000_CC, UK_COMPANY_PETROL_OVER_2000_CC, UK_MOTORCYCLES
Read only: true
vehicle_mileage_class (anyOf 2)nullAlternative
waypointsarrayRequired within parentList of intermediate stops during the trip, for mileage reimbursements.
waypoints[]stringEach item

Referenced models: Fetch a transaction — response body — attendees item, Fetch a reimbursement — response body — trace id, Fetch a reimbursement — response body — accounting field selections item, Fetch a reimbursement — response body — entity amount currency, minor unit conversion rate, value, Fetch a reimbursement — response body — line items item, Hold Bill — response body — amount

Fetch a reimbursement — response body — accounting field selections item

FieldTypePresenceDescription and constraints
$objectRoot
category_infoJSONRequired within parent
category_info (anyOf 1)ModelAlternativeExpand Fetch a reimbursement — response body — accounting field selections item category info external id, id, name, type
Information about the parent accounting category.
category_info (anyOf 2)nullAlternative
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeCustomer-set display name for the accounting field option in Ramp. When the customer renames an option inside Ramp, this returns the new label while `name` continues to return the ERP-source name. May be null if no Ramp-side override is set.
display_name (anyOf 2)nullAlternative
external_codeJSONRequired within parent
external_code (anyOf 1)stringAlternativeExternal code displayed in the ERP for this option.
external_code (anyOf 2)nullAlternative
external_idJSONRequired within parent
external_id (anyOf 1)stringAlternativeExternal ID that uniquely identifies this option in the ERP.
external_id (anyOf 2)nullAlternative
idJSONRequired within parent
id (anyOf 1)stringAlternativeUnique identifier for this option within Ramp.
id (anyOf 2)nullAlternative
nameJSONRequired within parent
name (anyOf 1)stringAlternativeName of the accounting field option.
name (anyOf 2)nullAlternative
provider_nameJSONRequired within parent
provider_name (anyOf 1)stringAlternativeName of accounting field provider
Read only: true
provider_name (anyOf 2)nullAlternative
sourceJSONRequired within parent
source (anyOf 1)ModelAlternativeExpand Fetch a transaction — response body — accounting field selections item source
Source of this accounting coding selection.
source (anyOf 2)nullAlternative
typeJSONRequired within parent
type (anyOf 1)stringAlternativeType of 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
type (anyOf 2)nullAlternative

Referenced models: Fetch a transaction — response body — accounting field selections item source, Fetch a reimbursement — response body — accounting field selections item category info external id, id, name, type

Fetch a reimbursement — response body — accounting field selections item category info external id, id, name, type

FieldTypePresenceDescription and constraints
$objectRoot
external_idJSONRequired within parent
external_id (anyOf 1)stringAlternativeExternal ID that uniquely identifies this field in the ERP.
external_id (anyOf 2)nullAlternative
idJSONRequired within parent
id (anyOf 1)stringAlternativeUnique identifier for this accounting field within Ramp.
id (anyOf 2)nullAlternative
nameJSONRequired within parent
name (anyOf 1)stringAlternativeName of the accounting field.
name (anyOf 2)nullAlternative
typeJSONRequired within parent
type (anyOf 1)stringAlternativeType of 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
type (anyOf 2)nullAlternative

Fetch a reimbursement — response body — entity amount currency, minor unit conversion rate, value

FieldTypePresenceDescription and constraints
$objectRoot
currencystringRequired within parentThe currency of the amount in ISO 4217 format (e.g. USD).
Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL
minor_unit_conversion_rateJSONRequired within parent
minor_unit_conversion_rate (anyOf 1)JSONAlternative
minor_unit_conversion_rate (anyOf 1) (anyOf 1)integerAlternativeThe conversion factor to convert from the integer amount to the actual currency value. Divide `value` by this value to get the real currency amount. For USD, this is 100 (e.g., 12034 / 100 = 120.34 USD). See https://docs.ramp.com/developer-api/v1/monetary-values for more information.
Read only: true
minor_unit_conversion_rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minor_unit_conversion_rate (anyOf 2)nullAlternative
valueJSONRequired within parent
value (anyOf 1)integerAlternativeThe non-negative amount in the smallest denomination of the currency (e.g. cents for USD).
Minimum: 0
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch a reimbursement — response body — line items item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentAccounting field selections used to code this line item.
accounting_field_selections[]ModelEach itemExpand Fetch a reimbursement — response body — accounting field selections item
amountJSONRequired within parent
amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Amount of the line item.
amount (anyOf 2)nullAlternative
memoJSONRequired within parent
memo (anyOf 1)stringAlternativeMemo text for this line item.
memo (anyOf 2)nullAlternative

Referenced models: Fetch a reimbursement — response body — accounting field selections item, Hold Bill — response body — amount

Fetch a reimbursement — response body — trace id

FieldTypePresenceDescription and constraints
$objectRoot
descriptorJSONRequired within parent
descriptor (anyOf 1)stringAlternativeHuman-readable description of the bank reference. For example, 'Trace ID', 'IMAD number', or 'Reference number'.
Default: null
descriptor (anyOf 2)nullAlternative
trace_idJSONRequired within parent
trace_id (anyOf 1)stringAlternativeThe bank-facing accountability reference for the reimbursement payment.
Default: null
trace_id (anyOf 2)nullAlternative

List reimbursements — response body

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

Referenced models: List bills — response body — page, Fetch a reimbursement — 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.