Consultar lançamentos financeiros

GET /v1/financial/cash-flows replica os lançamentos exibidos em Financeiro → Lançamentos na Área do Gestor. Com OAuth, exige financial:read. A sessão do restaurante também é aceita e limita a consulta ao restaurant_id assinado no token.

Requisição

curl -G "$TAKEAT_API_URL/v2/financial/cash-flows" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data-urlencode "start_date=2026-07-01" \
  --data-urlencode "end_date=2026-07-31"

O período máximo é de 92 dias de calendário. Em regime de competência, um lançamento sem competence_date entra pelo vencimento para não desaparecer da consulta.

Versões e migração

GET /v1/financial/cash-flows mantém o envelope com cash_flows, total, count, remaining, offset, limit e totals. GET /v2/financial/cash-flows usa data, pagination e meta. Os filtros e o limite de 92 dias são iguais nas duas versões.

Paginação e totais na V2

A página é fixa em 100 lançamentos principais, publicados em data. Use os parâmetros de pagination.next na próxima chamada, mantendo os filtros, até pagination.has_more=false. meta.totals cobre o período inteiro.

{
  "data": [],
  "pagination": {
    "count": 0,
    "limit": 100,
    "total": 0,
    "has_more": false,
    "next": null
  },
  "meta": {
    "start_date": "2026-07-01",
    "end_date": "2026-07-31",
    "date_type": "due_date",
    "totals": {
      "total_earnings": "0.00",
      "total_earnings_paid": "0.00",
      "total_expenses": "0.00",
      "total_expenses_paid": "0.00"
    }
  }
}

Veja o formato comum de paginação.

Principais e itens

Notas de entrada e títulos agrupados aparecem como lançamentos principais com seus filhos em items. O valor principal já é a soma dos filhos: somar ambos duplica o resultado.

• Para fluxo de caixa, use os lançamentos do nível principal ou os campos de meta.totals.
• Para análise por centro de custo, considere entradas com counts_for_result: true, inclusive dentro de items.

entry_type informa standalone, invoice, invoice_item, title ou title_entry. Lançamentos excluídos não são retornados, e itens nunca aparecem soltos na lista principal.