Ramp: Fetch a reimbursement — response body
Fetch a reimbursement: response body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: 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 |
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