Criar vínculo empregatício

POST 
/v1/employments

Cria um novo vínculo empregatício.

Request

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.
Example: data.loan
fields string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Examples:

inclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

Header Parameters

Idempotency-Key string
Chave única de idempotência para evitar duplicação de requisições.
Example: 5f92f01728e009f403d8502e
base39-external-client-id string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

application/json

Body

status stringrequired
Status do vínculo empregatício
Possible values: [working, vacation, terminated, deceased, away, transferred]
Example: working
grossSalary double

Salário bruto

Possible values: <= 99999

netSalary double

Salário líquido

Possible values: <= 99999

hiredAt date

Data de admissão

limitPerInstallment double

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

limitPerLoan double

Limite máximo por empréstimo.

customer

object

required

document stringrequired

Documento de identificação do vínculo empregatício. Deve ser o CPF.

name string

email string

phone string

birthDate string

externalId string
company stringrequired
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 date

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

severancePayment double

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
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.

Responses

201

Retorna o objeto Employment se a criação for bem-sucedida; retorna erro se os parâmetros forem inválidos, como um documento incorreto.

application/json

Schema

Schema

id string
Identificador exclusivo para o objeto.
Example: empl_5f92f01728e009f403d8502e
status string
Status do vínculo empregatício
Possible values: [working, vacation, terminated, deceased, away, transferred]
Example: working
grossSalary double

Salário bruto

Possible values: <= 99999

netSalary double

Salário líquido

Possible values: <= 99999

hiredAt date

Data de admissão

limitPerInstallment double

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

limitPerLoan double

Limite máximo por empréstimo.

customer

object

document stringrequired

Documento de identificação do vínculo empregatício. Deve ser o CPF.

name string

email string

phone string

birthDate string

externalId string
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 date

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

severancePayment double

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 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 date-time
Data de criação do objeto
Example: 2023-08-25T22:38:41.134Z
updatedAt date-time
Data de alteração do objeto
Example: 2023-08-25T22:38:41.134Z
deleted boolean
Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.
Default value: false
Example: false
houseTime string
Tempo de casa do funcionário na empresa em meses. Este campo é preenchido automaticamente, levando em conta o campo hiredAt no momento da criação do vínculo empregatício e não pode ser preenchido de forma manual.
Example: 12
eligible boolean
Este campo representa se o funcionário é elegível para empréstimos. Este campo é preenchido automaticamente, levando em conta os campos netSalary, grossSalary e expiredAt. E não pode ser preenchido de forma manual.
Example: true

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

Example (from schema)

{
  "id": "empl_5f92f01728e009f403d8502e",
  "status": "working",
  "grossSalary": 0,
  "netSalary": 0,
  "hiredAt": "2024-07-29",
  "limitPerInstallment": 0,
  "limitPerLoan": 0,
  "customer": {
    "document": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "birthDate": "string",
    "externalId": "string"
  },
  "company": "comp_62d9889bd3985729e5a048ef",
  "role": "Desenvolvedor",
  "description": "string",
  "date": "2024-07-29",
  "severancePayment": 0,
  "transferredTo": "comp_62d9889bd3985729e5a048ef",
  "transferredFrom": "comp_62d9889bd3985729e5a048ef",
  "expiredAt": "2024-07-29T15:51:28.071Z",
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "houseTime": 12,
  "eligible": true,
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  }
}

Loading...