Raims CLIComandos da API
raims balances
Consulte os saldos e os recebimentos previstos.
Consulte a sintaxe, os argumentos e as opções de cada comando. Use raims COMANDO --help para ler a ajuda no terminal.
raims balances
Consulte os saldos e os recebimentos previstos.
Shell
raims balances [flags]--help,-hboolpadrão: false- Exibe a ajuda de balances.
--colorstringpadrão: auto- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debugboolpadrão: false- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environmentstringpadrão: vazio- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--mapstringpadrão: vazio- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-inputboolpadrão: false- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output,-ostringpadrão: text- Formato da saída: text ou json.
--profilestringpadrão: vazio- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
Subcomandos: raims balances forecast, raims balances get.
raims balances forecast
Consulte os recebimentos previstos para um período.
Shell
raims balances forecast [flags]--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de forecast.
--periodstringpadrão: today- Período da consulta: today, last_7_days, last_15_days ou last_30_days.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
--colorstringpadrão: auto- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debugboolpadrão: false- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environmentstringpadrão: vazio- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--mapstringpadrão: vazio- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-inputboolpadrão: false- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output,-ostringpadrão: text- Formato da saída: text ou json.
--profilestringpadrão: vazio- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
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.Exemplo do comando
Shell
raims --profile PROFILE --output json balances forecast --dry-runraims balances get
Consulte o saldo atual.
Shell
raims balances get [flags]--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de get.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
--colorstringpadrão: auto- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debugboolpadrão: false- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environmentstringpadrão: vazio- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--mapstringpadrão: vazio- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-inputboolpadrão: false- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output,-ostringpadrão: text- Formato da saída: text ou json.
--profilestringpadrão: vazio- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
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.Exemplo do comando
Shell
raims --profile PROFILE --output json balances get --dry-run