Employments

Uma lista de vínculos empregatícios.

hasMoreboolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example: true

data object[]

Uma lista de vínculos empregatícios

Array [

idstring

Identificador exclusivo para o objeto.

Example: empl_5f92f01728e009f403d8502e

statusstring

Status do vínculo empregatício

Possible values: [working, vacation, terminated, deceased, away, transferred]

Example: working

grossSalarydouble

Salário bruto

Possible values: <= 99999

netSalarydouble

Salário líquido

Possible values: <= 99999

hiredAtdate

Data de admissão

limitPerInstallmentdouble

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

limitPerLoandouble

Limite máximo por empréstimo.

customer object

documentstringrequired

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

namestring

emailstring

phonestring

birthDatestring

externalIdstring

companystring

Example: comp_62d9889bd3985729e5a048ef

rolestring

Example: Desenvolvedor

descriptionstring

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

datedate

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

severancePaymentdouble

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

transferredTostring

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

transferredFromstring

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

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

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

expiredboolean

Indica se o vínculo empregatício está expirado.

metadataobject

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.

createdAtdate-time

Data de criação do objeto

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

updatedAtdate-time

Data de alteração do objeto

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

deletedboolean

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

Default value: false

Example: false

houseTimestring

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

eligibleboolean

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

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

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.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

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.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

]

Employments

{
  "hasMore": true,
  "data": [
    {
      "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",
      "expiresAt": "2024-07-29T15:51:28.071Z",
      "expired": true,
      "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"
      }
    }
  ]
}