Obter vínculo empregatício

Retorna um objeto Employment

Authorizations

Authorization

string

headerrequired

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

id

string

Identificador exclusivo para o objeto.

status

enum<string>

Status do vínculo empregatício

Available options:

working,

vacation,

terminated,

deceased,

away,

transferred

grossSalary

number

Salário bruto

netSalary

number

Salário líquido

hiredAt

string

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

Show child attributes

company

string

role

string

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

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.

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.

expiredAt

string

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

Data de criação do objeto

updatedAt

string

Data de alteração do objeto

deleted

boolean

default: false

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