Skip to content

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.

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 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.statement.get_statement_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.statement_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 statement — response body

Referenced models: Fetch a statement — response body

Fetch a statement — response body
FieldTypePresenceDescription and constraints
$objectRoot
balance_sectionsarrayRequired within parentBreakdown of statement balances by entity and currency.
balance_sections[]ModelEach itemExpand Fetch a statement — response body — balance sections item
chargesModelRequired within parentExpand Hold Bill — response body — amount
Total charges incurred during the statement period
creditsModelRequired within parentExpand Hold Bill — response body — amount
Total credits accumulated during the statement period
end_datestringRequired within parentEnd date of the statement period.
Format: date-time
ending_balanceModelRequired within parentExpand Hold Bill — response body — amount
Balance at the end of the statement period
idstringRequired within parentUnique identifier for the statement.
Format: uuid
opening_balanceModelRequired within parentExpand Hold Bill — response body — amount
Balance at the beginning of the statement period
paymentsModelRequired within parentExpand Hold Bill — response body — amount
Total payments made during the statement period
preceding_statement_idstringOptionalIdentifier of the previous statement in sequence.
Format: uuid
start_datestringRequired within parentStart date of the statement period.
Format: date-time
statement_linesarrayRequired within parentFinancial activities including card transactions, transfers, and cashbacks during the statement period.
statement_lines[]ModelEach itemExpand Fetch a statement — response body — statement lines item
statement_urlstringOptionalPre-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
FieldTypePresenceDescription and constraints
$objectRoot
cleared_atJSONOptional
cleared_at (anyOf 1)stringAlternativeTime when transaction was cleared. Only present for transactions and may be null if not cleared.
Format: date-time
cleared_at (anyOf 2)nullAlternative
created_atstringRequired within parentFor transactions: time when card was swiped. For transfers/cashbacks: creation time.
Format: date-time
idstringOptionalUnique identifier for the statement line item.
Format: uuid
typestringOptionalType of statement line item (CARD_TRANSACTION, TRANSFER_PAYMENT, or CASHBACK).
Known values: CARD_TRANSACTION, CASHBACK, TRANSFER_PAYMENT
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 statement — response body — balance sections item
FieldTypePresenceDescription and constraints
$objectRoot
chargesModelRequired within parentExpand Hold Bill — response body — amount
Total charges incurred during the statement period.
creditsModelRequired within parentExpand Hold Bill — response body — amount
Total credits accumulated during the statement period.
ending_balanceModelRequired within parentExpand Hold Bill — response body — amount
Balance at the end of the statement period.
entity_idstringRequired within parentBusiness entity this balance section belongs to.
Format: uuid
idstringRequired within parentUnique identifier for the balance section.
Format: uuid
opening_balanceModelRequired within parentExpand Hold Bill — response body — amount
Balance at the beginning of the statement period.
paymentsModelRequired within parentExpand Hold Bill — response body — amount
Total payments made during the statement period.

Referenced models: Hold Bill — response body — amount

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"]

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.