API - Colaboradores

Objetivo

Descrever métodos de acesso à API de Colaboradores ( Employees).

Listar

Endpoint

https://api1.tradingworks.net/v1/employees

Método

GET

Headers

AUTH-TOKEN = Sua Chave privada

Novo/edição de colaborador

Endpoint

https://api1.tradingworks.net/v1/employees

Método

POST

Parâmetros

EmployeeNumberIsPK - Indica que o sistema irá validar o EmployeeNumber para confirmações de existência do colaborador. O padrão é o Email

Exemplo:

https://api1.tradingworks.net/v1/employees?EmployeeNumberIsPK=true

AudityID - Para fins de auditoria, indica o EmployeeID do colaborador com nível EXECUTIVO para gravar nos logs de auditoria. Se não informado, será usado o primeiro colaborador com nível EXECUTIVO encontrado, o mais antigo cadastrado.

Exemplo:

https://api1.tradingworks.net/v1/employees?AudityID=456734

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.
Obrigatório caso parâmetro EmployeeNumberIsPK = true.
FirstName

string (250)

Sim* "José" Primeiro nome do colaborador.
Obrigatório se FullName não informado.
MiddleName

string (250)

Não "Machado" Nome do meio do colaborador.
LastName

string (250)

Sim* "Silva" Último nome do colaborador.
Obrigatório se FullName não informado.
FullName

string (750)

Sim* "José Machado Silva" Nome completo do colaborador.
Obrigatório quando FirstName e LastName vazios
NickName

string (30)

Não "José" Nome reduzido para apresentação em algumas telas.
Email

string (250)

Sim* "nome@empresa.com" E-mail do colaborador.
Opcional caso seja usado o PIN.
PIN

int

Sim* "2330" Número para autenticação no app ou quiosque. Geralmente igual à matrícula.
Opcional caso seja usado o e-mail.
ActivateApp

boolean

Não True
False - padrão
Indica que deve gerar código de ativação para o colaborador (AppCode1 e AppCode2) para que ele possa ativar o aplicativo de celular.
PIN ou EmployeeNumber obrigatório.
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.
ManagerNumber

string (50)

Não "453" Número da matrícula do gestor.
Para indicar o gestor podem ser usados o ManagerNumber ou ManagerFullName.
ManagerFullName

string (750)

Não "Roberto Moraes" Nome completo do gestor.
Para indicar o gestor podem ser usados o ManagerNumber ou ManagerFullName.
EmployerName

string (250)

Não "Industrias Runidas ltda." Razão social do empregador.
Para indicar o empregador podem ser usados o EmployerName ou EmployerVAT.
EmployerVAT

string (50)

Não "14.122.321/0001-09" CNPJ do empregador.
Para indicar o empregador podem ser usados o EmployerName ou EmployerVAT.
NeedAttendance

boolean

Não true (padrão) Indica que o colaborador deve registrar o ponto.
Para indicar o empregador podem ser usados o EmployerName ou EmployerVAT.
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.
Ela deve estar previamente criada. Erro caso não exista.
LocalHoliday

string (50)

Não "Rio de Janeiro" Nome do calendário de feriados locais a ser aplicado.
Ele deve estar previamente criada. Erro caso não exista.
AccessLevel

string (50)

Não SOLICITANTE
COLABORADOR - padrão
COORDENADOR
GESTOR
EXECUTIVO
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
2 - Inativo
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

[
 {
    "FullName": "Roberto Moraes",
    "Email": "rmoraes@empresa.com.br",
    "EmployeeNumber": "3342",
    "AccessLevel": "gestor",
    "ActivateApp": "true"
 },
 
 {
    "FullName": "José Machado Silva",
    "Email": "jmsilva@empresa.com.br",
    "EmployeeNumber": "45783",
    "PIN": "45783",
    "Manager": "Roberto Moraes",
    "ActivateApp": "true"
 }
]
Isto respondeu sua dúvida? Obrigado pelo retorno Houve um problema ao enviar seu feedback. Por favor tente novamente.

Ainda precisa de ajuda? Entre em contato Entre em contato