raims balances
Inspect balances and expected receivables
From command to result
Query the current balance and the period forecast separately. Response amounts in cents let you compare what is available now with expected receivables.
Configure the profile and credential before running real reads. With an API
key, the key determines the company and environment. --environment selects
an environment only for OAuth.
Read the available balance
Shellraims --profile sandbox --output json balances getRead
data.available_amount_centsalongside total and blocked amounts. This read does not reserve funds for another operation.Compare with the forecast
Shellraims --profile sandbox --output json balances forecast --period last_7_daysReview the period, date boundaries, and projected amounts in
data. A forecast does not confirm receipt.
Choose a command
| Command | Purpose |
|---|---|
raims balances forecast | Get expected receivables for a period |
raims balances get | Get the current balance |
The previews below use --dry-run and do not send the request. Replace placeholders and review the result before sending a write.
Body fields, filters, and headers are sent only when supplied. Execution option defaults do not fill API fields.
raims balances
Inspect balances and expected receivables
raims balances [flags]Execution options
--help,-hbooldefault: false- help for balances
See global options.
Subcommands: raims balances forecast, raims balances get.
raims balances forecast
Get expected receivables for a period
raims balances forecast [flags]OAuth environments: Sandbox, Production. Success responses: 200.
Example
raims --profile PROFILE --output json balances forecast --dry-runThe excerpt below shows the CLI contents of data. The envelope also reports status_code and the received request_id.
Expected receipts for the period
{
"period": "last_7_days",
"start_at": 1791514800,
"end_at": 1792119600,
"forecast_date": 1792033200,
"receivable_amount_cents": 2500,
"projected_balance_cents": 12500
}Query filters
--periodstringsent only when supplied- Reporting period: today, last_7_days, last_15_days or last_30_days
Execution options
--dry-runbooldefault: false- Validate and preview the request without credentials or network access
--help,-hbooldefault: false- help for forecast
--show-headersbooldefault: false- Show public response headers without credentials or cookies
--timeoutdurationdefault: 1m0s- Total request timeout, including retries (for example 30s or 2m)
See global options.
Get expected receivables for a period.
GET /v1/balances/forecast
Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.
Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.
OAuth environments accepted by this operation: Sandbox, Production.raims balances get
Get the current balance
raims balances get [flags]OAuth environments: Sandbox, Production. Success responses: 200.
Example
raims --profile PROFILE --output json balances get --dry-runThe excerpt below shows the CLI contents of data. The envelope also reports status_code and the received request_id.
Partially blocked balance
{
"total_amount_cents": 10000,
"blocked_amount_cents": 3000,
"available_amount_cents": 7000
}Execution options
--dry-runbooldefault: false- Validate and preview the request without credentials or network access
--help,-hbooldefault: false- help for get
--show-headersbooldefault: false- Show public response headers without credentials or cookies
--timeoutdurationdefault: 1m0s- Total request timeout, including retries (for example 30s or 2m)
See global options.
Get the current balance.
GET /v1/balances
Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.
Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.
OAuth environments accepted by this operation: Sandbox, Production.