Como configurar as Partes Envolvidas na entrega de documentos recebidos?

A funcionalidade de cadastro de partes envolvidas torna maix flexível as regras de recebimento de documentos recebidos, permitindo que apenas um determinado grupo de CNPJs e/ou CPFs, que esteja envolvido no documento exercendo uma função (Ex: destinatário), receberá o documento em questão.

Confira abaixo como utilizar esse recurso.

---

Envie uma requisição de configuração de partes envolvidas da conta

1. Para começar, faça uma requisição tipo POST ao endpoint de configurar partes envolvidas;

   [URL_BASE]/api/conta/partes-envolvidas

2. No corpo da requisição (request body) preencha os seguintes parâmetros:

   • {habilitarPartesEnvolvidas}: true ou false. Obrigatório para informar as partes envolvidas;

   • {desativarPartesEnvolvidasCadastradas}: true ou false, por padrão é false. Não é obrigatório;

   • {partes}: Lista de Partes Envolvidas. Os campos de cada parte envolvida são:

     • {documento}: CNPJ ou CPF da parte envolvida;
     • {razaoSocial}: Razão social da parte envolvida;
     • {situacao}: "ativo" ou "inativo". Indica se a parte envolvida estará disponível para uso;

Atenção

Se o parâmetro {desativarPartesEnvolvidasCadastradas} for verdadeiro (true), todas as partes envolvidas previamente cadastradas e as informadas no corpo da requisição (request body) serão inativadas.

Importante

Para editar a {razaoSocial} ou a {situacao} de uma parte envolvida já cadastrada, basta coloca-la nesta mesma requisição, no campo {partes} com os novos valores, que a API Oobj identificará a operação de edição!

1. Informe o x-auth-token no cabeçalho (header parameters) da requisição.

Exemplo de requisição

O exemplo abaixo traz um modelo de requisição preenchido para habilitar e cadastrar as partes envolvidas.

Observação

A requisição contém dados fictícios, somente para demonstração.

curl -L -X POST 'https://rest-teste.oobj.com.br/api/conta/partes-envolvidas' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg' \
--data-raw '{
  "habilitarPartesEnvolvidas": true,
  "partes": [
    {
      "documento": "44444444000191",
      "razaoSocial": "Empresa 1",
      "situacao": "ativo"
    },
    {
      "documento": "33333333000191",
      "razaoSocial": "Empresa 2",
      "situacao": "ativo"
    }
  ]
}'

Exemplo de retorno

{

}

Pronto! Você acaba de completar a configuração do seu servidor.