Relatório de vendas por período

GET/api/reports/sales

Auth: Jeton requis
Qui peut l’appeler:: owner; admin; finance
Clé d’API:: reports:read
X-CommunityId: X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.

Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

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.

Regra da receita, a mesma do painel de Monetização e do resumo do Dashboard: a data é a do pagamento (o lançamento no extrato); uma venda reembolsada continua no `gross`, com o reembolso em `refunds`; venda de R$ 0,00 (cortesia, adicional incluído) não entra em `sales`; um reembolso lançado em partes conta uma vez em `refundsCount`.

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.

Paramètres

Nom	Emplacement	Type	Description
`interval`facultatif	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`facultatif	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`facultatif	query	`string (date)`	Último dia (inclusive), alargado até o fim do período. Padrão hoje.
`timezone`facultatif	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`facultatif	query	`none \| product \| plan \| paymentMethod \| productType \| ticketType`	`ticketType`: um grupo por tipo de ingresso (rótulo "Evento · Tipo"); as vendas que não são ingresso ficam no grupo de chave `null`.
`currency`facultatif	query	`BRL \| USD \| EUR \| GBP \| MXN \| ARS`

En-têtes

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

Réponses

Statut	Description
`200`	Série pronta para gráfico.
`400`	Requisição inválida — falha de validação.
`401`	Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
`403`	Autenticado, mas sem permissão para esta operação.
`500`	Erro interno do servidor.

Exemple curl

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