Passar para o conteúdo principal

API - Resultados Compilados

Neste artigo verá o uso do endpoint da API da TWO relacionados ao Vínculo dos Resultados Compilados.

Escrito por Danilo Mucinato

Este endpoint permite que um empregador consulte os resultados compilados de apontamentos vinculados a centros de custo na TWO. Ela retorna, por colaborador e por dia, os dados do empregador, centro de custo, local de trabalho e total de horas apuradas no período informado.

Importante: este endpoint é de consulta. Ele não cria colaboradores, não insere horários e não altera vínculos de centro de custo. Os dados retornados, caso não haja filtros, são restringidos ao que o token do usuário tem acesso.

Requisitos

Para realizar a integração, você precisa de:

- Token válido de usuário com acesso executivo. Caso não tenha, clique aqui.

- O período que será consultado;

- Opcionalmente, o código do empregador;

- Opcionalmente, o código do centro de custo.


Listar Resultados Compilados

Endpoint

POST https://api1.tradingworks.net/v1/timecardcostcenter/attendancescostcenter

Headers

AUTH-TOKEN: Token de autenticação de um usuário executivo

Content-Type: application/json

Validações

Data inicial (fromDate)

- deve ser informada;

- deve ser uma data válida.

Data final (toDate)

- deve ser informada;

- deve ser uma data válida;

- deve respeitar o limite máximo de 45 dias em relação à data inicial.

Empregador (employerCode)

- é opcional;

- quando informado, filtra os resultados pelo código do empregador;

- quando o usuário do token possui restrição por empregador, a API retorna somente os registros permitidos para esse usuário.

Centro de Custo (costCenterCode)

- é opcional;

- quando informado, filtra os resultados pelo código do centro de custo.

Parâmetros de Requisição

Os parâmetros devem ser enviados na query string da URL.

/v1/timecardcostcenter/attendancescostcenter?fromDate=2026-01-01&toDate=2026-01-31&employerCode=OBRA-HORIZONTE&costCenterCode=TORRE-A

Campos

Campo

Tipo

Obrigatório

Descrição

fromDate

date

Sim

Data inicial do período que será consultado. Use o formato YYYY-MM-DD.

toDate

date

Sim

Data final do período que será consultado. Use o formato YYYY-MM-DD. O intervalo entre fromDate e toDate não pode ser maior que 45 dias.

employerCode

string

Não

Código do empregador usado para filtrar os resultados. Quando não informado, a consulta considera todos os empregadores permitidos para o token.

costCenterCode

string

Não

Código do centro de custo usado para filtrar os resultados. Quando não informado, a consulta considera todos os centros de custo permitidos para o token e para os filtros aplicados.

Response

Quando existem registros para os filtros informados, a API retorna HTTP 200 OK com uma lista de resultados.

[
{
"Employer": "Construtora Horizonte SPE",
"VAT": "12.345.678/9101-12",
"CostCenterCode": "TORRE-A",
"CostCenter": "Torre A - Obra Residencial Horizonte",
"PersonalDocument": "12345678901",
"Name": "Ana da Silva",
"BaseDate": "2026-01-07T00:00:00",
"LocaleCode": "CANTEIRO-01",
"Locale": "Canteiro principal",
"WorkedHours": 8.00
},
{
"Employer": "Construtora Horizonte SPE",
"VAT": "12.345.678/9101-12",
"CostCenterCode": "TORRE-A",
"CostCenter": "Torre A - Obra Residencial Horizonte",
"PersonalDocument": "11121314156",
"Name": "João dos Santos",
"BaseDate": "2026-01-07T00:00:00",
"LocaleCode": "CANTEIRO-01",
"Locale": "Canteiro principal",
"WorkedHours": 7.50
}
]

Campos da resposta

Campo

Tipo

Descrição

Employer

string

Nome do empregador vinculado ao centro de custo.

VAT

string

CNPJ do empregador.

CostCenterCode

string

Código de importação do centro de custo.

CostCenter

string

Nome do centro de custo.

PersonalDocument

string

CPF do colaborador.

Name

string

Nome do Colaborador.

BaseDate

date

Data do dia de trabalho.

LocaleCode

string

Código do local de trabalho vinculado ao dia, quando houver.

Locale

string

Nome do local de trabalho vinculado ao dia, quando houver.

WorkedHours

decimal

Total de horas trabalhadas compiladas para o colaborador no dia.

Códigos HTTP

Código

Quando ocorre

200 OK

O processamento foi concluído. Consulte processedRecords, errorCount e errors para verificar o resultado de cada item.

400 Bad Request

A lista está vazia, não foi enviada ou o corpo da requisição é inválido.

401 Unauthorized

O header AUTH-TOKEN está ausente ou contém um token inválido.

500 Internal Server Error

Ocorreu um erro inesperado durante o processamento

Respondeu à sua pergunta?