API - Justificativas e férias

Objetivo

Descrever métodos de acesso à API de Justificativas (Allowances).

Incluir justificativa ou férias

Inclui ou remove justificativas e férias dos colaboradores.
Limite de 10.000 requisições por chamada da API.

Endpoint
https://api1.tradingworks.net/v1/allowance/add

Método
POST

Headers
AUTH-TOKEN = Sua Chave privada
Content-Type = application/json

Dados

Campo Tipo Requerido Exemplo Observações
EmployeeNumber

STRING

Sim "240341" Número da matrícula do colaborador
FromDate

Date

Sim "2017-04-23" Data de início do evento
ToDate

date

Não "2017-05-01" Data de término do evento
AllowanceTypeCode

STRING

Sim "LIC_MED" É o código usado pela sua empresa (vide o cadastro de justificativas).
Se a justificativa para o mesmo dia já existe, nenhuma operação é realizada.

Importante:
  • Use o código REMOVER se deseja remover alguma justificativa previamente cadastrada.
  • Use o código F, FÉRIAS ou FERIAS para inserir férias ao colaborador.
AllowanceHours

string

Não "04:00" É usado quando se deseja uma quantidade específica de horas.
Se não informado, será abonado todas as horas do dia.
AllowanceNote

STRING

Não "Consulta médica" Qualquer nota adicional que deseja adicionar na folha.

Exemplo

[
  {
    "EmployeeNumber": 240341,
    "FromDate": "2017-04-15",
    "ToDate": "2017-04-25",
    "AllowanceTypeCode": "LIC_MED",
    "AllowanceNote": "Consulta médica"
    //Insere uma justificativa no período solicitado
  },
  {
    "EmployeeNumber": 23412,
    "FromDate": "2017-04-28",
    "AllowanceTypeCode": "Afastamento",
    "AllowanceNote": "Acidente de trabalho, afastado até segunda ordem"
    //Insere um afastamento (sem data de término) iniciando-se em 28/Abr/2017
  },
  {
    "EmployeeNumber": 240341,
    "FromDate": "2017-04-15",
    "ToDate": "2017-04-20",
    "AllowanceTypeCode": "REMOVER"
    //Remove todas as justificativas do período solicitado
  },
   {
    "EmployeeNumber": 240341,
    "FromDate": "2017-04-15",
    "ToDate": "2017-04-20",
    "AllowanceTypeCode": "F"
    //Insere férias no período solicitado
  },
   {
    "EmployeeNumber": 240341,
    "FromDate": "2017-04-15",
    "ToDate": "2017-04-15",
    "AllowanceTypeCode": "Abono",
    "AllowanceHours": "04:00"
    //Insere um abono específico no dia 15/Abr com apenas 4 horas
  }
]
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