API Reference ramp v#1.0.0

Copy Markdown View Source

Modules

A production-grade Elixir client for the Ramp Developer API (v1).

The Accounting resource: ERP connections, general ledger accounts, custom accounting dimensions ("fields") and their selectable options, and reporting sync status back to Ramp.

An ERP accounting integration (e.g. QuickBooks, NetSuite, Xero).

A dimension on which transactions/bills can be categorized.

A selectable value for a CustomField.

A general ledger account used for accounting classification.

A selected accounting dimension value attached to a syncable object.

A physical mailing address.

The Audit Logs resource: read-only access to the audit event log for the business.

A single audit log entry.

The Bills (accounts payable) resource: creating, listing, updating, and voiding bills owed to vendors.

An obligation to pay a vendor.

A line item within a Bill.

The Business resource: read-only details about the top-level Ramp business account associated with the client's credentials.

The top-level Ramp business account.

The Cards resource: issuing, listing, updating, suspending, and terminating Ramp cards.

A Ramp virtual or physical card.

The Cashbacks resource: read-only access to monthly cashback rewards.

A monthly cashback reward.

Holds the resolved configuration for talking to the Ramp API: base URL, HTTP/retry tuning, telemetry prefix, and the pid/name of the Ramp.TokenManager that supplies bearer tokens.

A reference to an asynchronous deferred task submitted to the Ramp API (e.g. card issuance, user creation, limit creation).

The Departments resource: full CRUD on organizational departments.

An organizational department.

The Entities resource: read-only access to the legal business entities under a Ramp account (relevant for multi-entity businesses).

A legal business entity under a Ramp account.

The structured exception raised/returned by every Ramp operation.

The low-level HTTP transport shared by every resource module.

Small decoding helpers shared by every resource module.

The Limits resource (spend controls): creating, listing, updating, and terminating spend limits.

The financial breakdown of a Limit.

A Ramp spend control.

Merchant category / vendor / per-transaction constraints on a Limit.

The Locations resource: full CRUD on physical/logical office locations.

A physical or logical office location.

The Merchants resource: read-only access to card-network merchants where Ramp transactions occur.

A card-network merchant.

A monetary amount, represented as an integer number of minor units (cents) plus an ISO-4217 currency code -- exactly as the Ramp API returns it, with no float rounding surprises.

A single page of results from a Ramp list endpoint, returned by resource modules' list_page/2 functions for callers who want manual control over pagination instead of the lazy auto-paginating Ramp.Pagination.stream/4 (used internally by list/2).

Builds lazy, auto-paginating Streams over Ramp's cursor-paginated list endpoints.

A policy rule that was violated on a transaction.

Polls Ramp's deferred-task status endpoint until a task submitted by an asynchronous write (card issuance, user invite, limit creation, etc.) finishes, using capped exponential backoff between checks.

The Reimbursements resource: read-only access to out-of-pocket employee expense reimbursements.

An out-of-pocket expense submitted for reimbursement.

The Spend Programs resource: read-only access to spend program templates applied to card limits.

A template applied to card limits.

The Statements resource: read-only access to monthly billing statements.

A monthly billing statement.

A GenServer that manages OAuth2 client_credentials tokens for a Ramp client: it fetches, caches, and transparently refreshes the access token before it expires.

The Transactions resource: listing, retrieving, and updating (memo, accounting fields, policy feedback) card transactions.

A receipt document attached to a transaction.

A Ramp card transaction.

The Users resource: inviting, listing, updating, deactivating, and reactivating Ramp platform users.

A Ramp platform user.

The Vendors resource: read-only access to accounts-payable vendors used in bill payments.

An accounts-payable vendor.

The Webhooks resource: registering, listing, updating, and deleting webhook endpoint subscriptions.

A registered webhook endpoint.

Verifies Ramp webhook signatures and decodes webhook payloads into Ramp.Webhooks.Event structs.

A decoded, verified Ramp webhook event.

A tiny, framework-agnostic builder for registering callbacks per webhook event type and dispatching a verified delivery to the right one -- equivalent to the Go SDK's webhooks.Handler.