Documentação
Consultar lançamentos financeiros
Liste contas a pagar e receber, notas, itens e totais do período.
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/v1/financial/cash-flows" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
--data-urlencode "start_date=2026-07-01" \
--data-urlencode "end_date=2026-07-31"| Parâmetro | Obrigatório | Descrição |
|---|---|---|
start_date | Sim | Primeiro dia, em AAAA-MM-DD |
end_date | Sim | Último dia; entra inteiro na consulta |
date_type | Não | due_date (padrão) ou competence_date |
offset | Não | Quantos lançamentos principais pular; padrão 0 |
paid | Não | true para pagos/recebidos; false para abertos |
is_earning | Não | true para receitas; false para despesas |
provider_id | Não | Filtra fornecedor |
bank_account_id | Não | Filtra conta bancária |
payment_method_id | Não | Filtra forma de pagamento |
category_subcategory_id | Não | Filtra centro de custo |
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.
Paginação e totais
A página é fixa em 100 lançamentos principais. Some 100 ao offset enquanto
remaining for maior que zero. totals sempre cobre o período inteiro e
respeita os filtros, não apenas a página atual.
{
"total": 125,
"count": 100,
"remaining": 25,
"limit": 100,
"offset": 0,
"start_date": "2026-07-01",
"end_date": "2026-07-31",
"date_type": "due_date",
"totals": {
"total_earnings": "12500.00",
"total_earnings_paid": "12000.00",
"total_expenses": "8800.00",
"total_expenses_paid": "1250.00"
},
"cash_flows": []
}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
totals. - Para análise por centro de custo, considere entradas com
counts_for_result: true, inclusive dentro deitems.
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.