raims statements | Raims Documentation

Look up syntax, arguments, and options for each command. Use raims COMMAND --help to read the help in your terminal.

`raims statements`

Inspect account statement entries

Shell

raims statements [flags]

--help, -h bool default: false
- help for statements

Subcommands: raims statements get, raims statements list.

`raims statements get`

Get an account statement entry

Shell

raims statements get ID [flags]

--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)

Get an account statement entry.

GET /v1/statements/{id}

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 statements get ID --dry-run

`raims statements list`

List account statement entries

Shell

raims statements list [flags]

--after string default: empty
- Read after this opaque cursor (cannot be combined with --before)
--all bool default: false
- Read all pages as separate results (JSON Lines with --output json)
--before string default: empty
- Read before this opaque cursor (cannot be combined with --after)
--created-gte int64 default: 0
- Created at or after this Unix timestamp (seconds)
--created-lte int64 default: 0
- Created at or before this Unix timestamp (seconds)
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for list
--max-pages int default: 100
- Maximum pages to read with --all (1-10000)
--page-size int64 default: 10
- Results per page (the API normalizes the requested size)
--reference-id string default: empty
- Filter by the referenced resource ID
--show-headers bool default: false
- Show public response headers without credentials or cookies
--sort-order string default: desc
- Sort direction: asc or desc
--statement-type string default: empty
- Filter by comma-separated statement type codes
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

List account statement entries.

GET /v1/statements

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 statements list --dry-run