Aller au contenu

Saldo de créditos de uma empresa

GET/api/credits/companies/{companyId}

Auth
Jeton requis
Clé d’API:
sales: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.

Carteira da empresa: os créditos do plano da empresa e as concessões manuais, que os funcionários usam nas reservas com `payWith: company`. Owner, admin, financeiro e o admin daquela empresa; os demais papéis recebem 403. Empresa de outra comunidade ou apagada: 404.

Paramètres

NomEmplacementTypeDescription
companyIdobligatoirepathstring (uuid)

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Réponses

StatutDescription
200Saldo
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.

Exemple curl

curl -X GET "https://api.memberfy.net/api/credits/companies/<companyId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"