Skip to content

Ramp: Fetch the company balance information

Ramp business.getBusinessBalanceResource: arguments, response, policy and SDK examples.

← Business operations · Get started

Operation ramp.get_business_balance_resource

Provider route: GET /developer/v1/business/balance. 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["business"]["getBusinessBalanceResource"]>[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.business.getBusinessBalanceResource(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.business.get_business_balance_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Fetch the company balance information — response body

Referenced models: Fetch the company balance information — response body

Fetch the company balance information — response body
FieldTypePresenceDescription and constraints
$objectRoot
available_card_limitJSONOptional
available_card_limit (anyOf 1)numberAlternativeRemaining available card spending limit.
available_card_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
available_card_limit_amountModelRequired within parentExpand Hold Bill — response body — amount
Remaining available card spending limit in minor units with an explicit USD currency code.
Read only: true
available_flex_limitJSONOptional
available_flex_limit (anyOf 1)numberAlternativeRemaining available flex spending limit.
available_flex_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
available_flex_limit_amountModelRequired within parentExpand Hold Bill — response body — amount
Remaining available flex spending limit in minor units with an explicit USD currency code.
Read only: true
balance_including_pendingJSONOptional
balance_including_pending (anyOf 1)numberAlternativeTotal balance including pending transactions.
balance_including_pending (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
balance_including_pending_amountModelRequired within parentExpand Hold Bill — response body — amount
Total balance including pending transactions in minor units with an explicit USD currency code.
Read only: true
card_balance_excluding_pending_amountModelRequired within parentExpand Hold Bill — response body — amount
Current card balance excluding pending transactions in minor units with an explicit USD currency code.
Read only: true
card_balance_including_pendingJSONOptional
card_balance_including_pending (anyOf 1)numberAlternativeCurrent card balance including pending transactions.
card_balance_including_pending (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
card_balance_including_pending_amountModelRequired within parentExpand Hold Bill — response body — amount
Current card balance including pending transactions in minor units with an explicit USD currency code.
Read only: true
card_limitJSONOptional
card_limit (anyOf 1)numberAlternativeMaximum allowed card spending limit.
card_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
card_limit_amountModelRequired within parentExpand Hold Bill — response body — amount
Maximum allowed card spending limit in minor units with an explicit USD currency code.
Read only: true
flex_balanceJSONOptional
flex_balance (anyOf 1)numberAlternativeCurrent balance of flex spending.
flex_balance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
flex_balance_amountModelRequired within parentExpand Hold Bill — response body — amount
Current balance of flex spending in minor units with an explicit USD currency code.
Read only: true
flex_limitJSONOptional
flex_limit (anyOf 1)numberAlternativeMaximum allowed flex spending limit.
flex_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
flex_limit_amountModelRequired within parentExpand Hold Bill — response body — amount
Maximum allowed flex spending limit in minor units with an explicit USD currency code.
Read only: true
float_balance_excluding_pendingJSONOptional
float_balance_excluding_pending (anyOf 1)numberAlternativeFloat account balance excluding pending transactions.
float_balance_excluding_pending (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
float_balance_excluding_pending_amountModelRequired within parentExpand Hold Bill — response body — amount
Float account balance excluding pending transactions in minor units with an explicit USD currency code.
Read only: true
global_limitJSONOptional
global_limit (anyOf 1)numberAlternativeOverall spending limit for the business.
global_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
global_limit_amountModelRequired within parentExpand Hold Bill — response body — amount
Overall spending limit for the business in minor units with an explicit USD currency code.
Read only: true
max_balanceJSONOptional
max_balance (anyOf 1)numberAlternativeMaximum balance allowed for the business.
max_balance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_balance_amountModelRequired within parentExpand Hold Bill — response body — amount
Maximum balance allowed for the business in minor units with an explicit USD currency code.
Read only: true
next_billing_datestringOptionalDate of the next billing cycle.
prev_billing_datestringOptionalDate of the previous billing cycle.
statement_balanceJSONOptional
statement_balance (anyOf 1)numberAlternativeBalance from the most recent statement.
statement_balance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statement_balance_amountModelRequired within parentExpand Hold Bill — response body — amount
Balance from the most recent statement in minor units with an explicit USD currency code.
Read only: true

Referenced models: Hold Bill — response body — amount

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

SDK function policy ID: ramp.get_business_balance_resource. Catalog operation: get_business_balance_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: ["business: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.