Consulta as configurações empresas/pessoas envolvidas para a conta.

Consulta as configurações empresas/pessoas envolvidas para a conta.

Header Parameters

• x-auth-token string required

  identificador de sessão

Responses

• 200
• 401
• 403
• 404

---

OK

*/*

• Schema
• Example (from schema)

---

Schema

• desativarPartesEnvolvidasCadastradas boolean

  • Caso informado como true, todas as empresas cadastradas em Empresas Envolvidas serão inativadas. - Caso informado como true junto com empresas, seguirá o mesmo funcionamento acima, acrescentando que as empresas informadas serão cadastradas ou reativadas (caso já estejam na base). - A ideia com esse parâmetro é permitir uma requisição que carregue novas empresas na whitelist, inativando as anteriores.
• habilitaPartesEnvolvidas boolean

  Habilita/Desabilita a funcionalidade de whitelist de partes envolvidas

• partes object[]

  para informar as empresas, é necessário que o habilitaEmpresasEnvolvidas seja true (na base ou na requisição).

  Array [

  documento string

  CPF/CNPJ da Parte Envolvida

  razaoSocial string

  Razão social da Parte Envolvida

  situacao string

  Possible values: [ativo, inativo]

  'ativo' ou 'inativo' a parte envolvida na whitelist de partes envolvidas.

  ]

{
  "desativarPartesEnvolvidasCadastradas": false,
  "habilitaPartesEnvolvidas": true,
  "partes": [
    {
      "documento": "string",
      "razaoSocial": "string",
      "situacao": "ativo"
    }
  ]
}

Unauthorized

Forbidden

Not Found

Loading...