Cadastra um estabelecimento (empregador)
POST/api/time-tracking/establishments
- Auth
- Richiede un token
- Chiave API:
- Non accetta chiavi API
- 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.
Gestão do ponto (owner, admin, financeiro). Grava o registro tipo 2 do AFD com o próximo NSR do estabelecimento (começa em 1). CNPJ (14) ou CPF (11) com dígito verificador conferido (422 `employerIdInvalid`); CAEPF, CNO e CEI opcionais. `responsibleCpf` é o CPF de quem cadastra, que vai no registro; sem ele, vale o CPF do cadastro de empregado de quem pede na comunidade, e sem nenhum dos dois: 422 `responsibleCpfRequired`. O mesmo documento já cadastrado na comunidade: 409 `establishmentExists`.
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 |
|---|---|---|
employerIdTypeobbligatorio | CNPJ | CPF | |
employerIdobbligatorio | string | Com ou sem máscara. |
caepffacoltativo | string | |
cnofacoltativo | string | |
ceifacoltativo | string | |
legalNameobbligatorio | string | max 150 |
workplaceobbligatorio | string | max 100 |
responsibleCpffacoltativo | string |
Risposte
| Codice | Descrizione |
|---|---|
201 | Estabelecimento cadastrado. |
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`). |
403 | Só a gestão do ponto (owner, admin, financeiro): `timeTracking.errors.managementOnly`; quem não tem cadastro de empregado: `notEmployee`; sessão de suporte do SuperAdmin: `supportSession`. |
409 | Conflito com o estado atual do recurso. |
422 | Dado inválido (CPF ou CNPJ com dígito errado, dia, período, campo obrigatório, pessoa sem acesso ao espaço, CPF do responsável ausente). |
Esempio con curl
curl -X POST "https://api.memberfy.net/api/time-tracking/establishments" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"employerIdType":"CNPJ","employerId":"string","legalName":"string","workplace":"string"}'