Passar para o conteúdo principal

API - Justificativa e Férias

Neste artigo, verá o uso dos endpoints da API da TWO relacionados a Justificativa e Férias.

Escrito por Danilo Mucinato

1. Incluir ou Remover Justificativa/Férias

Endpoint:

POST https://api1.tradingworks.net/v1/allowances/add

Headers:

AUTH-TOKEN: sua_chave_privada Content-Type: application/json

Campos

Campo

Tipo

Requerido

Exemplo

Observações

EmployeeNumber

string

Sim

"240341"

Matrícula do colaborador.

EmployerImportRef

string

Opcional

"8888"

Código do empregador. Use se houver duplicidade de matrícula; caso contrário, pode ser omitido.

FromDate

date

Sim

"2017-04-23"

Data de início da justificativa ou férias.

ToDate

date

Não

"2017-05-01"

Data de término do evento.

AllowanceTypeCode

string

Sim

"LIC_MED"

Código de justificativa (conforme cadastro interno). Use REMOVER para excluir, F, FÉRIAS ou FERIAS para inserir férias ou FR, FERIASREMOVER ou FÉRIASREMOVER para remover um período de férias previamente lançado.

AllowanceHours

string

Não

"04:00"

Para especificar horas exatas. Se omitido, abona todo o dia.

AllowanceNote

string

Não

"Consulta médica"

Observação adicional que aparecerá na folha de ponto.


Exemplos de Requisição

[
{
"EmployeeNumber": 240341,
"FromDate": "2017-04-15",
"ToDate": "2017-04-25",
"AllowanceTypeCode": "LIC_MED",
"AllowanceNote": "Consulta médica"
},
{
"EmployeeNumber": 23412,
"FromDate": "2017-04-28",
"AllowanceTypeCode": "Afastamento",
"AllowanceNote": "Acidente de trabalho, afastado até segunda ordem"
},
{
"EmployeeNumber": 240341,
"FromDate": "2017-04-15",
"ToDate": "2017-04-20",
"AllowanceTypeCode": "REMOVER"
},
{
"EmployeeNumber": 240341,
"FromDate": "2017-04-15",
"ToDate": "2017-04-20",
"AllowanceTypeCode": "F"
},
{
"EmployeeNumber": 240341,
"FromDate": "2017-04-15",
"ToDate": "2017-04-15",
"AllowanceTypeCode": "Abono",
"AllowanceHours": "04:00"
},
{
"EmployeeNumber": 240341,
"FromDate": "2017-04-15",
"ToDate": "2017-04-20",
"AllowanceTypeCode": "FR"
}
]


Dicas e Observações Importantes

  • Use o parâmetro AllowanceTypeCode com:

    • REMOVER → para apagar justificativas existentes no período.

    • F, FÉRIAS ou FERIAS → para marcar férias.

    • FR, FERIASREMOVER ou FÉRIASREMOVER → para remover um período de férias previamente lançado.

  • Se AllowanceHours não for informado, o dia será totalmente abonado.

  • A API ignora duplicações — se uma justificativa já existe para o período, nenhuma ação adicional será realizada.

Respondeu à sua pergunta?