Collaborators API (1.0.0)

Download OpenAPI specification:Download

Employee

Employee by ID

path Parameters

EmployeeId

required

string

Example: 19016b80-2f9f-472d-acb9-4cd696a492d9

header Parameters

AccountId

string

Example: 19016b80-2f9f-472d-acb9-4cd696a492d9

Responses

Employee by ID

path Parameters

EmployeeId

required

string

Example: 19016b80-2f9f-472d-acb9-4cd696a492d9

header Parameters

accountid

string

Example: d97bb410-4502-4bb9-a69e-7ed550795527

Request Body schema: application/json

active	boolean
	object
birthdate	string
department	string
id	string
identificator	string
identificatorType	string
inactivated_at	string
name	string
phone	string
role	string
unit	string

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"admission": {"date": "2021-09-24T00:00:00Z",
"employeeCode": "1810",
"id": "dd8b0505-5f46-4fc1-b260-e5a8555c9345",
"organizationID": "7c15017b-3c9f-45e9-9833-53fcc82247a8",
"salary": "1700"
},
"birthdate": "1990-07-10T00:00:00Z",
"department": "a3cf20e4-6932-4a59-b219-ca2875e6adb3",
"id": "8b8c2eae-8faf-49fc-a730-37b72a0e6856",
"identificator": "05478411086",
"identificatorType": "cpf",
"inactivated_at": "0001-01-01T00:00:00Z",
"name": "Mia Gregory",
"phone": "11945086704",
"role": "40dbbcb0-e2cd-44c7-b37d-2dc2b0b2d979",
"unit": "1adb4644-3524-47bd-9bc0-187a6b1123f0"
}

List Signs

path Parameters

EmployeeId

required

string

Example: 19016b80-2f9f-472d-acb9-4cd696a492d9

header Parameters

accountid

string

Example: d97bb410-4502-4bb9-a69e-7ed550795527

Responses

Get activity by employee

path Parameters

EmployeeId

required

string

Example: 19016b80-2f9f-472d-acb9-4cd696a492d9

query Parameters

sortOrder

string

Example: sortOrder=desc

header Parameters

accountid

string

Example: 19016b80-2f9f-472d-acb9-4cd696a492d9

Request Body schema: application/json

roles

number

Responses

Request samples

Payload

Content type

application/json

{"roles": 1
}

Status by ID

path Parameters

EmployeeId

required

string

Example: 19016b80-2f9f-472d-acb9-4cd696a492d9

header Parameters

accountid

string

Example: d97bb410-4502-4bb9-a69e-7ed550795527

Request Body schema: application/json

active

boolean

Responses

Request samples

Payload

Content type

application/json

{"active": false
}

Status Many by ID

header Parameters

AccountId

string

Example: 18d96f11-eca5-4057-bdf4-a9d8cc76ac8b

Request Body schema: application/json

active	boolean
employeeIDs	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"employeeIDs": ["69f93af4-9087-4d53-b8bf-86b4eb65a22f",
"486535d2-0a4b-4c22-a7a3-ecf7e38311b2"
]
}

IDs by filter

header Parameters

Accountid

string

Example: 18d96f11-eca5-4057-bdf4-a9d8cc76ac8b

Request Body schema: application/json

departments	Array of any
roles	Array of any
status	boolean
units	Array of any

Responses

Request samples

Payload

Content type

application/json

Example

By ID

{"departments": [ ],
"roles": [ ],
"status": true,
"units": [ ]
}

Get Employees

query Parameters

page	string Example: page=1
pageSize	string Example: pageSize=10
active	string Example: active=true
order	string Example: order=asc

header Parameters

accountid

string

Example: 19016b80-2f9f-472d-acb9-4cd696a492d9

Responses

List

query Parameters

page	string Example: page=1
pageSize	string Example: pageSize=10
order	string Example: order=asc
active	string Example: active=true

header Parameters

accountid	string Example: d97bb410-4502-4bb9-a69e-7ed550795527
Accountid	string Example: 18d96f11-eca5-4057-bdf4-a9d8cc76ac8b

Request Body schema: application/json

cpf	string
email	string
employeeCode	string
name	string
phone	string
situation	boolean

Responses

Request samples

Payload

Content type

application/json

Example

List

{"status": true
}

Create from Onboarding

header Parameters

accountid

string

Example: 18d96f11-eca5-4057-bdf4-a9d8cc76ac9a

Request Body schema: application/json

admissionDate	string
birthdate	string
cpf	string
departmentID	string
email	string
employeeCode	string
name	string
organizationID	string
phone	string
position	string
relation	string
roleID	string
salary	string
unit	string

Responses

Request samples

Payload

Content type

application/json

{"admissionDate": "2022-12-08T03:00:00.000Z",
"birthdate": "1990-07-03T00:00:00.000Z",
"cpf": "2987436394",
"departmentID": "62a8c500-4aa1-4bae-bf0c-52cd38d7cfb6",
"email": "squad.produtorh+homer.simpson@acesso.io",
"employeeCode": "9123123332",
"name": "Marcos Collab",
"organizationID": "896ffd1d-a3a9-43df-a2e8-eed057fe40e6",
"phone": "5511973839473",
"position": "58cfef3f-4095-4d55-bf05-bbce9b913f19",
"relation": "clt",
"roleID": "f80360a8-f858-4714-ad2b-6a5b8329a79e",
"salary": "1110",
"unit": "82930d53-e99a-4927-b31e-4fdc7090395d"
}

Search

header Parameters

AccountId

string

Example: 18d96f11-eca5-4057-bdf4-a9d8cc76ac9a

Request Body schema: application/json

account	string
departments	Array of any
roles	Array of any
search	string
status	boolean
units	Array of any

Responses

Request samples

Payload

Content type

application/json

{"account": "18d96f11-eca5-4057-bdf4-a9d8cc76ac9a",
"departments": [ ],
"roles": [ ],
"search": "",
"status": true,
"units": [ ]
}

Import

list import file

query Parameters

account

string

Example: account=4514c4d4-d8dc-4595-8c03-b255f4e0f478

header Parameters

accountid

string

Example: 4514c4d4-d8dc-4595-8c03-b255f4e0f478

Responses

ImportFile

query Parameters

account

string

Example: account=4514c4d4-d8dc-4595-8c03-b255f4e0f478

header Parameters

accountid

string

Example: 4514c4d4-d8dc-4595-8c03-b255f4e0f478

Request Body schema: multipart/form-data

file	string <binary>

Responses

get import file

path Parameters

ProtocolId

required

string

Example: 19016b80-2f9f-472d-acb9-4cd696a492d9

query Parameters

account

string

Example: account=4514c4d4-d8dc-4595-8c03-b255f4e0f478

header Parameters

accountid

string

Example: 4514c4d4-d8dc-4595-8c03-b255f4e0f478

Responses

get url error file

path Parameters

ProtocolId

required

string

Example: 19016b80-2f9f-472d-acb9-4cd696a492d9

query Parameters

account

string

Example: account=19016b80-2f9f-472d-acb9-4cd696a492d9

header Parameters

accountid

string

Example: 4514c4d4-d8dc-4595-8c03-b255f4e0f478

Responses

webhook

Get Configuration

header Parameters

accountid

string

Example: 4514c4d4-d8dc-4595-8c03-b255f4e0f478

Responses

Create Configuration

header Parameters

accountid

string

Example: 4514c4d4-d8dc-4595-8c03-b255f4e0f478

Request Body schema: application/json

endpoint	string
events	Array of strings
	object

Responses

Request samples

Payload

Content type

application/json

{"endpoint": "https://webhook.site/b57864a0-2a9e-436e-8a87-e2453c418a19",
"events": ["EMPLOYEE_CREATION",
"EMPLOYEE_UPDATE",
"IMPORT_FINISH"
],
"headers": {"post": "man"
}
}

Transport-Voucher

Capta/Amendment

Request Body schema: application/json

codigo	number
	object
msg	string
protocolo	number

Responses

Request samples

Payload

Content type

application/json

{"codigo": 0,
"dadosConsulta": {"compraVt": [{"codItemVT": "309114",
"descOperadora": "CARTÃO FÁCIL DF",
"descVT": "DF TRANS - TARIFA 3",
"operadora": "309",
"qt": 2,
"tarifa": 5
},
{"codItemVT": "309114",
"descOperadora": "CARTÃO FÁCIL DF",
"descVT": "Bilhete diferente de todos os outros",
"operadora": "309",
"qt": 1,
"tarifa": 15
}
],
"cpf": "579.959.200-08",
"dadosGerais": {"codLocalTrab": "393866303",
"codigoIndiceCrime": 0,
"descIndiceCrime": "Sem Índice",
"descLocalTrab": "ITA PEÇAS PARA VEICULOS COMERCIO E SERVI",
"descricaoTrajeto": "",
"despRegional": 0,
"destBairro": "",
"destCidade": "",
"destLat": 0,
"destLogra": "",
"destLong": 0,
"destNum": 0,
"destUF": "",
"distEmarque": 1000,
"distIda": 44116,
"distVolta": 44116,
"endDestCep": "",
"gastoTotalMensalAntes": 60,
"gastoTotalMensalDepois": 11,
"horaEntrada": "08:00",
"horaSaida": "18:00",
"latitude": -16.0234585,
"linkMapa": "",
"locBairro": "locBairro",
"locCep": "0000-100",
"locCidade": "CITY",
"locLogradouro": "locLogradouro",
"locNumero": 0,
"locTrabLatitude": -15.7359657,
"locTrabLongitude": -47.90535,
"locUF": "DF",
"longitude": -48.0541725,
"no": 0,
"origBairro": "",
"origCep": "",
"origCidade": "",
"origLat": 0,
"origLogra": "",
"origLong": 0,
"origNum": 0,
"origUF": "",
"percentualEconomia": 81.67,
"percentualEconomiaVeiculo": 0,
"resBairro": "Setor Leste (Gama)",
"resCep": "72460-330",
"resCidade": "Brasília",
"resLogradouro": "33",
"resNumero": 107,
"resUF": "DF",
"totalKmVeiculo": 0,
"totalLinhas": 2,
"totalMensalVeiculo": 0,
"urlMapa": "http://reduxbeneficios.com.br/mapas/4664117.jpg",
"valorDiario": 60,
"valorDiarioVeiculo": 0,
"valorEconomia": 49,
"valorIdealDiario": 11,
"valorKmLitro": 0
},
"dataProcessamento": "2023-04-06T15:50:24",
"descStatusProc": "Processado - Otimizado Totalmente",
"numeroConsulta": 4664117,
"procedimentosAutoAtendimento": [ ],
"statusProcessamento": 54,
"trajeto": [{"descDesembarque": "44 200",
"descEmbarque": "33 107",
"descTipoTransporte": "Caminhada",
"descVT": "Caminhada",
"desembarqueLat": -16.02332,
"desembarqueLng": -48.05369,
"distancia": 51,
"embarqueLat": -16.02332,
"embarqueLng": -48.05416,
"linha": "8",
"sentido": 1,
"sequencia": 1,
"tempo": 2,
"tipoTransporte": 3,
"valorTrecho": 5
},
{"descDesembarque": "44 200",
"descEmbarque": "33 107",
"descTipoTransporte": "Caminhada",
"descVT": "Caminhada",
"desembarqueLat": -16.02332,
"desembarqueLng": -48.05369,
"distancia": 51,
"embarqueLat": -48.05416,
"embarqueLng": -16.02332,
"linha": "8",
"sentido": 2,
"sequencia": 1,
"tempo": 2,
"tipoTransporte": 3,
"valorTrecho": 5
},
{"descDesembarque": "44 200",
"descEmbarque": "33 107",
"descTipoTransporte": "Caminhada",
"descVT": "Caminhada",
"desembarqueLat": -16.02332,
"desembarqueLng": -48.05369,
"distancia": 51,
"embarqueLat": -16.02332,
"embarqueLng": -48.05416,
"linha": "8",
"sentido": 1,
"sequencia": 1,
"tempo": 2,
"tipoTransporte": 3,
"valorTrecho": 5
}
]
},
"msg": "Processamento concluído",
"protocolo": 280376
}