Ramp: Reimbursement schemas
8 Ramp schemas with complete fields and constraints.
← Reimbursement operations · All schemas
Create a mileage reimbursement — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
distance | JSON | Required within parent | |
distance (oneOf 1) | string | Alternative | Format: decimal |
distance (oneOf 2) | number | Alternative | |
distance_units | string | Optional | One of: KILOMETERS, MILES |
end_location | string | Optional | |
memo | string | Optional | |
reimbursee_id | string | Required within parent | Format: uuid |
spend_allocation_id | JSON | Optional | |
spend_allocation_id (anyOf 1) | string | Alternative | Unique identifier of the fund to attribute the mileage reimbursement to Format: uuid |
spend_allocation_id (anyOf 2) | null | Alternative | |
start_location | string | Optional | |
trip_date | string | Required within parent | Format: date |
waypoints | array | Optional | |
waypoints[] | string | Each item |
Fetch a reimbursement — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_date | JSON | Required within parent | |
accounting_date (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
accounting_field_selections | array | Required within parent | List of accounting fields selected to code the reimbursement. |
accounting_field_selections[] | Model | Each item | Expand Fetch a reimbursement — response body — accounting field selections item |
approved_at | JSON | Required within parent | |
approved_at (anyOf 1) | string | Alternative | Time at which the reimbursement is approved. Presented in ISO8601 format. Format: date-time |
approved_at (anyOf 2) | null | Alternative | |
attendees | array | Required within parent | List of attendees for the reimbursement. |
attendees[] | Model | Each item | Expand Fetch a transaction — response body — attendees item |
created_at | string | Required within parent | Time at which the reimbursement is created. Presented in ISO8601 format. Format: date-time |
direction | string | Required within parent | The direction of the reimbursement. It could be either BUSINESS_TO_USER or USER_TO_BUSINESS. Known values: BUSINESS_TO_USER, USER_TO_BUSINESS |
distance | JSON | Required within parent | |
distance (anyOf 1) | JSON | Alternative | |
distance (anyOf 1) (anyOf 1) | number | Alternative | The distance of the reimbursement in miles, for mileage reimbursements. |
distance (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
distance (anyOf 2) | null | Alternative | |
employee_id | JSON | Required within parent | |
employee_id (anyOf 1) | string | Alternative | Employee ID of the person who made the reimbursement. |
employee_id (anyOf 2) | null | Alternative | |
end_location | JSON | Required within parent | |
end_location (anyOf 1) | string | Alternative | Ending location of the trip, for mileage reimbursements. |
end_location (anyOf 2) | null | Alternative | |
entity_amount | JSON | Required within parent | |
entity_amount (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
entity_id | JSON | Required within parent | |
entity_id (anyOf 1) | string | Alternative | Unique identifier of the associated business entity. Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
fund_id | JSON | Required within parent | |
fund_id (anyOf 1) | string | Alternative | The Fund to which the reimbursement is attributed, if it exists. Format: uuid Read only: true |
fund_id (anyOf 2) | null | Alternative | |
funding_source | JSON | Optional | |
funding_source (anyOf 1) | string | Alternative | Funding 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) | null | Alternative | |
id | string | Required within parent | Unique identifier of the reimbursement. Format: uuid |
line_items | array | Required within parent | List of line items related to the reimbursement. |
line_items[] | Model | Each item | Expand Fetch a reimbursement — response body — line items item |
memo | JSON | Required within parent | |
memo (anyOf 1) | string | Alternative | Reimbursement memo |
memo (anyOf 2) | null | Alternative | |
merchant | JSON | Required within parent | |
merchant (anyOf 1) | string | Alternative | The name of the merchant that the reimbursement is associated with. |
merchant (anyOf 2) | null | Alternative | |
merchant_amount | JSON | Required within parent | |
merchant_amount (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
merchant_id | JSON | Required within parent | |
merchant_id (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
payee_amount | JSON | Required within parent | |
payee_amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount Amount and currency received by the payee. |
payee_amount (anyOf 2) | null | Alternative | |
payment_batch_id | JSON | Required within parent | |
payment_batch_id (anyOf 1) | string | Alternative | The unique identifier of the reimbursement payment batch that the reimbursement is associated with. Format: uuid |
payment_batch_id (anyOf 2) | null | Alternative | |
payment_id | JSON | Required within parent | |
payment_id (anyOf 1) | string | Alternative | The unique identifier of the payment batch that the reimbursement is associated with, once paid. |
payment_id (anyOf 2) | null | Alternative | |
payment_processed_at | JSON | Required within parent | |
payment_processed_at (anyOf 1) | string | Alternative | Time of reimbursement payment. Presented in ISO8601 format. Format: date-time |
payment_processed_at (anyOf 2) | null | Alternative | |
receipts | array | Required within parent | Read only: true |
receipts[] | string | Each item | Format: uuid |
spend_limit_id | JSON | Required within parent | |
spend_limit_id (anyOf 1) | string | Alternative | Alias 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) | null | Alternative | |
start_location | JSON | Required within parent | |
start_location (anyOf 1) | string | Alternative | Starting location of the trip, for mileage reimbursements. |
start_location (anyOf 2) | null | Alternative | |
state | string | Required within parent | current 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_at | JSON | Required within parent | |
submitted_at (anyOf 1) | string | Alternative | Time when reimbursement was most recently submitted Format: date-time |
submitted_at (anyOf 2) | null | Alternative | |
sync_status | string | Required within parent | Current sync status of the reimbursement. Known values: NOT_SYNC_READY, SYNCED, SYNC_READY Read only: true |
synced_at | JSON | Required within parent | |
synced_at (anyOf 1) | string | Alternative | Time when reimbursement has been synced. Will be None if the reimbursement is not synced. Format: date-time |
synced_at (anyOf 2) | null | Alternative | |
trace_id | Model | Optional | Expand 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_date | JSON | Required within parent | |
transaction_date (anyOf 1) | string | Alternative | Format: date |
transaction_date (anyOf 2) | null | Alternative | |
trip_id | JSON | Required within parent | |
trip_id (anyOf 1) | string | Alternative | Trip ID associated with the reimbursement if a Trip ID is available. Format: uuid |
trip_id (anyOf 2) | null | Alternative | |
type | string | Required within parent | The type of the reimbursement. Known values: MILEAGE, OUT_OF_POCKET, PAYBACK_FULL, PAYBACK_PARTIAL, PER_DIEM |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Time at which the reimbursement was last updated. Presented in ISO8601 format. Format: date-time |
updated_at (anyOf 2) | null | Alternative | |
user_email | string | Required within parent | Email of the person who made the reimbursement. |
user_full_name | string | Required within parent | Full name of the person who made the reimbursement. |
user_id | string | Required within parent | Unique identifier of the person who made the reimbursement. Format: uuid |
vehicle_mileage_class | JSON | Required within parent | |
vehicle_mileage_class (anyOf 1) | string | Alternative | Vehicle 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) | null | Alternative | |
waypoints | array | Required within parent | List of intermediate stops during the trip, for mileage reimbursements. |
waypoints[] | string | Each 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category_info | JSON | Required within parent | |
category_info (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Customer-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) | null | Alternative | |
external_code | JSON | Required within parent | |
external_code (anyOf 1) | string | Alternative | External code displayed in the ERP for this option. |
external_code (anyOf 2) | null | Alternative | |
external_id | JSON | Required within parent | |
external_id (anyOf 1) | string | Alternative | External ID that uniquely identifies this option in the ERP. |
external_id (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Unique identifier for this option within Ramp. |
id (anyOf 2) | null | Alternative | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Name of the accounting field option. |
name (anyOf 2) | null | Alternative | |
provider_name | JSON | Required within parent | |
provider_name (anyOf 1) | string | Alternative | Name of accounting field provider Read only: true |
provider_name (anyOf 2) | null | Alternative | |
source | JSON | Required within parent | |
source (anyOf 1) | Model | Alternative | Expand Fetch a transaction — response body — accounting field selections item source Source of this accounting coding selection. |
source (anyOf 2) | null | Alternative | |
type | JSON | Required within parent | |
type (anyOf 1) | string | Alternative | Type 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | JSON | Required within parent | |
external_id (anyOf 1) | string | Alternative | External ID that uniquely identifies this field in the ERP. |
external_id (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Unique identifier for this accounting field within Ramp. |
id (anyOf 2) | null | Alternative | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Name of the accounting field. |
name (anyOf 2) | null | Alternative | |
type | JSON | Required within parent | |
type (anyOf 1) | string | Alternative | Type 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) | null | Alternative |
Fetch a reimbursement — response body — entity amount currency, minor unit conversion rate, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Required within parent | The 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_rate | JSON | Required within parent | |
minor_unit_conversion_rate (anyOf 1) | JSON | Alternative | |
minor_unit_conversion_rate (anyOf 1) (anyOf 1) | integer | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minor_unit_conversion_rate (anyOf 2) | null | Alternative | |
value | JSON | Required within parent | |
value (anyOf 1) | integer | Alternative | The non-negative amount in the smallest denomination of the currency (e.g. cents for USD). Minimum: 0 |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Fetch a reimbursement — response body — line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Required within parent | Accounting field selections used to code this line item. |
accounting_field_selections[] | Model | Each item | Expand Fetch a reimbursement — response body — accounting field selections item |
amount | JSON | Required within parent | |
amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount Amount of the line item. |
amount (anyOf 2) | null | Alternative | |
memo | JSON | Required within parent | |
memo (anyOf 1) | string | Alternative | Memo text for this line item. |
memo (anyOf 2) | null | Alternative |
Referenced models: Fetch a reimbursement — response body — accounting field selections item, Hold Bill — response body — amount
Fetch a reimbursement — response body — trace id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
descriptor | JSON | Required within parent | |
descriptor (anyOf 1) | string | Alternative | Human-readable description of the bank reference. For example, 'Trace ID', 'IMAD number', or 'Reference number'. Default: null |
descriptor (anyOf 2) | null | Alternative | |
trace_id | JSON | Required within parent | |
trace_id (anyOf 1) | string | Alternative | The bank-facing accountability reference for the reimbursement payment. Default: null |
trace_id (anyOf 2) | null | Alternative |
List reimbursements — 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 Fetch a reimbursement — 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, Fetch a reimbursement — response body