Obtém dados de fluxo de caixa do estabelecimento.

GET /api/{userId}/establishment/{establishmentId}/financial/cashflow

Parâmetros de rota

Nome	Tipo	Descrição
userId	number	Identificador do usuário
establishmentId	number	Identificador do estabelecimento

Requisição

• Método: GET
• Path: /api/\{userId\}/establishment/\{establishmentId\}/financial/cashflow
• Headers: Authorization, Accept: application/json
• Autorização: informe o userId do token na URL e envie o token no header Authorization: Bearer <YOUR_API_TOKEN> (gerados no painel de API do Site Admin).

Parâmetros de consulta (query string)

Nome	Tipo	Descrição
type	string	Agrupamento da série. Valores aceitos: day (dias do mês informado) ou month (meses do ano informado). Obrigatório.
month	string (MM)	Mês a ser considerado quando type=day. Padrão: mês atual.
year	string (YYYY)	Ano a ser considerado. Padrão: ano atual.

Resposta

• Status: 200 OK
• Content-Type: application/json

Exemplo de resposta — type=day

Retorna o fluxo de caixa agrupado por dia do mês (somente transações confirmadas/pagas nas categorias operacionais).

{
  "response": "success",
  "data": {
    "total": {
      "receipts": 12840.50,
      "payments": -4530.00,
      "balance": 8310.50
    },
    "content": [
      {
        "day": "2026-04-01",
        "amountReceipt": 540.00,
        "amountPayment": 0,
        "balance": 540.00
      },
      {
        "day": "2026-04-02",
        "amountReceipt": 890.50,
        "amountPayment": -150.00,
        "balance": 740.50
      },
      {
        "day": "2026-04-03",
        "amountReceipt": 0,
        "amountPayment": -320.00,
        "balance": -320.00
      }
    ]
  }
}

Exemplo de resposta — type=month

Retorna o fluxo de caixa agrupado por mês, incluindo saldo anterior acumulado (previousBalance) e saldo final (balance) de cada mês.

{
  "response": "success",
  "data": {
    "total": {
      "receipts": 148320.75,
      "payments": -62150.30,
      "balance": 86170.45
    },
    "content": [
      {
        "month": "202601",
        "previousBalance": 12500.00,
        "amountReceipt": 11200.00,
        "amountPayment": -4800.00,
        "amountBalance": 6400.00,
        "balance": 18900.00
      },
      {
        "month": "202602",
        "previousBalance": 18900.00,
        "amountReceipt": 13450.75,
        "amountPayment": -5230.00,
        "amountBalance": 8220.75,
        "balance": 27120.75
      }
    ]
  }
}

Respostas de erro

Se type não for informado ou for inválido:

{
  "response": "error",
  "data": {
    "code": "400",
    "msg": "Invalid type parameter"
  }
}