Saltar al contenido

Cadastra um estabelecimento (empregador)

POST/api/time-tracking/establishments

Auth
Requiere token
Clave de API:
No acepta clave de API
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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`.

Headers

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

Cuerpo de la solicitud application/json

NombreTipoDescripción
employerIdTypeobligatorioCNPJ | CPF
employerIdobligatoriostringCom ou sem máscara.
caepfopcionalstring
cnoopcionalstring
ceiopcionalstring
legalNameobligatoriostringmax 150
workplaceobligatoriostringmax 100
responsibleCpfopcionalstring

Respuestas

CódigoDescripción
201Estabelecimento cadastrado.
401Token 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`).
403Só 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`.
409Conflito com o estado atual do recurso.
422Dado 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).

Ejemplo 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"}'