Colaboradores / Persons

[PT] Cadastro de Dependentes. [EN] Add Dependents

[PT] Permite cadastrar múltiplos dependentes de uma única vez para um colaborador.

[EN] Allows you to register multiple dependents for a specific employee.

post/persons/{id}/dependents

Request

  • Base URL: https://api.nexti.com
  • URL: https://api.nexti.com/persons/{id}/dependents
  • Auth: OAuth 2 (client credentials, token URL https://api.nexti.com/security/oauth/token)

Path parameters

idinteger required

ID do colaborador a quem os dependentes estão vinculados.

Request body

typeinteger required

[PT]ID do tipo de dependente. Valores: [ID - 1] - CÔNJUGE OU COMPANHEIRO [ID - 2] - FILHO(A) [ID - 3] - ENTEADO(A) [ID - 4] - PAI/MÃE [ID - 5] - SOGRO(A) [ID - 6] - IRMÃO(Ã) [ID - 7] - NETO(A) [ID - 8] - BISNETO(A) [ID - 9] - AVÔ/AVÓ [ID - 10] - SOBRINHO(A) [ID - 11] - PRIMO(A) [ID - 12] - CUNHADO(A) [ID - 13] - PADRASTO/MADRASTA [ID - 14] - GENRO/NORA [EN]Dependent type ID. Values: [ID - 1] - SPOUSE OR PARTNER [ID - 2] - SON/DAUGHTER [ID - 3] - STEPSON/STEPDAUGHTER [ID - 4] - FATHER/MOTHER [ID - 5] - FATHER-IN-LAW/MOTHER-IN-LAW [ID - 6] - BROTHER/SISTER [ID - 7] - GRANDCHILD [ID - 8] - GREAT-GRANDCHILD [ID - 9] - GRANDFATHER/GRANDMOTHER [ID - 10] - NEPHEW/NIECE [ID - 11] - COUSINS [ID - 12] - BROTHER-IN-LAW/SISTER-IN-LAW [ID - 13] - STEPFATHER/STEPMOTHER [ID - 14] - SON-IN-LAW/DAUGHTER-IN-LAW

namestring required

[PT]Nome do dependente [EN]Dependent name

birthDatestring required

[PT]Data de nascimento [EN]Birth date

mothersNamestring

[PT]Nome da mãe [EN]Mother's name

cpfstring required

[PT]CPF do dependente [EN]Dependent register number

registerNumberstring

[PT]Registro Geral [EN]Register Number

issueDateRegisterNumberstring

[PT]Data de emissão do documento [EN]Issuing date

dependentStateinteger

[PT]Estado do dependente [EN]Dependent State

phonestring

[PT]Telefone [EN]Phone Number

emailstring

[PT]E-mail [EN]Email

maritalStatusinteger

[PT]Estado civil. Valores: [ID - 1] - SOLTEIRO(A) [ID - 2] - CASADO(A) [ID - 3] - UNIÃO ESTÁVEL [ID - 4] - DIVORCIADO(A) [ID - 5] - VIÚVO(A) [EN]Marital Status. Values: [ID - 1] - SINGLE [ID - 2] - MARRIED [ID - 3] - STABLE UNION [ID - 4] - DIVORCED [ID - 5] - WIDOWER

genderstring

[PT]Gênero. Valores: [M] - MASCULINO [F] - FEMININO [O] - OUTROS [EN]Gender. Values: [M] - MALE [F] - FEMALE [O] - OTHER

activateHealthPlanboolean

[PT]Ativar plano de saúde [EN]Activate Health Plan

activateDentalPlanboolean

[PT]Ativar plano odontológico [EN]Activate Dental Plan

Example request

[
  {
    "type": 1,
    "dependentState": 1,
    "email": "email@example.com",
    "maritalStatus": 2,
    "gender": "M",
    "activateHealthPlan": true
  }
]

Response

OK

idinteger

ID do response

messagestring

Mensagem do response

commentsstring[]

Comentários do response

Example response

[
  {
    "value": {
      "type": 1,
      "dependentState": 1,
      "email": "email@example.com",
      "maritalStatus": 2,
      "gender": "M",
      "activateHealthPlan": true
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.