Ajusta o saldo de créditos de um membro ou de uma empresa
POST/api/credits/adjustments
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- finance
- Clé d’API:
- sales:write
- X-CommunityId
X-CommunityIdEnvoyez 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.
Ajuste positivo ou negativo, com motivo obrigatório; é assim que se corrige um erro (o livro nunca altera nem apaga um lançamento). O ajuste positivo abre um lote (`expiresAt` opcional); o negativo consome os lotes que vencem primeiro e **não** pode levar o saldo utilizável abaixo de zero (`409`, `errors[].param = amount`). Owner, admin e financeiro; o moderador recebe 403. Informe `memberId` **ou** `companyId`; na carteira da empresa, só owner e admin (financeiro: 403), e empresa de outra comunidade dá 404.
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête application/json
| Nom | Type | Description |
|---|---|---|
memberIdfacultatif | string (uuid) | O perfil ajustado. Ou `companyId`. |
companyIdfacultatif | string (uuid) | A empresa ajustada. Só owner e admin. |
amountobligatoire | integer | Positivo ou negativo, nunca 0; de -1.000.000 a 1.000.000 (acima disso, 400 no campo `amount`). · ≥ -1000000, ≤ 1000000 |
reasonobligatoire | string | max 255 |
expiresAtfacultatif | string (date-time) | Só no ajuste positivo. |
Réponses
| Statut | Description |
|---|---|
201 | Ajustado |
400 | Requisição inválida — falha de validação. |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/credits/adjustments" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"amount":-1000000,"reason":"string"}'