Skip to content

Saldo de créditos de uma empresa residente

GET/api/credits/companies/{companyId}

Auth
Requires a token
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.

Carteira da empresa (F-93 1B): 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.

Parameters

NameInTypeDescription
companyIdrequiredpathstring (uuid)

Headers

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

Responses

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

curl example

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