Ramp: Fetch a statement
Ramp statement.getStatementResource: arguments, response, policy and SDK examples.
← Statement operations · Get started
Operation ramp.get_statement_resource
Provider route: GET /developer/v1/statements/{statement_id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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["statement"]["getStatementResource"]>[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.statement.getStatementResource(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.statement.get_statement_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.statement_id | string | Required within parent |
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 |
|---|---|---|---|
$ | Model | Root | Expand Fetch a statement — response body |
Referenced models: Fetch a statement — response body
Schemas
Section titled “Schemas”Fetch a statement — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
balance_sections | array | Required within parent | Breakdown of statement balances by entity and currency. |
balance_sections[] | Model | Each item | Expand Fetch a statement — response body — balance sections item |
charges | Model | Required within parent | Expand Hold Bill — response body — amount Total charges incurred during the statement period |
credits | Model | Required within parent | Expand Hold Bill — response body — amount Total credits accumulated during the statement period |
end_date | string | Required within parent | End date of the statement period. Format: date-time |
ending_balance | Model | Required within parent | Expand Hold Bill — response body — amount Balance at the end of the statement period |
id | string | Required within parent | Unique identifier for the statement. Format: uuid |
opening_balance | Model | Required within parent | Expand Hold Bill — response body — amount Balance at the beginning of the statement period |
payments | Model | Required within parent | Expand Hold Bill — response body — amount Total payments made during the statement period |
preceding_statement_id | string | Optional | Identifier of the previous statement in sequence. Format: uuid |
start_date | string | Required within parent | Start date of the statement period. Format: date-time |
statement_lines | array | Required within parent | Financial activities including card transactions, transfers, and cashbacks during the statement period. |
statement_lines[] | Model | Each item | Expand Fetch a statement — response body — statement lines item |
statement_url | string | Optional | Pre-signed URL to download statement PDF, valid for 1 hour after generation. Format: url |
Referenced models: Fetch a statement — response body — statement lines item, Hold Bill — response body — amount, Fetch a statement — response body — balance sections item
Fetch a statement — response body — statement lines item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cleared_at | JSON | Optional | |
cleared_at (anyOf 1) | string | Alternative | Time when transaction was cleared. Only present for transactions and may be null if not cleared. Format: date-time |
cleared_at (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | For transactions: time when card was swiped. For transfers/cashbacks: creation time. Format: date-time |
id | string | Optional | Unique identifier for the statement line item. Format: uuid |
type | string | Optional | Type of statement line item (CARD_TRANSACTION, TRANSFER_PAYMENT, or CASHBACK). Known values: CARD_TRANSACTION, CASHBACK, TRANSFER_PAYMENT |
Hold Bill — response body — amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | the 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency_code | string | Required within parent | The type of currency, in ISO 4217 format. e.g. USD for US dollars Default: USD |
minor_unit_conversion_rate | JSON | Required within parent | |
minor_unit_conversion_rate (anyOf 1) | JSON | Alternative | |
minor_unit_conversion_rate (anyOf 1) (anyOf 1) | integer | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minor_unit_conversion_rate (anyOf 2) | null | Alternative |
Fetch a statement — response body — balance sections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
charges | Model | Required within parent | Expand Hold Bill — response body — amount Total charges incurred during the statement period. |
credits | Model | Required within parent | Expand Hold Bill — response body — amount Total credits accumulated during the statement period. |
ending_balance | Model | Required within parent | Expand Hold Bill — response body — amount Balance at the end of the statement period. |
entity_id | string | Required within parent | Business entity this balance section belongs to. Format: uuid |
id | string | Required within parent | Unique identifier for the balance section. Format: uuid |
opening_balance | Model | Required within parent | Expand Hold Bill — response body — amount Balance at the beginning of the statement period. |
payments | Model | Required within parent | Expand Hold Bill — response body — amount Total payments made during the statement period. |
Referenced models: Hold Bill — response body — amount
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_statement_resource. Catalog operation: get_statement_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: ["statements:read"]