Skip to content

Ramp: Fetch a reimbursement

Ramp reimbursement.getReimbursementResource: arguments, response, policy and SDK examples.

← Reimbursement operations · Get started

Operation ramp.get_reimbursement_resource

Provider route: GET /developer/v1/reimbursements/{reimbursement_id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["reimbursement"]["getReimbursementResource"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.reimbursement.getReimbursementResource(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_ramp import RampIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.reimbursement.get_reimbursement_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.reimbursement_idstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Fetch a reimbursement — response body

Referenced models: Fetch a reimbursement — response body

1 more schema is linked from the tables above, on the schema pages.

Fetch a transaction — response body — attendees item
FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentFull name of the attendee
user_idJSONRequired within parent
user_id (anyOf 1)stringAlternativeUser ID of the attendee, if linked to a Ramp user. Missing if the attendee is not a Ramp user
Format: uuid
user_id (anyOf 2)nullAlternative
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
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 — 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

Hold Bill — response body — amount
FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)integerAlternativethe amount of money represented in the smallest denomination of the currency. For example, when the currency is USD, then the amount is expressed in cents.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency_codestringRequired within parentThe type of currency, in ISO 4217 format. e.g. USD for US dollars
Default: USD
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 amount 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
Fetch a transaction — response body — accounting field selections item source
FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalDescribes the type of source that added this selection.
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

SDK function policy ID: ramp.get_reimbursement_resource. Catalog operation: get_reimbursement_resource. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["reimbursements:read"]

Official provider source

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.