Skip to content

Rippling: Retrieve a specific reimbursement

Rippling restApi.getReimbursements: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.get_reimbursements

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

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

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["getReimbursements"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.restApi.getReimbursements(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.rest_api.get_reimbursements(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parentFormat: id
queryobjectOptionalAdditional keys: not allowed
query.expandstringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
__metaobjectOptional
__meta.redacted_fieldsarrayOptional
__meta.redacted_fields[]ModelEach itemExpand Retrieve a report run — response body — meta redacted fields item
accounting_datestringOptionalDate the transaction is booked in the accounting system, as an ISO 8601 date (YYYY-MM-DD).
approval_statusstringOptionalApproval status of the transaction. `DRAFT`: not submitted for approval. `PENDING`: awaiting required information or submission before approval. `REQUESTED`: submitted and awaiting approval. `APPROVED`: approved. `REJECTED`: rejected. `FINALIZED`: finalized for payment. `ACTIONED`: payment or reimbursement completed. `CANCELLED`: cancelled. `FAILED`: payment failed. Null for card authorizations.
Known values: DRAFT, PENDING, REQUESTED, APPROVED, REJECTED, FINALIZED, ACTIONED, CANCELLED, FAILED
attachmentsarrayOptionalOther attached files, including filenames and recorded upload metadata.
attachments[]ModelEach itemExpand Retrieve a specific bill — response body — attachments item
company_amountobjectOptionalAmount in the company’s headquarters currency. The `value` is a decimal string.
company_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
company_amount.valueJSONOptional
company_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
company_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
distanceJSONOptional
distance (anyOf 1)numberAlternativeTrip length in mileage_rate.units. Null except on mileage reimbursements.
distance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
end_locationModelOptionalExpand Retrieve a specific reimbursement — response body — end location
entity_idstringOptionalID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`.
gl_sync_statestringOptionalState of the sync to the accounting system. `NOT_FINALIZED`: not ready for accounting review. `FOR_REVIEW`: ready for accounting review. `PENDING_SYNC`: sync is in progress. `SYNCED`: synced to the accounting system. `ERROR`: sync failed. `DO_NOT_SYNC`: marked to be excluded from sync. `EXPORTED`: exported for accounting. `NOT_SYNCABLE`: this record cannot be synced. `AUTO_SYNC`: ready to be synced automatically. Null when no sync state is set.
Known values: NOT_FINALIZED, FOR_REVIEW, PENDING_SYNC, SYNCED, ERROR, DO_NOT_SYNC, EXPORTED, NOT_SYNCABLE, AUTO_SYNC
gl_vendorobjectOptionalVendor in the connected accounting system.
gl_vendor.gl_vendor_idstringOptionalID of the vendor in the accounting system.
gl_vendor.idstringOptionalID of the accounting vendor in Rippling.
gl_vendor.namestringOptionalName of the vendor in the accounting system.
idstringRequired within parentIdentifier field
line_itemsarrayOptionalCategory splits of the transaction amount.
line_items[]ModelEach itemExpand Retrieve a specific bill — response body — line items item
memostringOptionalMemo entered on the transaction.
merchant_amountobjectOptionalAmount charged by the merchant, in the merchant currency. The `value` is a decimal string.
merchant_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
merchant_amount.valueJSONOptional
merchant_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
merchant_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
mileage_rateModelOptionalExpand Retrieve a specific reimbursement — response body — mileage rate
mileage_rate_idstringOptionalID of the company mileage rate. Null except on mileage reimbursements. Resolve it with `expand=mileage_rate` on this reimbursement using `reimbursements.read`; there is no standalone rate lookup endpoint.
payout_amountobjectOptionalAmount credited to the worker. The `value` is a decimal string.
payout_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
payout_amount.valueJSONOptional
payout_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
payout_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
payout_datestringOptionalDate the worker is paid, as an ISO 8601 date (YYYY-MM-DD). Null before a run is assigned.
payout_methodstringOptionalHow the worker is paid. `NOT_SET`: no payout run is assigned. `US_PAYROLL`: assigned to a US payroll run. `GLOBAL_PAYROLL`: assigned to a global payroll run. `DIRECT_DEPOSIT`: assigned to a direct deposit run. `EOR`: assigned to an employer-of-record payroll run. `MANUAL`: marked paid outside a run. If a payout method override is set, it is returned.
Known values: NOT_SET, GLOBAL_PAYROLL, US_PAYROLL, DIRECT_DEPOSIT, EOR, MANUAL
per_diem_line_itemsarrayOptionalPer diem sub-rate rows. Null except on per diem reimbursements.
per_diem_line_items[]ModelEach itemExpand Retrieve a specific reimbursement — response body — per diem line items item
per_diem_rateModelOptionalExpand Retrieve a specific reimbursement — response body — per diem rate
per_diem_rate_idstringOptionalID of the per diem rate. Null except on per diem reimbursements. Resolve it with `expand=per_diem_rate` on this reimbursement using `reimbursements.read`; there is no standalone rate lookup endpoint.
receiptobjectOptionalReceipt file and its filename.
receipt.file_namestringOptionalOriginal file name, when recorded.
receipt.urlstringRequired within parentURL for accessing the file.
start_locationModelOptionalExpand Retrieve a specific reimbursement — response body — start location
transaction_datestringOptionalWhen the purchase or authorization happened, as an ISO 8601 date-time in UTC.
transaction_typestringOptional`REIMBURSEMENT`: an expense the worker paid and the company pays back. `MILEAGE_REIMBURSEMENT`: payback for distance driven. `PER_DIEM_REIMBURSEMENT`: payback for a daily travel allowance. This decides which mileage or per diem fields are set.
Known values: REIMBURSEMENT, MILEAGE_REIMBURSEMENT, PER_DIEM_REIMBURSEMENT
trip_end_datestringOptionalPer diem trip end date, as an ISO 8601 date (YYYY-MM-DD). Null except on per diem reimbursements.
trip_start_datestringOptionalPer diem trip start date, as an ISO 8601 date (YYYY-MM-DD). Null except on per diem reimbursements.
updated_atstringRequired within parentRecord update date
vendorModelOptionalExpand Retrieve a specific reimbursement — response body — vendor
vendor_idstringOptionalID of the Finance vendor. Use it with `/finance-vendors/{id}/`.
waypointsarrayOptionalList of intermediate stops during the trip, for mileage reimbursements. Null except on mileage reimbursements.
waypoints[]ModelEach itemExpand Retrieve a specific reimbursement — response body — waypoints item
workerModelOptionalExpand Retrieve a specific reimbursement — response body — worker
worker_idstringOptionalID of the worker who made the transaction. Use it with `/workers/{id}/`.

Referenced models: Retrieve a specific bill — response body — line items item, Retrieve a specific reimbursement — response body — waypoints item, Retrieve a specific reimbursement — response body — per diem line items item, Retrieve a report run — response body — meta redacted fields item, Retrieve a specific bill — response body — attachments item, Retrieve a specific reimbursement — response body — end location, Retrieve a specific reimbursement — response body — mileage rate, Retrieve a specific reimbursement — response body — per diem rate, Retrieve a specific reimbursement — response body — start location, Retrieve a specific reimbursement — response body — vendor, Retrieve a specific reimbursement — response body — worker

35 more schemas are linked from the tables above, on the schema pages.

Retrieve a specific bill — response body — line items item
FieldTypePresenceDescription and constraints
$objectRoot
amortizedbooleanOptionalWhether this line is amortized.
amountobjectOptionalAmount of this split, in the merchant currency. The `value` is a decimal string.
amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
amount.valueJSONOptional
amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
category_idstringOptionalID of the Finance category assigned to this split. No public API is currently available to retrieve this category; its name is in `category_name`.
category_namestringOptionalName of the finance category.
dimension_choicesobjectOptionalSelected dimension values, keyed by dimension ID. Includes department and work location.
Additional keys: see wildcard field
dimension_choices.*ModelAdditional keysExpand Retrieve a specific bill — response body — line items item dimension choices value
end_datestringOptionalEnd of the amortization period (YYYY-MM-DD).
gl_amortization_scheduleobjectOptionalERP amortization schedule associated with this line.
gl_amortization_schedule.accounting_integration_idstringOptionalRippling ID of the accounting integration that owns this object.
gl_amortization_schedule.amortization_periodJSONOptional
gl_amortization_schedule.amortization_period (anyOf 1)integerAlternativeNumber of amortization periods.
gl_amortization_schedule.amortization_period (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
gl_amortization_schedule.end_datestringOptionalEnd of the ERP amortization schedule as an ISO 8601 timestamp (for example, 2026-12-31T00:00:00). May omit a timezone offset; an omitted offset does not indicate UTC. Null when not set.
gl_amortization_schedule.gl_object_idstringOptionalObject ID in the connected accounting system.
gl_amortization_schedule.gl_object_typestringOptionalType of object in the connected accounting system: GL_AMORTIZATION_TEMPLATE defines amortization rules; GL_AMORTIZATION_SCHEDULE tracks amortization; GL_AMORTIZATION_SCHEDULE_RECURRENCE is a schedule entry; GL_ACCOUNT is a general ledger account; GL_JOURNAL_ENTRY is a journal entry; GL_POSTING_PERIOD is an accounting period; GL_VENDOR, GL_CUSTOMER, and GL_EMPLOYEE identify a vendor, customer, and employee respectively; GL_SUBSIDIARY identifies a subsidiary. Null when not set.
Known values: GL_AMORTIZATION_TEMPLATE, GL_AMORTIZATION_SCHEDULE, GL_AMORTIZATION_SCHEDULE_RECURRENCE, GL_ACCOUNT, GL_JOURNAL_ENTRY, GL_POSTING_PERIOD, GL_VENDOR, GL_CUSTOMER, GL_EMPLOYEE, GL_SUBSIDIARY
gl_amortization_schedule.namestringOptionalAccounting object name.
gl_amortization_schedule.start_datestringOptionalStart of the ERP amortization schedule as an ISO 8601 timestamp (for example, 2026-01-01T00:00:00). May omit a timezone offset; an omitted offset does not indicate UTC. Null when not set.
gl_amortization_schedule.statusstringOptionalERP amortization schedule status: NOT_STARTED means amortization has not begun; IN_PROGRESS means amortization is underway; COMPLETED means amortization is complete; ON_HOLD means amortization is paused. Null when not set.
Known values: NOT_STARTED, IN_PROGRESS, COMPLETED, ON_HOLD
gl_amortization_schedule.total_amortized_amountJSONOptional
gl_amortization_schedule.total_amortized_amount (anyOf 1)numberAlternativeAmount already amortized as reported by the ERP, in the same currency as total_amount. No currency conversion is applied; the schedule currency code is not available in this response.
gl_amortization_schedule.total_amortized_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
gl_amortization_schedule.total_amountJSONOptional
gl_amortization_schedule.total_amount (anyOf 1)numberAlternativeTotal schedule amount as reported by the ERP, without currency conversion. The schedule currency code is not available in this response.
gl_amortization_schedule.total_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
gl_amortization_templateobjectOptionalERP amortization template for this line.
gl_amortization_template.accounting_integration_idstringOptionalRippling ID of the accounting integration that owns this object.
gl_amortization_template.gl_object_idstringOptionalObject ID in the connected accounting system.
gl_amortization_template.gl_object_typestringOptionalType of object in the connected accounting system: GL_AMORTIZATION_TEMPLATE defines amortization rules; GL_AMORTIZATION_SCHEDULE tracks amortization; GL_AMORTIZATION_SCHEDULE_RECURRENCE is a schedule entry; GL_ACCOUNT is a general ledger account; GL_JOURNAL_ENTRY is a journal entry; GL_POSTING_PERIOD is an accounting period; GL_VENDOR, GL_CUSTOMER, and GL_EMPLOYEE identify a vendor, customer, and employee respectively; GL_SUBSIDIARY identifies a subsidiary. Null when not set.
Known values: GL_AMORTIZATION_TEMPLATE, GL_AMORTIZATION_SCHEDULE, GL_AMORTIZATION_SCHEDULE_RECURRENCE, GL_ACCOUNT, GL_JOURNAL_ENTRY, GL_POSTING_PERIOD, GL_VENDOR, GL_CUSTOMER, GL_EMPLOYEE, GL_SUBSIDIARY
gl_amortization_template.namestringOptionalAccounting object name.
gl_billablestringOptionalWhether this split is billed to `gl_customer` in the accounting system. `BILLABLE` means it is billed, `NOT_BILLABLE` means it is not. Null when not set.
Known values: BILLABLE, NOT_BILLABLE
gl_customerstringOptionalID of the customer record in the connected accounting integration. No public Rippling API is currently available to retrieve this accounting customer.
gl_tax_codestringOptionalRippling ID of the accounting tax code.
idstringOptionalUnique identifier of this line item. Null for older line items that have not been assigned one yet.
memostringOptionalMemo entered on this split.
prepaid_accountobjectOptionalPrepaid asset account for Rippling-managed amortization.
prepaid_account.account_idstringOptionalAccount ID in the connected accounting system.
prepaid_account.codestringOptionalAccount code.
prepaid_account.namestringOptionalAccount name.
prepaid_account.required_custom_dimensionsarrayOptionalIDs of custom dimensions required by this account.
prepaid_account.required_custom_dimensions[]stringEach item
prepaid_account.requires_departmentbooleanOptionalWhether this account requires a department.
prepaid_account.requires_work_locationbooleanOptionalWhether this account requires a work location.
prepaid_account.typestringOptionalAccounting account type: RECEIVABLE for accounts receivable, PAYABLE for accounts payable, EXPENSE for expense accounts, or BANK for bank accounts. Null when not set.
Known values: RECEIVABLE, PAYABLE, EXPENSE, BANK
start_datestringOptionalStart of the amortization period (YYYY-MM-DD).
tax_amountobjectOptionalTotal tax amount for this line in the merchant currency.
tax_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
tax_amount.valueJSONOptional
tax_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
tax_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a specific bill — response body — line items item dimension choices value

Retrieve a specific reimbursement — response body — waypoints item
FieldTypePresenceDescription and constraints
$objectRootStart, end, or intermediate stop on a mileage trip.
addressstringOptionalAddress of this point. Null when the point has no address.
coordinatesModelOptionalExpand Retrieve a specific reimbursement — response body — end location coordinates

Referenced models: Retrieve a specific reimbursement — response body — end location coordinates

Retrieve a specific reimbursement — response body — per diem line items item
FieldTypePresenceDescription and constraints
$objectRoot
amountobjectOptionalSub-rate amount for one unit. The `value` is a decimal string.
amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
amount.valueJSONOptional
amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
calculated_amountobjectOptionalamount times count. The `value` is a decimal string. Negative when line_type is EXCLUDE.
calculated_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
calculated_amount.valueJSONOptional
calculated_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
calculated_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
countJSONOptional
count (anyOf 1)integerAlternativeHow many units.
count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
labelstringOptionalSub-rate label.
line_typestringOptional`INCLUDE`: this row is added to the reimbursement. `EXCLUDE`: this row is subtracted. `calculated_amount.value` is negative when excluded.
Known values: INCLUDE, EXCLUDE
sub_rate_idstringOptionalPer diem sub-rate ID.
sub_rate_typestringOptional`FULL_DAY`: the full daily allowance. `MEALS`: the meals portion of the daily allowance. `OTHERS`: an allowance that is not the full day or meals.
Known values: FULL_DAY, MEALS, OTHERS
Retrieve a report run — response body — meta redacted fields item
FieldTypePresenceDescription and constraints
$objectRootInfo about the redacted fields.
namestringOptionalThe name for the redacted field
reasonstringOptionalThe reason for the redaction

SDK function policy ID: rippling.rest_api.get_reimbursements. Catalog operation: get-reimbursements. 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"]

Provider entitlements: ["Spend_Management_Platform_API"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

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.