Pular para o conteúdo principal

Fluxo de caixa por categoria

POST /cash_flow

Retorna um consolidado financeiro agrupado por categoria, contato ou projeto dentro de um período.

Body

{
"access_token": "<access_token>",
"unit_token": "<unit_token>",
"initial_date": "2026-03-01",
"final_date": "2026-03-31",
"vizualization_type": "category"
}

Parâmetros

CampoTipoObrigatórioDescrição
access_tokenstringSimToken de acesso da API.
unit_tokenstringSimToken da unidade.
initial_datestringSimData inicial no formato YYYY-MM-DD.
final_datestringSimData final no formato YYYY-MM-DD.
vizualization_typestringSimTipo de agrupamento: "category", "contact" ou "project".

Response

{
"success": true,
"data": [...]
}

Observações

  • O filtro de data é aplicado sobre pay_day (data de pagamento).
  • vizualization_type determina como os dados são agrupados:
    • "category": agrupa por nome de categoria.
    • "contact": agrupa por nome do contato.
    • "project": agrupa por nome do projeto.