Este endpoint permite que um empregador faça o cadastro básico de colaboradores na TWO informando apenas o CPF e o nome completo. Caso queira fazer o cadastro de forma completa, use o endpoint de Colaboradores clicando aqui.
Importante: o cadastro simplificado cria somente os dados básicos do colaborador. Informações complementares podem ser preenchidas posteriormente na TWO, conforme a necessidade do empregador.
Requisitos
Para realizar a integração, você precisa de:
- Token válido de usuário com acesso executivo. Caso não tenha, clique aqui.
- CPF do colaborador.
- Opcionalmente, o nome completo do colaborador.
Criar cadastro simplificado
Endpoint
POST https://api1.tradingworks.net/v1/timecardcostcenter/employeesimple
Headers
AUTH-TOKEN: Token de autenticação de um usuário executivo
Content-Type: application/json
Validações
CPF (PersonalDocument)
- deve ser informado;
- deve ser um CPF válido;
- quando estiver repetido na mesma requisição, somente a primeira ocorrência será considerada.
Nome (Name)
- opcional. Caso o CPF válido informado não esteja cadastrado, irá ser feito o cadastro simplificado do colaborador com o seu nome como NOME INDEFINIDO.
- não pode conter apenas espaços;
- deve ter, no máximo, 500 caracteres.
Situação do colaborador
Colaborador inativo
Um colaborador inativo não pode ser alterado por meio do cadastro simplificado.
Colaborador já cadastrado
Se o CPF pertencer a um colaborador ativo que já possui nome definido, o cadastro existente será mantido sem alterações. O processo não substitui o nome de um colaborador que já está cadastrado.
Esse comportamento permite que a mesma integração seja enviada novamente sem criar colaboradores duplicados ou sobrescrever cadastros existentes.
Request Body
Envie uma lista JSON. Cada item representa o vínculo de um colaborador com um centro de custo em uma data.
[
{
"PersonalDocument": "12345678901",
"Name": "Ana da Silva"
},
{
"PersonalDocument": "121314151718",
"Name": "João dos Santos"
}
]
Campos
Campo | Tipo | Obrigatório | Descrição |
PersonalDocument | string | Sim | CPF válido do colaborador, com 11 dígitos |
Name | string | Sim | Nome completo do colaborador. Deve ter, no máximo, 500 caracteres. |
Response
A API retorna HTTP 200 OK quando termina o processamento, inclusive quando parte dos itens contém erros.
{
"totalRecords": 2,
"processedRecords": 2,
"errorCount": 0,
"errors": []
}
Campos da resposta
Campo | Tipo | Descrição |
totalRecords | int | Quantidade total de registros recebidos. |
processedRecords | int | Quantidade de registros processados com sucesso. |
errorCount | int | Quantidade de registros que não foram processados. |
errors | list | Detalhes dos registros que apresentaram erro. |
Colaboradores que já possuem cadastro ativo e completo e CPFs repetidos na mesma requisição não são contabilizados em processedRecords nem em errorCount. Por isso, em alguns casos, a soma desses dois campos pode ser menor que totalRecords.
Exemplo de processamento parcial
No exemplo abaixo, Ana da Silva é cadastrada, mas o segundo item é recusado porque contém um CPF inválido.
Request
[
{
"PersonalDocument": "52998224725",
"Name": "Ana da Silva"
},
{
"PersonalDocument": "1234567890",
"Name": "João dos Santos"
}
]
Response
{
"totalRecords": 2,
"processedRecords": 1,
"errorCount": 1,
"errors": [
{
"personalDocument": "1234567890",
"error": "CPF inválido ou em formato incorreto"
}
]
}
Códigos HTTP
Código | Quando ocorre |
200 OK | O processamento foi concluído. Consulte processedRecords, errorCount e errors para verificar o resultado de cada item. |
400 Bad Request | A lista está vazia, não foi enviada ou o corpo da requisição é inválido. |
401 Unauthorized | O header AUTH-TOKEN está ausente ou contém um token inválido. |
500 Internal Server Error | Ocorreu um erro inesperado durante o processamento |