Takeat
Versão da documentação
RelatóriosPagamentos

Nova API V1.0 · Referência

Resumo de pagamentos

Consulte a série de pagamentos por dia ou por mês usando granularity. A opção filtered permite recortar o período por marca, canal e forma de pagamento. Informe as datas ou os meses correspondentes à escolha. Exige reports:payments:read e restaurante autorizado; preserva o corpo e os cálculos da variante selecionada. Veja exemplos no guia de relatórios.

Console de requisiçõesConfigure os dados, envie e inspecione a resposta.
GETProxy seguro
RequisiçãoEdite os campos antes de enviar
GET
/v1/reports/payments/summary

Consulte a série de pagamentos por dia ou por mês usando granularity. A opção filtered permite recortar o período por marca, canal e forma de pagamento. Informe as datas ou os meses correspondentes à escolha. Exige reports:payments:read e restaurante autorizado; preserva o corpo e os cálculos da variante selecionada. Veja exemplos no guia de relatórios.

Authorization

reportsIntegration
AuthorizationBearer <token>

Access token obtido por OAuth ou troca de API key. Exige reports:payments:read, reports:customers:read, reports:products:read ou reports:kds:read conforme a rota. Não aceita sessões humanas, tokens de garçom ou chaves brutas.

In: header

Query Parameters

restaurant_id?string

Restaurante autorizado pela credencial. Obrigatório quando houver mais de um restaurante; sem seleção implícita para credenciais universais.

granularity?string

Granularidade: daily = diária; monthly = mensal; filtered = período com filtros de pagamentos. Padrão: diária.

start_date?string

Início do período (YYYY-MM-DD). No KDS também aceita ISO com timezone. Obrigatório quando granularity=daily ou filtered; ignorado no modo mensal.

end_date?string

Fim do período (YYYY-MM-DD). KDS inclui o dia civil de Brasília; com ISO, o instante final é exclusivo. KDS: máximo 92 dias. Obrigatório quando granularity=daily ou filtered; ignorado no modo mensal.

start_month?string

Primeiro mês (YYYY-MM). Obrigatório quando granularity=monthly; ignorado nos outros modos.

end_month?string

Último mês (YYYY-MM). Obrigatório quando granularity=monthly; ignorado nos outros modos.

fill?string

Opção de preenchimento de períodos da API de relatórios.

brand_id?string

ID da marca do restaurante.

channel_group?string

Grupo do canal de venda (presencial, delivery_takeat ou marketplaces).

channel?string

Canal de venda do relatório de origem.

payment_method_id?string

ID do método de pagamento.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json