Pular para o conteúdo principal

Obter vínculo empregatício

GET 
/v1/employments/:id

Retorna um objeto Employment

Request​

Path Parameters

    id stringrequired
    • O ID do object
    Example: obj_5f92f01728e009f403d8502e

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:

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

    Example: id,createdAt

Responses​

Retorna o objeto Employment para um ID válido; para vínculo excluído, retorna um subconjunto com deleted: true.

Schema

    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.

    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