Cadastra uma empresa residente
POST/api/resident-companies
- Auth
- Richiede un token
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
Owner e admin. `endsAt` é opcional e não pode ser anterior a `startsAt`. `monthlyValue` é só registro (a cobrança continua sendo a assinatura que a empresa compra).
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
nameobbligatorio | string | max 120 |
residenceTypeobbligatorio | PRIVATE_OFFICE | FIXED_DESK | VIRTUAL_OFFICE | |
monthlyValueobbligatorio | number | ≥ 0 |
startsAtobbligatorio | string (date) | |
endsAtfacoltativo | string (date) |
Risposte
| Codice | Descrizione |
|---|---|
201 | Empresa cadastrada. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X POST "https://api.memberfy.net/api/resident-companies" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"name":"string","residenceType":"PRIVATE_OFFICE","monthlyValue":10,"startsAt":"string"}'