Consulte resumo e fluxo de caixa

Objetivo e pré-requisitosCopiar link da seção

Consultar o resumo e a evolução do caixa com reports:read e acesso ao recurso de fluxo de caixa. Configure as variáveis no servidor.

1. Defina o períodoCopiar link da seção

Informe datas financeiras inclusivas. Por exemplo, janeiro de 2026:

curl --fail-with-body \
  "$RURALZAP_BASE_URL/api/v1/integration/reports/summary?startDate=2026-01-01&endDate=2026-01-31" \
  -H "Authorization: Bearer $RURALZAP_API_KEY"

2. Consulte a sérieCopiar link da seção

curl --fail-with-body \
  "$RURALZAP_BASE_URL/api/v1/integration/reports/cashflow?startDate=2026-01-01&endDate=2026-01-31&groupBy=day" \
  -H "Authorization: Bearer $RURALZAP_API_KEY"

Também estão disponíveis Python para resumo e Python para fluxo de caixa.

3. Interprete os camposCopiar link da seção

summary informa abertura, entradas, saídas, resultado, ajustes e fechamento. data no fluxo traz os períodos. meta informa o intervalo e a carteira selecionada. Confira currency antes de apresentar valores.

O relatório é realizado e suporta BRL. Períodos sem movimento podem estar ausentes. Selecionar walletId inclui transferências externas dessa carteira conforme o cálculo oficial.

Recorte por classificaçãoCopiar link da seção

Resumo e série aceitam categoryId, costCenterId e assetId, sempre sobre a mesma parte da composição. Por exemplo, acrescente &assetId=019a1000-0000-7000-8000-000000000001 à URL e preserve os demais filtros. O identificador é sintético: use um equipamento do Space autorizado pela chave.

Confira meta.mode: slice identifica um recorte gerencial. Uma consulta por categoria ou equipamento começa o resultado do período em zero e não apresenta o saldo bancário integral. Um recorte por centro pode incluir o saldo analítico de abertura correspondente. Não compare esse fechamento com /balances como se fossem a mesma medida.

Resultado esperado e erros comunsCopiar link da seção

O resultado segue o relatório do produto com os mesmos filtros. 403 pode indicar ausência do recurso mesmo que a chave tenha o escopo; 400 pode indicar intervalo inválido. Respeite os limites específicos de relatórios.

Próximos passosCopiar link da seção

Compare a apresentação com a demonstração e confira resumo e fluxo de caixa.