Criar Relacionamento Pessoa x Empresa

Esse endpoint permite cadastrar um relacionamento entre uma Empresa e uma Pessoa que já esteja previamente cadastrada.

Parâmetros da URL

  • business (string): ID (uuid) da Empresa que terá o relacionamento cadastrado.

Parâmetros da Requisição

  • person (object, obrigatório): Objeto contendo os detalhes da Pessoa a ser relacionada com a Empresa.
    • id (string/uuid v4, obrigatório): ID da Pessoa gerado no momento do cadastro.
  • type (string, obrigatório): O tipo do relacionamento. Valores aceitos: PARTNER, MANAGER, PROXY, OTHER, EMPLOYEE.
  • signer (boolean): Indica se a pessoa é representante e pode assinar pela Empresa.
  • share (decimal): Indica o percentual de participação no contrato social. Valores aceitos entre '0' e '1'

Exemplo de requisição:

{
  "person": {
    "id": ""
  },
  "type": "",
  "signer": true,
  "share": 1
}

Resposta

Se o relacionamento for cadastrado com sucesso, o retorno será um código 200 e um JSON com os seguintes campos:

  • id (string): O ID do relacionamento criado.
  • person (object): Objeto contendo os detalhes da Pessoa a ser relacionada com a Empresa.
    • id (string/uuid v4): ID da Pessoa gerado no momento do cadastro.
  • type (string): O tipo do relacionamento que foi criado.
  • signer (boolean): Indicando se a pessoa é representante e pode assinar pela Empresa.
  • share (decimal): Indicando o percentual de participação no contrato social.
  • created_at (string): A data/hora que o relacionamento foi cadastrado.
  • version (integer): O número de controle da versão do cadastrado.
  • share (decimal): Valor da participação no contrato social.

Exemplo de resposta:

{
  "id": "",
  "type": "",
  "person": {
    "id": "",
    "full_name": "",
    "taxpayer_id": ""
  },
  "signer": true,
  "created_at": "",
  "version": 0,
  "share": null
}

Language
URL
Click Try It! to start a request and see the response here!