Raims CLIAPI commands
raims balances
Inspect balances and expected receivables
Look up syntax, arguments, and options for each command. Use raims COMMAND --help to read the help in your terminal.
raims balances
Inspect balances and expected receivables
Shell
raims balances [flags]--help,-hbooldefault: false- help for balances
--colorstringdefault: auto- Terminal colors: auto, on or off (JSON and completion stay uncolored)
--debugbooldefault: false- Write diagnostic JSON events to stderr without credentials or command arguments
--environmentstringdefault: empty- Select sandbox or production for OAuth or an OAuth dry run; API keys determine their own environment
--mapstringdefault: empty- List the command tree without executing a command: tree, compact, paths or json
--no-inputbooldefault: false- Disable interactive prompts (also enforced in CI and without a terminal)
--output,-ostringdefault: text- Output format: text or json
--profilestringdefault: empty- Use a profile for this command (overrides RAIMS_PROFILE and the saved default)
Subcommands: raims balances forecast, raims balances get.
raims balances forecast
Get expected receivables for a period
Shell
raims balances forecast [flags]--dry-runbooldefault: false- Validate and preview the request without credentials or network access
--help,-hbooldefault: false- help for forecast
--periodstringdefault: today- Reporting period: today, last_7_days, last_15_days or last_30_days
--show-headersbooldefault: false- Show public response headers without credentials or cookies
--timeoutdurationdefault: 1m0s- Total request timeout, including retries (for example 30s or 2m)
--colorstringdefault: auto- Terminal colors: auto, on or off (JSON and completion stay uncolored)
--debugbooldefault: false- Write diagnostic JSON events to stderr without credentials or command arguments
--environmentstringdefault: empty- Select sandbox or production for OAuth or an OAuth dry run; API keys determine their own environment
--mapstringdefault: empty- List the command tree without executing a command: tree, compact, paths or json
--no-inputbooldefault: false- Disable interactive prompts (also enforced in CI and without a terminal)
--output,-ostringdefault: text- Output format: text or json
--profilestringdefault: empty- Use a profile for this command (overrides RAIMS_PROFILE and the saved default)
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.Command example
Shell
raims --profile PROFILE --output json balances forecast --dry-runraims balances get
Get the current balance
Shell
raims balances get [flags]--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)
--colorstringdefault: auto- Terminal colors: auto, on or off (JSON and completion stay uncolored)
--debugbooldefault: false- Write diagnostic JSON events to stderr without credentials or command arguments
--environmentstringdefault: empty- Select sandbox or production for OAuth or an OAuth dry run; API keys determine their own environment
--mapstringdefault: empty- List the command tree without executing a command: tree, compact, paths or json
--no-inputbooldefault: false- Disable interactive prompts (also enforced in CI and without a terminal)
--output,-ostringdefault: text- Output format: text or json
--profilestringdefault: empty- Use a profile for this command (overrides RAIMS_PROFILE and the saved default)
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.Command example
Shell
raims --profile PROFILE --output json balances get --dry-run