TradingWorks

https://suporte.tradingworks.net/
Admin
TradingWorks is an electronic time tracking and timesheet management platform for recording employee...
Tokens:30,043
Snippets:349
Trust Score:7.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET https://api1.tradingworks.net/api/v2/projects/get

Source: https://suporte.tradingworks.net/article/14-projetos

Consulta os detalhes de um projeto específico.

```APIDOC
## GET https://api1.tradingworks.net/api/v2/projects/get

### Description
Obtém os detalhes de um projeto.

### Method
GET

### Endpoint
https://api1.tradingworks.net/api/v2/projects/get

### Request Body
- **ProjectID** (integer) - Required (if ProjectNumber not provided)
- **ProjectNumber** (string) - Required (if ProjectID not provided)
```

--------------------------------

### Exemplo de Requisição e Resposta de Verbas

Source: https://suporte.tradingworks.net/article/318-api-verbas

Exemplo de uma chamada GET com parâmetros e o formato JSON da resposta esperada.

```http
GET https://api1.tradingworks.net/v1/wageitems?month=10&year=2022&OnlyApproved=false
[
    {
        "EmployeeNumber": "1234675",
        "EmployerImportRef": "90", 
        "ItemCode": "98",
        "ItemName": "Faltas",
        "ItemValue": 15.00000
    },
    {
        "EmployeeNumber": "1234675",
        "EmployerImportRef": "90",
        "ItemCode": "888",
        "ItemName": "Horas trabalhadas",
        "ItemValue": 156.01667
    }
]
```

--------------------------------

### Listar Apontamentos

Source: https://suporte.tradingworks.net/article/10-apontamentos

Exemplos de requisição GET para listar apontamentos, com suporte a diferentes idiomas através do parâmetro Language.

```http
https://api1.tradingworks.net/v1/attendances?Language=pt-br&fromdate=2020-09-01&todate=2020-09-31
{
    "AttendanceRegisterID": 240341,
    "Matricula": "42345",
    "PIS": "8374823",
    "CPF": "1112223334444",
    "DataBase": "2018-09-03T00:00:00",
    "Data_Hora_Evento": "2018-09-03T13:45:00",
    "Sincronizado": false,
    "SituacaoID": 3,
    "Situacao": "Aprovado"
}
```

```http
https://api1.tradingworks.net/v1/attendances?fromdate=2020-09-01&todate=2020-09-31
{
    "AttendanceRegisterID": 240341,
    "EmployeeNumber": "42345",
    "SocialSecurity": "8374823",
    "PersonalDocument": "1112223334444",
    "BaseDate": "2018-09-03T00:00:00",
    "EventDateTime": "2018-09-03T13:45:00",
    "Synced": false,
    "StatusID": 3,
    "Status": "Aprovado"
}
```

--------------------------------

### GET https://api1.tradingworks.net/api/v2/projects/list/{projectstatusID}

Source: https://suporte.tradingworks.net/article/14-projetos

Lista projetos com base no status fornecido.

```APIDOC
## GET https://api1.tradingworks.net/api/v2/projects/list/{projectstatusID}

### Description
Lista projetos filtrados por status.

### Method
GET

### Endpoint
https://api1.tradingworks.net/api/v2/projects/list/{projectstatusID}

### Parameters
#### Path Parameters
- **projectstatusID** (integer) - Optional - 0: Rascunho, 1: Aberto, 2: Pausado, 3: Finalizado, 4: Cancelado
```

--------------------------------

### GET https://api1.tradingworks.net/v1/wageitems

Source: https://suporte.tradingworks.net/article/318-api-verbas

Lista as verbas de forma sintética, retornando a somatória do período para os colaboradores.

```APIDOC
## GET https://api1.tradingworks.net/v1/wageitems

### Description
Lista as verbas de forma sintética, retornando a somatória do período para os colaboradores.

### Method
GET

### Endpoint
https://api1.tradingworks.net/v1/wageitems

### Parameters
#### Query Parameters
- **Month** (number) - Required - Número do mês de competência da folha de ponto
- **Year** (number) - Required - Ano de competência da folha de ponto
- **FromDate** (string) - Optional - Período específico de início dos dados
- **ToDate** (string) - Optional - Período de término dos dados (limite de 60 dias entre fromdate e todate)
- **DepartmentCode** (string) - Optional - Código do departamento para filtro
- **EmployerImportRef** (string) - Optional - Código do empregador para filtro
- **EmployeeID** (string) - Optional - ID interno do colaborador para filtro
- **EmployeeNumber** (string) - Optional - Número de matrícula do colaborador para filtro
- **OnlyApproved** (boolean) - Optional - Padrão TRUE. Indica que somente folhas fechadas serão exportadas

### Headers
- **AUTH-TOKEN** (string) - Sua Chave privada

### Request Example
GET https://api1.tradingworks.net/v1/wageitems?month=10&year=2022&OnlyApproved=false

### Response
#### Success Response (200)
- **EmployeeNumber** (string) - Número da matrícula do colaborador
- **EmployerImportRef** (string) - Referência de importação do empregador
- **ItemCode** (string) - Código da verba
- **ItemName** (string) - Nome da verba
- **ItemValue** (number) - Valor total da verba no período

#### Response Example
[
    {
        "EmployeeNumber": "1234675",
        "EmployerImportRef": "90", 
        "ItemCode": "98",
        "ItemName": "Faltas",
        "ItemValue": 15.00000
    },
    {
        "EmployeeNumber": "1234675",
        "EmployerImportRef": "90",
        "ItemCode": "888",
        "ItemName": "Horas trabalhadas",
        "ItemValue": 156.01667
    }
]
```

--------------------------------

### GET /API/V{version}

Source: https://suporte.tradingworks.net/article/56-exportacao-da-folha

Endpoint para exportar os dados da folha de ponto de um determinado período.

```APIDOC
## GET /API/V{version}

### Description
Realiza a exportação dos dados da folha de ponto para integração com sistemas de folha de pagamento.

### Method
GET

### Endpoint
https://app.tradingworks.net/API/V{version}

### Parameters
#### Query Parameters
- **auth** (string) - Required - Código de segurança único do usuário.
- **output** (string) - Required - Tipo da exportação, deve ser fixo "FOLHAPONTO".
- **mes** (integer) - Required - Mês de competência (1 a 12).
- **ano** (integer) - Required - Ano de competência.
- **ext** (string) - Optional - Extensão do arquivo (CSV ou XML). Padrão é CSV.

### Request Example
https://app.tradingworks.net/API/V1?auth=SEUCODIGO&output=FOLHAPONTO&ext=CSV&mes=8&ano=2015
```

--------------------------------

### GET https://api1.tradingworks.net/v1/rulehistory/{MATRÍCULA}/{CÓDIGO DO EMPREGADOR}

Source: https://suporte.tradingworks.net/article/317-api-historico-de-regra

Lista o histórico de regras cadastrado para o colaborador especificado.

```APIDOC
## GET https://api1.tradingworks.net/v1/rulehistory/{MATRÍCULA}/{CÓDIGO DO EMPREGADOR}

### Description
Lista o histórico cadastrado para o colaborador especificado.

### Method
GET

### Endpoint
https://api1.tradingworks.net/v1/rulehistory/{MATRÍCULA}/{CÓDIGO DO EMPREGADOR}

### Parameters
#### Path Parameters
- **MATRÍCULA** (string) - Required - Matrícula do colaborador
- **CÓDIGO DO EMPREGADOR** (string) - Optional - Código de importação do empregador

#### Query Parameters
- **FromDate** (string) - Optional - Período específico de início dos dados
- **ToDate** (string) - Optional - Período de término dos dados

### Response
#### Success Response (200)
- **RuleCode** (string) - Código da regra
- **Title** (string) - Título da regra
- **BaseDate** (string) - Data base da regra

#### Response Example
[
    {
        "RuleCode": "451",
        "Title": "08:00 - 17:00",
        "BaseDate": "2022-10-04T00:00:00"
    }
]
```

--------------------------------

### GET https://api1.tradingworks.net/api/v2/workorders/list

Source: https://suporte.tradingworks.net/article/11-atendimentos

Recupera uma lista de atendimentos (WorkOrders).

```APIDOC
## GET https://api1.tradingworks.net/api/v2/workorders/list

### Description
Lista todos os atendimentos disponíveis.

### Method
GET

### Endpoint
https://api1.tradingworks.net/api/v2/workorders/list

### Headers
- **AUTH-TOKEN** (string) - Required - Sua Chave privada
```

--------------------------------

### Exemplo de JSON para Novo Projeto

Source: https://suporte.tradingworks.net/article/14-projetos

Exemplo de corpo de requisição JSON para criar um projeto.

```json
{
        "ProjectNumber": "CX45",
        "ProjectName": "Ampliação da Filial Sul",
        "Details": "Atividades relativo à expansão da filial sul.",
        "OwnerFullName": "José Pereira",
        "PlannedStartDate": "2017-04-23",
        "PlannedFinishDate": "2017-04-28",
        "ProjectStatusID": 1,
        "AllowDuplication": 1
}
```

--------------------------------

### POST /api/v2/activities/post

Source: https://suporte.tradingworks.net/article/12-atividades

Cria uma nova atividade no sistema. Permite vincular clientes, projetos e definir responsáveis através de IDs, nomes ou números de matrícula.

```APIDOC
## POST /api/v2/activities/post

### Description
Cria uma nova atividade no sistema TradingWorks.

### Method
POST

### Endpoint
https://api1.tradingworks.net/api/v2/activities/post

### Parameters
#### Request Body
- **ActivityNumber** (string) - Optional - Identificador da atividade.
- **Title** (string) - Required - Título da atividade.
- **Details** (string) - Optional - Detalhes da atividade.
- **Template** (string) - Optional - Nome do formulário cadastrado.
- **CustomerNumber** (string) - Optional - Número do cliente vinculado.
- **CustomerName** (string) - Optional - Nome do cliente (necessário se CustomerNumber não existir).
- **ProjectNumber** (string) - Optional - Código do projeto.
- **ActivityStatusID** (integer) - Optional - Status da atividade (2: Aberta, 5: Finalizada, 6: Cancelada).
- **AssignedToID** (integer) - Required - ID interno do responsável.
- **AssignedToEmployeeNumber** (string) - Required - Matrícula do responsável.
- **AssignedToFullName** (string) - Required - Nome completo do responsável.
- **AssignmentsEmployeeNumber** (string array) - Required - Lista de matrículas de responsáveis.
- **RequestedByID** (integer) - Required - ID interno do solicitante.
- **RequestedByEmployeeNumber** (string) - Required - Matrícula do solicitante.
- **RequestedByFullName** (string) - Required - Nome completo do solicitante.
- **TeamID** (integer) - Optional - ID interno do time.
- **Team** (string) - Optional - Nome do time.
- **PlannedStartDate** (date) - Optional - Data de início planejada.
- **PlannedFinishDate** (date) - Optional - Data de término planejada.
- **AllowDuplication** (integer) - Optional - Regra de duplicação (0, 1 ou 2).

### Request Example
{
  "ActivityNumber": "CX45",
  "Title": "Manutenção da caldeira",
  "Details": "Mapear os atores responsáveis pelo processo.",
  "AssignedToFullName": "José Pereira",
  "RequestedByFullName": "Roberto Prado",
  "PlannedStartDate": "2017-04-23",
  "PlannedFinishDate": "2017-04-28"
}
```

--------------------------------

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

Source: https://suporte.tradingworks.net/article/13-colaboradores

Lista todos os colaboradores cadastrados no sistema.

```APIDOC
## GET https://api1.tradingworks.net/v1/employees

### Description
Lista todos os colaboradores cadastrados.

### Method
GET

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

### Headers
- **AUTH-TOKEN** (string) - Required - Sua Chave privada
```

--------------------------------

### Exemplo de estrutura JSON para colaboradores

Source: https://suporte.tradingworks.net/article/13-colaboradores

Exemplo de payload contendo informações de colaboradores, incluindo dados pessoais, níveis de acesso e configurações de aplicativo.

```json
[
 {
    "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"
 }
]
```

--------------------------------

### Novo Projeto Método

Source: https://suporte.tradingworks.net/article/14-projetos

Método HTTP para criar um novo projeto.

```text
POST
```

--------------------------------

### Listar Projetos Método

Source: https://suporte.tradingworks.net/article/14-projetos

Método HTTP para listar projetos.

```text
GET
```

--------------------------------

### Listar Projetos Headers

Source: https://suporte.tradingworks.net/article/14-projetos

Cabeçalho de autenticação necessário para listar projetos.

```text
AUTH-TOKEN = Sua Chave privada
```

--------------------------------

### Novo Projeto Headers

Source: https://suporte.tradingworks.net/article/14-projetos

Cabeçalhos necessários para a criação de um projeto.

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

--------------------------------

### Listar histórico de regra

Source: https://suporte.tradingworks.net/article/317-api-historico-de-regra

Recupera o histórico de regras de um colaborador específico via método GET.

```http
GET https://api1.tradingworks.net/v1/rulehistory/{MATRÍCULA}/{CÓDIGO DO EMPREGADOR}
```

```http
GET https://api1.tradingworks.net/v1/rulehistory/5555/8888
[
    {
        "RuleCode": "451",
        "Title": "08:00 - 17:00",
        "BaseDate": "2022-10-04T00:00:00"
    },
    {
        "RuleCode": "455",
        "Title": "07:00 - 16:00",
        "BaseDate": "2022-10-03T00:00:00"
    },
    {
        "RuleCode": "",
        "Title": "Flex 8h",
        "BaseDate": "2013-09-10T00:00:00"
    }
]
```

--------------------------------

### Exemplos de payload para criação de atendimento

Source: https://suporte.tradingworks.net/article/11-atendimentos

Estruturas JSON para envio de dados de atendimento, incluindo opções com responsável único ou lista de responsáveis.

```json
{
        "ActivityNumber": "CX45",
        "Title": "Manutenção da caldeira",
        "Details": "Mapear os atores responsáveis pelo processo.",
        "AssignedToFullName": "José Pereira",
        "RequestedByFullName": "Roberto Prado",
        "PlannedStartDate": "2017-04-23",
        "PlannedFinishDate": "2017-04-28"
}
```

```json
{
        "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"
}
```

--------------------------------

### GET https://api1.tradingworks.net/v1/attendances

Source: https://suporte.tradingworks.net/article/10-apontamentos

Lista os 1.000 primeiros apontamentos que ainda não foram marcados como sincronizados. Retorna apenas apontamentos originais, aprovados ou inseridos pelo gestor/RH.

```APIDOC
## GET https://api1.tradingworks.net/v1/attendances

### Description
Lista os 1.000 primeiros apontamentos que ainda não foram marcados como sincronizados.

### Method
GET

### Endpoint
https://api1.tradingworks.net/v1/attendances

### Parameters
#### Query Parameters
- **Language** (string) - Optional - Opções atuais 'en-US' (padrão) ou 'pt-BR'. Altera o nome das propriedades para a língua específica.
- **Fromdate** (string) - Optional - Data de início da pesquisa.
- **Todate** (string) - Optional - Data de término da pesquisa.
- **Listall** (boolean) - Optional - Lista os últimos 60 dias de marcações em qualquer situação de sincronização.
- **ShowMeta** (boolean) - Optional - Retorna dados adicionais do registro de ponto como a validação facial e geolocalização.

### Response
#### Success Response (200)
- **AttendanceRegisterID** (integer) - ID do registro.
- **Matricula/EmployeeNumber** (string) - Matrícula do funcionário.
- **PIS/SocialSecurity** (string) - PIS ou número de segurança social.
- **CPF/PersonalDocument** (string) - CPF ou documento pessoal.
- **DataBase/BaseDate** (string) - Data base do registro.
- **Data_Hora_Evento/EventDateTime** (string) - Data e hora do evento.
- **Sincronizado/Synced** (boolean) - Status de sincronização.
- **SituacaoID/StatusID** (integer) - ID da situação.
- **Situacao/Status** (string) - Descrição da situação.
```

--------------------------------

### Exemplo de payload JSON

Source: https://suporte.tradingworks.net/article/12-atividades

Estrutura básica de dados para criação de uma atividade.

```json
{
        "ActivityNumber": "CX45",
        "Title": "Manutenção da caldeira",
        "Details": "Mapear os atores responsáveis pelo processo.",
        "AssignedToFullName": "José Pereira",
        "RequestedByFullName": "Roberto Prado",
        "PlannedStartDate": "2017-04-23",
        "PlannedFinishDate": "2017-04-28"
}
```

--------------------------------

### Listar atendimentos

Source: https://suporte.tradingworks.net/article/11-atendimentos

Endpoint e método para recuperar a lista de atendimentos.

```text
https://api1.tradingworks.net/api/v2/workorders/list
```

```text
GET
```

```text
AUTH-TOKEN = Sua Chave privada
```

--------------------------------

### Exemplo de atualização de status

Source: https://suporte.tradingworks.net/article/12-atividades

Exemplos de uso do endpoint para atualizar o status de um log de atividade específico.

```text
https://api1.tradingworks.net/api/v2/activities/customerstatus/9999?status=1
```

```text
https://api1.tradingworks.net/api/v2/activities/customerstatus/9999?status
```

--------------------------------

### Apagar Projeto Método

Source: https://suporte.tradingworks.net/article/14-projetos

Método HTTP para apagar um projeto.

```text
DELETE
```

--------------------------------

### PUT /api/v2/activities/customerstatus/{id}

Source: https://suporte.tradingworks.net/article/12-atividades

Atualiza o status de um log de atividade específico. O campo status é um valor inteiro utilizado para fins de controle interno do cliente.

```APIDOC
## PUT /api/v2/activities/customerstatus/{id}

### Description
Atualiza o status de um log de atividade específico. O campo status não influencia o sistema TradingWorks, sendo destinado a procedimentos internos do cliente.

### Method
PUT

### Endpoint
https://api1.tradingworks.net/api/v2/activities/customerstatus/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - O identificador do log de atividade.

#### Query Parameters
- **status** (integer) - Optional - O valor do status a ser atribuído ao log de atividade.

### Headers
- **AUTH-TOKEN** (string) - Required - Sua chave privada de autenticação.
```

--------------------------------

### Parâmetros de Consulta para Colaboradores

Source: https://suporte.tradingworks.net/article/13-colaboradores

Exemplos de parâmetros opcionais para a requisição de colaboradores.

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

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

--------------------------------

### Configuração de Acesso à API

Source: https://suporte.tradingworks.net/article/9-informacoes-basicas

Define o endpoint base e os cabeçalhos obrigatórios para autenticação e formato de conteúdo.

```APIDOC
## Informações de Conexão

### Endpoint Base
`https://api1.tradingworks.net`

### Headers Obrigatórios
- **AUTH-TOKEN**: Token de autenticação da sua empresa.
- **Content-Type**: application/json

### Padrão de Dados
- **Data**: Formato "aaaa-mm-dd" (Ex: "2016-05-23")
- **Valores decimais**: Formato "00000.00" (Ex: "4323.44324")
```

--------------------------------

### Editar Projeto Método

Source: https://suporte.tradingworks.net/article/14-projetos

Método HTTP para editar um projeto.

```text
PUT
```

--------------------------------

### Incluir histórico de regra

Source: https://suporte.tradingworks.net/article/317-api-historico-de-regra

Adiciona ou substitui uma regra no histórico do colaborador via método POST. Se a regra já existir para a mesma data, ela será substituída.

```http
POST https://api1.tradingworks.net/v1/rulehistory
```

```json
{
	"EmployeeNumber": "1234675",
	"EmployerImportRef": "1004",
	"RuleCode": "455",
	"BaseDate": "2022-10-04",
	"AuditEmployeeID": "5"
}
```

--------------------------------

### Endpoint de Listagem de Verbas

Source: https://suporte.tradingworks.net/article/318-api-verbas

Endpoint base para realizar a consulta de verbas.

```http
GET https://api1.tradingworks.net/v1/wageitems
```

--------------------------------

### POST https://api1.tradingworks.net/v1/attendances/setsync

Source: https://suporte.tradingworks.net/article/10-apontamentos

Indica que o apontamento foi efetivado nos sistemas internos da empresa e não deve mais aparecer na listagem.

```APIDOC
## POST https://api1.tradingworks.net/v1/attendances/setsync

### Description
Marca um ou mais apontamentos como sincronizados, removendo-os da listagem padrão.

### Method
POST

### Endpoint
https://api1.tradingworks.net/v1/attendances/setsync

### Parameters
#### Request Body
- **AttendanceRegisterID** (integer) - Required - Número do registro que se deseja marcar como sincronizado.

### Request Example
[
  {
   "AttendanceRegisterID": 240341
  },
  {
   "AttendanceRegisterID": 240348
  }
]
```
Tokens:
Raw