1. Listar Verbas
Endpoint:
GET https://api1.tradingworks.net/v1/wageitems
Headers:
AUTH-TOKEN: sua_chave_privada
Parâmetros (opcionais):
Campo | Tipo | Exemplo | Observações |
Month | integer | 10 | Mês de competência da folha de ponto. |
Year | integer | 2022 | Ano de competência da folha. |
FromDate | date | "2022-10-01" | Início do período (o limite entre |
ToDate | date | "2022-10-31" | Término do período (máximo de 60 dias entre as datas). |
DepartmentCode | string | "FIN" | Filtrar verbas por código de departamento. |
EmployerImportRef | string | "90" | Filtrar verbas por empregador; útil quando há matrículas duplicadas. |
EmployeeID | integer | 5435 | ID interno do colaborador — utiliza-se para identificar o colaborador. |
EmployeeNumber | string | "1234675" | Matrícula do colaborador. Use o EmployerImportRef caso a matrícula não seja única. |
OnlyApproved | boolean | false | Padrão: true. Se |
Exemplo de Requisição
GET https://api1.tradingworks.net/v1/wageitems?month=10&year=2022&OnlyApproved=false
Headers
Headers: AUTH-TOKEN: sua_chave_privada
Exemplo de resposta:
{
"ActivityNumber":"CX45",
"Title":"Manutenção da caldeira",
"Details":"Mapear os atores responsáveis pelo processo.",
"AssignmentsEmployeeNumber":[
"121",
"122"
],
"RequestedByFullName":"Roberto Prado",
"PlannedStartDate":"2017-04-23",
"PlannedFinishDate":"2017-04-28"
}Dicas e Observações Importantes
A soma das verbas é calculada para o período especificado (Month/Year ou
FromDate/ToDate), respeitando o limite de 60 dias.O campo OnlyApproved, se não informado, retorna apenas verbas de folhas fechadas.
Se a matrícula do colaborador não for única, utilize os campos EmployeeNumber + EmployerImportRef para garantir a identificação correta.
Campos como Month, Year, FromDate e ToDate são mutualmente alternativos: use ou
Month+Year, ouFromDate+ToDate.