Docs
Checking Raims account
Raims CLIAPI commands

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.

  1. Read the available balance

    Shell
    raims --profile sandbox --output json balances get

    Read data.available_amount_cents alongside total and blocked amounts. This read does not reserve funds for another operation.

  2. Compare with the forecast

    Shell
    raims --profile sandbox --output json balances forecast --period last_7_days

    Review the period, date boundaries, and projected amounts in data. A forecast does not confirm receipt.

Choose a command

CommandPurpose
raims balances forecastGet expected receivables for a period
raims balances getGet 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

Shell
raims balances [flags]

Execution options

  • --help, -h bool default: false
    • help for balances

See global options.

Subcommands: raims balances forecast, raims balances get.

raims balances forecast

Get expected receivables for a period

Shell
raims balances forecast [flags]

OAuth environments: Sandbox, Production. Success responses: 200.

Example

Shell
raims --profile PROFILE --output json balances forecast --dry-run

Query filters

  • --period string sent only when supplied
    • Reporting period: today, last_7_days, last_15_days or last_30_days

Execution options

  • --dry-run bool default: false
    • Validate and preview the request without credentials or network access
  • --help, -h bool default: false
    • help for forecast
  • --show-headers bool default: false
    • Show public response headers without credentials or cookies
  • --timeout duration default: 1m0s
    • Total request timeout, including retries (for example 30s or 2m)

See global options.

raims balances get

Get the current balance

Shell
raims balances get [flags]

OAuth environments: Sandbox, Production. Success responses: 200.

Example

Shell
raims --profile PROFILE --output json balances get --dry-run

Execution options

  • --dry-run bool default: false
    • Validate and preview the request without credentials or network access
  • --help, -h bool default: false
    • help for get
  • --show-headers bool default: false
    • Show public response headers without credentials or cookies
  • --timeout duration default: 1m0s
    • Total request timeout, including retries (for example 30s or 2m)

See global options.