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.
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["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 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.business.get_business_balance_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
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 the company balance information — response body |
Referenced models: Fetch the company balance information — response body
Schemas
Section titled “Schemas”Fetch the company balance information — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
available_card_limit | JSON | Optional | |
available_card_limit (anyOf 1) | number | Alternative | Remaining available card spending limit. |
available_card_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
available_card_limit_amount | Model | Required within parent | Expand Hold Bill — response body — amount Remaining available card spending limit in minor units with an explicit USD currency code. Read only: true |
available_flex_limit | JSON | Optional | |
available_flex_limit (anyOf 1) | number | Alternative | Remaining available flex spending limit. |
available_flex_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
available_flex_limit_amount | Model | Required within parent | Expand Hold Bill — response body — amount Remaining available flex spending limit in minor units with an explicit USD currency code. Read only: true |
balance_including_pending | JSON | Optional | |
balance_including_pending (anyOf 1) | number | Alternative | Total balance including pending transactions. |
balance_including_pending (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_including_pending_amount | Model | Required within parent | Expand 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_amount | Model | Required within parent | Expand 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_pending | JSON | Optional | |
card_balance_including_pending (anyOf 1) | number | Alternative | Current card balance including pending transactions. |
card_balance_including_pending (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
card_balance_including_pending_amount | Model | Required within parent | Expand Hold Bill — response body — amount Current card balance including pending transactions in minor units with an explicit USD currency code. Read only: true |
card_limit | JSON | Optional | |
card_limit (anyOf 1) | number | Alternative | Maximum allowed card spending limit. |
card_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
card_limit_amount | Model | Required within parent | Expand Hold Bill — response body — amount Maximum allowed card spending limit in minor units with an explicit USD currency code. Read only: true |
flex_balance | JSON | Optional | |
flex_balance (anyOf 1) | number | Alternative | Current balance of flex spending. |
flex_balance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
flex_balance_amount | Model | Required within parent | Expand Hold Bill — response body — amount Current balance of flex spending in minor units with an explicit USD currency code. Read only: true |
flex_limit | JSON | Optional | |
flex_limit (anyOf 1) | number | Alternative | Maximum allowed flex spending limit. |
flex_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
flex_limit_amount | Model | Required within parent | Expand 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_pending | JSON | Optional | |
float_balance_excluding_pending (anyOf 1) | number | Alternative | Float account balance excluding pending transactions. |
float_balance_excluding_pending (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
float_balance_excluding_pending_amount | Model | Required within parent | Expand Hold Bill — response body — amount Float account balance excluding pending transactions in minor units with an explicit USD currency code. Read only: true |
global_limit | JSON | Optional | |
global_limit (anyOf 1) | number | Alternative | Overall spending limit for the business. |
global_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
global_limit_amount | Model | Required within parent | Expand Hold Bill — response body — amount Overall spending limit for the business in minor units with an explicit USD currency code. Read only: true |
max_balance | JSON | Optional | |
max_balance (anyOf 1) | number | Alternative | Maximum balance allowed for the business. |
max_balance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_balance_amount | Model | Required within parent | Expand 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_date | string | Optional | Date of the next billing cycle. |
prev_billing_date | string | Optional | Date of the previous billing cycle. |
statement_balance | JSON | Optional | |
statement_balance (anyOf 1) | number | Alternative | Balance from the most recent statement. |
statement_balance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
statement_balance_amount | Model | Required within parent | Expand 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
| 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]