REST API · Fato
CashBalancePeriods
Saldos mensais por conta — Saldo de abertura, movimento e saldo final calculados por mês a partir do saldo inicial cadastrado e dos lançamentos bancários.
- Endereço
/v1/openagros/cash-balance-periods- Chave
id- Escopo
finance.read- Campos
- 11
Indisponível em REST
Esta coleção exige filtro em periodStart, e a superfície REST não recebe filtro — só paginação. Toda chamada REST aqui responde 400 FilterRequired. Use a versão OData.
Campos
| Campo | O que é | Tipo | Nulo |
|---|---|---|---|
idchave | Identificador da linha. | Edm.Stringtexto | — |
periodStart | Primeiro dia do mês do modelo agregado. Os modelos derivados exigem filtro por este campo. | Edm.Datedata | sim |
account | Conta. | Edm.Stringtexto | sim |
subaccount | Subconta. | Edm.Stringtexto | sim |
openingBalance | Saldo inicial cadastrado da conta. É o ponto de partida do saldo projetado — negativo é saldo legítimo, não erro. | Edm.Doublenúmero | sim |
periodCredit | Créditos do mês, em valor absoluto. | Edm.Doublenúmero | — |
periodDebit | Débitos do mês, em valor absoluto. | Edm.Doublenúmero | — |
netMovement | Créditos menos débitos do mês. | Edm.Doublenúmero | — |
closingBalance | Saldo ao final do mês. É posição: use o último mês do recorte, não some vários meses. | Edm.Doublenúmero | sim |
movementCount | Quantidade de lançamentos no mês da conta. | Edm.Int64inteiro | — |
balanceAvailable | Indica se existe saldo inicial cadastrado para calcular a posição da conta. | Edm.Booleanbooleano | — |
Exemplos
curl
curl -H "Authorization: Bearer oag_SEU_TOKEN" \
"https://service.agrosti.com.br/v1/openagros/cash-balance-periods?pageSize=200&page=1"Sintaxe completa em REST API.