Consulta ledger

GET/api/ledger

Auth: Jeton requis
Qui peut l’appeler:: owner; admin; finance
Clé d’API:: finance: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.

Exige autenticação e papel financeiro (owner, admin ou finance) na comunidade do X-CommunityId. Cada lançamento traz `metadata.descriptionKey` e `metadata.descriptionParams` (a chave estável do texto) e, o texto já no idioma do `Accept-Language`: `descriptionText` (a linha do extrato) e `typeLabel` (o rótulo do tipo; `metadata.labelKey` quando o lançamento tem rótulo próprio, como a reserva devolvida por causa de um reembolso, `reserveReturnedRefund`/`reserveReturnAdjustedRefund`). Os dois vêm `null` quando não há texto para a chave; aí vale `description`, o texto neutro em inglês. O reembolso feito no painel do provedor usa a chave `refundAtProvider`.

Paramètres

Nom	Emplacement	Type	Description
`page`facultatif	query	`integer`
`limit`facultatif	query	`integer`
`entryType`facultatif	query	`SALE_GROSS \| SALE_NET \| PLATFORM_FEE \| CHARGEBACK_RESERVED \| CHARGEBACK_RELEASED \| CHARGEBACK \| REFUND \| REVERSAL \| BOLETO_REVERSAL \| ANTICIPATION_FEE \| SETTLEMENT_RELEASE \| PAYOUT_REQUESTED \| PAYOUT_COMPLETED \| PAYOUT_FAILED \| PAYOUT_CANCELED \| MANUAL_ADJUSTMENT \| INSTALLMENT_INTEREST`	Só os lançamentos deste tipo. Um tipo que não existe é recusado com 400.
`currency`facultatif	query	`BRL \| USD \| EUR \| GBP \| MXN \| ARS`	Só os lançamentos desta moeda. Cada lançamento traz `currency` e, enquanto não está disponível, `availableAt` (a data em que libera; numa venda parcelada no cartão, um lançamento `SALE_NET` por parcela, com `metadata.installment`).

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`	Operação realizada com sucesso.
`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`).
`500`	Erro interno do servidor.

Exemple curl

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