Criar colaborador

Use esta operação para criar um novo cadastro de colaborador. Os campos isClient, isVehicle, isProvider e isSupplier (quando aplicáveis) marcam papéis adicionais para o mesmo cadastro, além do papel implícito neste endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Corpo de entrada para criar um colaborador.

string
required

Nome do cadastro (nome fantasia ou nome civil).

string

E-mail principal.

string

Telefone fixo ou celular, sem formatação.

string

Razão social (PJ) ou nome civil (PF).

string

CNPJ (PJ) ou CPF (PF), sem formatação.

string

Inscrição estadual (PJ) ou RG (PF).

string

Inscrição municipal (PJ).

string

URL do site.

string

Usuário do Skype.

string

Link do perfil do Facebook.

string

Link do perfil do Twitter/X.

boolean
required

Indica se o cadastro é pessoa jurídica (true) ou física (false).

boolean

Indica se o colaborador também deve ser tratado como cliente.

dataBaking
object

Dados bancários do cadastro.

dataRate
object

Notas de ranqueamento do cadastro, de 1 a 5.

dataLocality
object

Endereço do cadastro.

dataPix
array of objects

Chaves PIX do cadastro.

dataPix
boolean

Indica se o colaborador também deve ser tratado como veículo.

boolean

Indica se o colaborador também deve ser tratado como prestador de serviço.

boolean

Indica se o colaborador também deve ser tratado como fornecedor.

string

Cargo ou função do colaborador.

string

Benefícios do colaborador, em uma única string separada por vírgulas. Ao consultar o colaborador (Employee.benefits), o mesmo campo é retornado em formato JSON de array — os formatos de entrada e saída não são iguais.

string

Data de nascimento. Formato YYYY-MM-DD.

string

Data de contratação. Formato YYYY-MM-DD.

string

Data de desligamento. Formato YYYY-MM-DD; deixe em branco para colaboradores ativos.

string

Salário bruto, como string numérica.

string

Valor da hora trabalhada, como string numérica.

string

Observações internas sobre o colaborador. Aceita HTML, que é sanitizado.

Headers
string
enum

Só tem efeito em POST e PUT dos módulos Financeiro e Cadastros. Sem este header, a resposta traz {success, message}. Com recordCreated ou fieldsUpdated, a resposta traz {success, records} com o registro afetado. GET e DELETE ignoram este header, assim como as rotas de Projetos, Jobs e Tarefas.

Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json