Rippling: List reimbursements
Rippling restApi.listReimbursements: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.list_reimbursements
Provider route: GET /reimbursements/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["listReimbursements"]>[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.listReimbursements(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.list_reimbursements(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.filter | string | Optional | |
query.expand | string | Optional | |
query.order_by | string | Optional | |
query.limit | integer | Optional | Default: 50 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
__meta | Model | Optional | Expand List Sites — response body — meta |
next_link | string | Optional | A link to the next page of responses. Format: uri |
results | array | Optional | |
results[] | Model | Each item | Expand List reimbursements — response body — results item |
Referenced models: List reimbursements — response body — results item, List Sites — response body — meta
Schemas
Section titled “Schemas”37 more schemas are linked from the tables above, on the schema pages.
List reimbursements — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Finance reimbursement the caller can see. A reimbursement is an expense the worker paid and the company pays back. Mileage and per diem use the same resource, with transaction_type MILEAGE_REIMBURSEMENT or PER_DIEM_REIMBURSEMENT. Retrieve returns one by ID. A reimbursement the caller cannot see returns 404, the same as one that does not exist. |
accounting_date | string | Optional | Date the transaction is booked in the accounting system, as an ISO 8601 date (YYYY-MM-DD). |
approval_status | string | Optional | Approval 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 |
attachments | array | Optional | Other attached files, including filenames and recorded upload metadata. |
attachments[] | Model | Each item | Expand Retrieve a specific bill — response body — attachments item |
company_amount | object | Optional | Amount in the company's headquarters currency. The `value` is a decimal string. |
company_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
company_amount.value | JSON | Optional | |
company_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
company_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
distance | JSON | Optional | |
distance (anyOf 1) | number | Alternative | Trip length in mileage_rate.units. Null except on mileage reimbursements. |
distance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
end_location | Model | Optional | Expand Retrieve a specific reimbursement — response body — end location |
entity_id | string | Optional | ID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`. |
gl_sync_state | string | Optional | State 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_vendor | object | Optional | Vendor in the connected accounting system. |
gl_vendor.gl_vendor_id | string | Optional | ID of the vendor in the accounting system. |
gl_vendor.id | string | Optional | ID of the accounting vendor in Rippling. |
gl_vendor.name | string | Optional | Name of the vendor in the accounting system. |
id | string | Required within parent | Identifier field |
line_items | array | Optional | Category splits of the transaction amount. |
line_items[] | Model | Each item | Expand Retrieve a specific bill — response body — line items item |
memo | string | Optional | Memo entered on the transaction. |
merchant_amount | object | Optional | Amount charged by the merchant, in the merchant currency. The `value` is a decimal string. |
merchant_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
merchant_amount.value | JSON | Optional | |
merchant_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
merchant_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
mileage_rate | Model | Optional | Expand Retrieve a specific reimbursement — response body — mileage rate |
mileage_rate_id | string | Optional | ID 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_amount | object | Optional | Amount credited to the worker. The `value` is a decimal string. |
payout_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
payout_amount.value | JSON | Optional | |
payout_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
payout_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payout_date | string | Optional | Date the worker is paid, as an ISO 8601 date (YYYY-MM-DD). Null before a run is assigned. |
payout_method | string | Optional | How 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_items | array | Optional | Per diem sub-rate rows. Null except on per diem reimbursements. |
per_diem_line_items[] | Model | Each item | Expand Retrieve a specific reimbursement — response body — per diem line items item |
per_diem_rate | Model | Optional | Expand Retrieve a specific reimbursement — response body — per diem rate |
per_diem_rate_id | string | Optional | ID 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. |
receipt | object | Optional | Receipt file and its filename. |
receipt.file_name | string | Optional | Original file name, when recorded. |
receipt.url | string | Required within parent | URL for accessing the file. |
start_location | Model | Optional | Expand Retrieve a specific reimbursement — response body — start location |
transaction_date | string | Optional | When the purchase or authorization happened, as an ISO 8601 date-time in UTC. |
transaction_type | string | Optional | `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_date | string | Optional | Per diem trip end date, as an ISO 8601 date (YYYY-MM-DD). Null except on per diem reimbursements. |
trip_start_date | string | Optional | Per diem trip start date, as an ISO 8601 date (YYYY-MM-DD). Null except on per diem reimbursements. |
updated_at | string | Required within parent | Record update date |
vendor | Model | Optional | Expand Retrieve a specific reimbursement — response body — vendor |
vendor_id | string | Optional | ID of the Finance vendor. Use it with `/finance-vendors/{id}/`. |
waypoints | array | Optional | List of intermediate stops during the trip, for mileage reimbursements. Null except on mileage reimbursements. |
waypoints[] | Model | Each item | Expand Retrieve a specific reimbursement — response body — waypoints item |
worker | Model | Optional | Expand Retrieve a specific reimbursement — response body — worker |
worker_id | string | Optional | ID 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 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
List Sites — response body — meta
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of redacted fields. |
redacted_fields | array | Optional | |
redacted_fields[] | object | Each item | |
redacted_fields[].name | string | Optional | The name for the redacted field |
redacted_fields[].reason | string | Optional | The reason for the redaction |
Retrieve a specific reimbursement — response body — waypoints item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Start, end, or intermediate stop on a mileage trip. |
address | string | Optional | Address of this point. Null when the point has no address. |
coordinates | Model | Optional | Expand Retrieve a specific reimbursement — response body — end location coordinates |
Referenced models: Retrieve a specific reimbursement — response body — end location coordinates
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.list_reimbursements. Catalog operation: list-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"}