Relatório de vendas por período

GET/api/reports/sales

Auth: Requires a token
Who can call it:: owner; admin; finance
X-CommunityId: X-CommunityId Send the X-CommunityId of the community the operation happens in.

Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

F-46. Owner, admin ou finance. Vem do **extrato** (ledger), então o líquido aqui é o líquido do extrato no mesmo período.

Cada linha de `series` é um período (`period`) com: `gross` (bruto pago pelo comprador), `platformFee` (taxa da plataforma), `installmentInterest` (juros de parcelamento da Memberfy), `net` (líquido creditado), `sales` (número de vendas), `averageTicket`, `refunds`/`refundsCount`, `chargebacks`/`chargebacksCount` (com a tarifa de contestação) e `netAfterRefunds` (`net` − reembolsos − contestações). Períodos sem venda vêm com zero. `totals` soma a janela; `allTime` soma desde a primeira venda.

Com `groupBy`, `groups[]` repete o mesmo formato por produto (opção de cobrança), plano, forma de pagamento ou tipo de produto. Uma venda sem plano entra no grupo `key: null`. `payouts` traz os saques por período na mesma moeda: `requested` (pedidos, pela data do pedido, sem os cancelados e os que falharam) e `completed` (concluídos, pela data de conclusão), com as quantidades. Uma moeda por consulta (`currency`; padrão: a moeda com mais vendas). Nunca traz custo de provedor: a taxa da plataforma é a única taxa.

Parameters

Name	In	Type	Description
`interval`optional	query	`day \| week \| month`	Tamanho de cada período da série. `week` começa na segunda-feira. Rótulo do período: `YYYY-MM-DD` (dia ou segunda-feira da semana) ou `YYYY-MM` (mês). Máximo de períodos por consulta: 366 dias, 156 semanas ou 120 meses.
`from`optional	query	`string (date)`	Primeiro dia (inclusive), no fuso do relatório, alargado para o início do período (com `interval=month`, `2026-03-15` vira `2026-03-01`). Padrão: 30 dias, 12 semanas ou 12 meses antes de `to`.
`to`optional	query	`string (date)`	Último dia (inclusive), alargado até o fim do período. Padrão hoje.
`timezone`optional	query	`string`	Fuso IANA em que os períodos são contados. Padrão: o fuso do país da comunidade (o mesmo dos prazos do call4papers). A resposta devolve o fuso usado em `timezone`.
`groupBy`optional	query	`none \| product \| plan \| paymentMethod \| productType`
`currency`optional	query	`BRL \| USD \| EUR \| GBP \| MXN \| ARS`

Headers

Name	Type	Description
`X-CommunityId`optional	`string (uuid)`	ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Responses

Status	Description
`200`	Série pronta para gráfico.
`400`	Requisição inválida — falha de validação.
`401`	Token ausente, inválido ou expirado.
`403`	Autenticado, mas sem permissão para esta operação.
`500`	Erro interno do servidor.

curl example

curl -X GET "https://api.memberfy.net/api/reports/sales" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"