1. Listar Colaboradores
Endpoint:
GET https://api1.tradingworks.net/v1/employees
Headers:
AUTH-TOKEN: sua_chave_privada
2. Criar ou Editar Colaborador
Endpoint:
POST https://api1.tradingworks.net/v1/employees
Headers:
AUTH-TOKEN: sua_chave_privada Content-Type: application/json
Dados
Campo | Tipo | Requerido | Exemplo | Observações |
EmployeeNumber | string (50) | Não* | "45783" | Número de matrícula do colaborador. |
FirstName | string (250) | Sim* | "José" | Primeiro nome do colaborador. |
MiddleName | string (250) | Não | "Machado" | Nome do meio do colaborador. |
LastName | string (250) | Sim* | "Silva" | Último nome do colaborador. |
FullName | string (750) | Sim* | "José Machado Silva" | Nome completo do colaborador. |
NickName | string (30) | Não | "José" | Nome reduzido para apresentação em algumas telas. |
string (250) | Sim* | E-mail do colaborador. | ||
PIN | int | Sim* | "2330" | Número para autenticação no app ou quiosque. Geralmente igual à matrícula. |
ActivateApp | boolean | Não | True | Indica que deve gerar código de ativação para o colaborador (AppCode1 e AppCode2) para que ele possa ativar o aplicativo de celular. |
AppCode1 | string (7) | Leitura | AAA1111 | Código 1 para ativação do aplicativo. |
AppCode2 | string (7) | Leitura | AAA1111 | Código 2 para ativação do aplicativo. |
ActivateAppV1 | boolean | Não | True | OBSOLETO - apenas para o aplicativo antigo, versão 1. |
ManagerNumber | string (50) | Não | "453" | Número da matrícula do gestor. |
ManagerFullName | string (750) | Não | "Roberto Moraes" | Nome completo do gestor. |
EmployerImportRef | string (50) | Sim | "67" | Código de vinculação do empregador. |
EmployerName | string (250) | Não | "Industrias Runidas ltda." | Razão social do empregador. |
EmployerVAT | string (50) | Não | "14.122.321/0001-09" | CNPJ do empregador. |
NeedAttendance | boolean | Não | true (padrão) | Indica que o colaborador deve registrar o ponto. |
Department | string (100) | Não | "Financeiro" | Nome do departamento que o colaborador está inserido. |
AttendanceRule | string (50) | Não | "SEG-SEX 08:00 - 17:00" | Nome da regra de ponto a ser associada. |
LocalHoliday | string (50) | Não | "Rio de Janeiro" | Nome do calendário de feriados locais a ser aplicado. |
AccessLevel | string (50) | Não | SOLICITANTE | Limita o que este colaborador pode fazer dentro do sistema. |
ManagerRestricted | boolean | Não | FALSE - padrão | Aplicável apenas para AccessLevel GESTOR, onde seus acessos são restringidos ao time sob sua supervisão direta. |
LicenseType | string (50) | Não | PONTO - padrão ATIVIDADES | Tipo de acesso e visão dos módulos do sistema. |
TimeZone | string (60) | Não | 'E. South America Standard Time' - padrão | Lista UTC dos fusos horários. Ver lista aqui. |
OnlyAttendance | boolean | Não | TRUE - padrão | Para clientes com ambientes mistos de controle de ponto e controle de atividades. Se ativo, o colaborador não vê opções de ver atividades. |
AdmissionDate | date | Não | "2016-12-03" | Data de admissão. |
StatusEmployeeID | integer | Não | "1" | 1 - Ativo - padrão |
TerminationDate | date | Não | "2019-04-23" | Data de desligamento. |
PersonalDocument | string (30) | Não | "123.177.788-84" | Número do CPF. |
SocialSecurity | string (30) | Não | "120.23362.88-7" | Número do PIS. |
WorkDocument | string (30) | Não | "233.212.111/455 SP" | Número da carteira de trabalho. |
Gender | string (1) | Não | "M" - masculino "F" - feminino | Sexo. |
JobTitle | string (50) | Não | "Analista financeiro" | Cargo odo colaborador. |
BirthDate | date | Não | "1983-03-30" | Data de nascimento. |
PhoneNumber | string (50) | Não | "11-3222-3332 R45" | Número de telefone. |
MobileNumber | string (50) | Não | "11-9-8822-2221" | Número do telefone celular. |
Address1 | string (500) | Não | "Rua José Bonifácio" | Nome do logradouro. |
Address2 | string (100) | Não | "Condomínio Alcântara" | Complemento do endereço. |
AddressNumber | string (10) | Não | "341" | Número do logradouro. |
Region | string (100) | Não | "Jardim das Flores" | Bairo ou similar. |
City | string (100) | Não | "São Paulo" | Nome da cidade. |
State | string (100) | Não | "SP" | Nome ou sigla do estado. |
ZipCode | string (15) | Não | "04663-009" | CEP do endereço. |
Country | string (100) | Não | "Brasil" | Nome do país. |
Exemplo de Requisição
POST https://api1.tradingworks.net/v1/employees?EmployeeNumberIsPK=true
Headers:
AUTH-TOKEN: sua_chave_privada Content-Type: application/json
Corpo
{
"EmployeeNumber": "45783",
"FullName": "José Machado Silva",
"Email": "[email protected]",
"AccessLevel": "COLABORADOR",
"Department": "Financeiro",
"AdmissionDate": "2016-12-03"
}
Exemplo de Resposta
[
{
"FullName": "Roberto Moraes",
"Email": "[email protected]",
"EmployeeNumber": "3342",
"AccessLevel": "GESTOR",
"ActivateApp": true
},
{
"FullName": "José Machado Silva",
"Email": "[email protected]",
"EmployeeNumber": "45783",
"AccessLevel": "COLABORADOR",
"ActivateApp": false
}
]
Observações Importantes
O campo EmployeeNumber pode substituir o Email como identificador, desde que usado com
EmployeeNumberIsPK=true.O campo AudityID deve ser usado quando se deseja rastrear auditoria de alterações por um usuário específico.
Licenças podem ser definidas via campo LicenseType (ex.: PONTO ou ATIVIDADES).
Para gestores, se ManagerRestricted = true, ele acessa apenas o time direto.