Passar para o conteúdo principal

API - Cadastro Simplificado

Neste artigo verá o uso do endpoint da API da TWO relacionados ao Cadastro Simplificado.

Escrito por Jorge Luis
Atualizado há mais de 2 semanas

1. Cadastrar Colaborador

Endpoint:

POST https://api1.tradingworks.net/v1/timecardcostcenter/employeesimple

Headers:

AUTH-TOKEN: sua_chave_privada_restritiva

Condições

  1. Quando o CPF informado não existe na base de cadastro, é criado o cadastro utilizando o CPF como chave primária e inclui o nome no cadastro.

  2. Quando o CPF informado já existe na base de cadastro e o nome de usuário está como NOME INDEFINIDO, o nome do mesmo é atualizado.

  3. Quando o CPF informado já existe na base de cadastro e já tem nome de usuário preenchido, nada é feito.

Exemplo de Requisição

POST https://api1.tradingworks.net/v1/timecardcostcenter/employeesimple


Headers

Headers: AUTH-TOKEN: sua_chave_privada_restritiva


Campos:

Campo

Tipo

Requerido

Exemplo

Observações

PersonalDocument

string

Sim

"123.456.789-12"

Documento do Colaborador.

Name

string

Sim

"Ana Maria"

Nome do colaborador.


Exemplo de Requisição:

[
{
"PersonalDocument":"123.456.789-12",
"Name":"Ana Maria"
},
{
"PersonalDocument":"531.506.640-55",
"Name":"João Carlos"
}
]

Exemplo de resposta

{
"TotalRecords":2,
"ProcessedRecords":1,
"ErrorCount":1,
"Errors":[
{
"PersonalDocument":"531.506.640-55",
"Error":"CPF inválido ou em formato incorreto"
}
]
}
Respondeu à sua pergunta?