GET
/
v1
/
employments
/
{id}
Obter vínculo empregatício
curl --request GET \
  --url https://api.base39.io/v1/employments/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "empl_5f92f01728e009f403d8502e",
  "status": "working",
  "grossSalary": 49999.5,
  "netSalary": 49999.5,
  "hiredAt": "2023-12-25",
  "limitPerInstallment": 123,
  "limitPerLoan": 123,
  "customer": {
    "document": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "birthDate": "<string>",
    "externalId": "<string>"
  },
  "company": "comp_62d9889bd3985729e5a048ef",
  "role": "Desenvolvedor",
  "description": "<string>",
  "date": "2023-12-25",
  "severancePayment": 123,
  "transferredTo": "comp_62d9889bd3985729e5a048ef",
  "transferredFrom": "comp_62d9889bd3985729e5a048ef",
  "expiredAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required
  • O ID do object

Query Parameters

​
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

​
fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Response

200 - application/json

Retorna o objeto Employment para um ID válido. Se for para um vínculo empregatício excluído, um subconjunto das informações do vínculo empregatício será retornado, incluindo uma propriedade deleted definida como true.

Este objeto representa um vínculo empregatício.

​
id
string

Identificador exclusivo para o objeto.

Example:

"empl_5f92f01728e009f403d8502e"

​
status
enum<string>

Status do vínculo empregatício

Available options:
working,
vacation,
terminated,
deceased,
away,
transferred
Example:

"working"

​
grossSalary
number

Salário bruto

Required range: 0 <= x <= 99999
​
netSalary
number

Salário líquido

Required range: 0 <= x <= 99999
​
hiredAt
string<date>

Data de admissão

​
limitPerInstallment
number

Margem consignável. Valor máximo de cada parcela.

​
limitPerLoan
number

Limite máximo por empréstimo.

​
customer
object
​
company
string
Example:

"comp_62d9889bd3985729e5a048ef"

​
role
string
Example:

"Desenvolvedor"

​
description
string

Justificativa ou motivo por trás de uma ação específica, por exemplo, a demissão de um funcionário.

​
date
string<date>

Data em que uma ação específica ocorreu. Por exemplo, data de uma demissão.

​
severancePayment
number

Usado para registrar o valor total acordado como pagamento de indenização para um funcionário no caso de status terminated.

​
transferredTo
string

Este campo representa o identificador da empresa para a qual o funcionário foi transferido. Este campo é obrigatório no caso de status transferred.

Example:

"comp_62d9889bd3985729e5a048ef"

​
transferredFrom
string

Este campo representa o identificador da empresa a partir da qual o funcionário foi transferido. Este campo é preenchido automaticamente no momento da transferência e não pode ser preenchido de forma manual.

Example:

"comp_62d9889bd3985729e5a048ef"

​
expiredAt
string<date-time>

Data de expiração do vínculo empregatício. A data de expiração é automaticamente calculada considerando a data de criação do vínculo empregatício somado ao valor em dias definido na configuração global(settings.employments) ou na configuração da empresa (company.settings.employments). Quando o valor de dias para expiração for -1 representa que não há data prevista para encerramento do vínculo empregatício.

​
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

​
createdAt
string<date-time>

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
updatedAt
string<date-time>

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
deleted
boolean
default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false