# V2

## CONFIGURAÇÃO

<figure><img src="https://1906991432-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FABFcMeFxBJhKzVOwJbRE%2Fuploads%2FhRSBQnncoMzfTrx0mwix%2Fimage.png?alt=media&#x26;token=fbf7b827-700b-480e-9b23-67e9b4302913" alt=""><figcaption><p>Configuração Geral do Objeto V2</p></figcaption></figure>

**Preenchendo o Objeto:**

| Campo                                                                                    | Descritivo                                                                                                                                                                                                                                                                                                   |
| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Título                                                                                   | É o nome do objeto e **não precisa ser alterado**, a menos que você queira identificá-lo para facilitar a localização dele no robô, por exemplo: "Sintegra - São Paulo".                                                                                                                                     |
| Nome Identificador do Objeto                                                             | É um identificador único do objeto e **não precisa ser alterado**, mas você pode renomear caso queira para localizá-lo mais facilmente quando for usá-lo em outros objetos. Apenas lembre-se que esse nome deve ser único e sem espaços ou caracteres especiais.                                             |
| UF                                                                                       | Opção para indicar UF desejada. Não necessário colocar o nome inteiro, somente a sigla do Estado.                                                                                                                                                                                                            |
| CNPJ                                                                                     | Opção para preencher o CNPJ desejado.                                                                                                                                                                                                                                                                        |
| Inscrição Estadual                                                                       | Opção para inserir Inscrição estadual a ser buscada.                                                                                                                                                                                                                                                         |
| Check Retornar todas as IEs (Apenas Estado do Amazonas, Distrito Federal e Minas Gerais) | Opção para fazer o retorno de todas as IEs cadastradas na Empresa.                                                                                                                                                                                                                                           |
| Check Tirar print da página                                                              | Tirar print do resultado da consulta.                                                                                                                                                                                                                                                                        |
| Check Consultar Online                                                                   | Quando assinalado, ele realiza a consulta online sem verificar o banco de dados. Quando **não** assinalado, consulta o banco de dados da Roboteasy e verifica se houve alguma consulta nos últimos 3 dias, casa tenha, retorna os dados da consulta antiga, senão ele realiza a consulta online normalmente. |
| Check Salvar o Resultado em um PDF                                                       | Cria um PDF com o resultado da consulta.                                                                                                                                                                                                                                                                     |
| Check Restringir download para arquivos maliciosos                                       | Ação para download de arquivos maliciosos.                                                                                                                                                                                                                                                                   |
| Utilizar proxy                                                                           | Opção para Utilizar IP Proxy na consulta, a funcionalidade atualmente está disponível apenas para o estado de Santa Catarina.                                                                                                                                                                                |

## RETORNOS

⇒ INSERIR GIF DE COMO ACESSAR OS RETORNOS

Para acessar um retorno basta colocar o nome identificador do objeto na frente de uma propriedade.

* Acessar dados da **EXECUÇÃO DO ROBÔ**.

<table><thead><tr><th width="292">Informação</th><th width="222">Propriedade</th><th>Retorno</th></tr></thead><tbody><tr><td>CNPJ</td><td>.Cnpj</td><td>Retona o CNPJ informado no objeto.</td></tr><tr><td>Inscrição Estadual</td><td>.Ie</td><td>Retorna a Inscrição Estadual informada no objeto.</td></tr><tr><td>Estado</td><td>.State</td><td>Retorna o Estado informado no objeto.</td></tr><tr><td>Tempo de Execução</td><td>.ExecutionTime</td><td>Retorna o tempo de execução do robô.</td></tr><tr><td>Restringir Download para Arquivos Maliciosos?</td><td>.EnableSafeBrowsing</td><td>Retona se "Restringir Download para Arquivos Maliciosos" foi marcada.</td></tr><tr><td>Salvar Resultados em PDF?</td><td>.GeneratePdf</td><td>Retona se "Salvar Resultados em PDF" foi marcada.</td></tr><tr><td>Consulta Online?</td><td>.OnlineConsultant</td><td>Retona se "Consulta Online" foi marcada.</td></tr><tr><td>Retornar Todas as Inscrições Estaduais?</td><td>.ReturnAllIe</td><td>Retona se "Retornar Todas as Inscrições Estaduais" foi marcada.</td></tr><tr><td>Retorno Padrão?</td><td>.StandardizedReturn</td><td>Retona se "Retorno Padrão" foi marcada.</td></tr><tr><td>Utilizar Proxy?</td><td>.UseProxy</td><td>Retona se "Utilizar Proxy" foi marcada.</td></tr><tr><td>Caminho do diretório</td><td>.Path</td><td>Retorna o diretório do Print ou do PDF.</td></tr><tr><td>Retorno da execução da consulta</td><td>.Result</td><td>Retorna as informações da execução da consulta.</td></tr><tr><td>Número do documento utilizado na pesquisa(CNPJ ou IE)</td><td>.Result.value</td><td>Retorna o número do documento utilizado na pesquisa.</td></tr><tr><td>Tipo de documento (CNPJ ou IE)</td><td>.Result.type</td><td>Retona o tipo de documento(CNPJ ou IE).</td></tr><tr><td>Código Status da consulta</td><td>.Result.code</td><td>Retorna o Código Status da Consulta (SIN001 indica sucesso).</td></tr><tr><td>Mensagem do status da consulta</td><td>.Result.message</td><td>Retorna a mensagem do Status da consulta.</td></tr><tr><td>Caminho do arquivo gerado (Print ou PDF)</td><td>.Result.path_save</td><td>Retorna o caminho o caminho do Print ou do PDF.</td></tr><tr><td>Mensagem do resultado da Print</td><td>.Result.screenshot_result</td><td>Retorna a mensagem do resultado do Print.</td></tr></tbody></table>

* Acessar **DADOS DAS IEs**

O robô retorna uma lista com todas as IEs e suas informações com base nas informações inseridas no objeto. Para acessar a lista basta utilizar **.Result.datas . P**ara acessar uma IE específica basta utlizar **.Result.datas\[posicao],** em que "posicao" é a posição em que a IE está na lista (iniciando por 0). O número "0" presente na tabela é somente um exemplo.

<table data-full-width="false"><thead><tr><th>Informação</th><th width="330">Propriedade</th><th>Retorno</th></tr></thead><tbody><tr><td>Lista com os dados das IEs encontrados</td><td>.Result.datas</td><td>Retorna a lista com todas as IEs e suas informações.</td></tr><tr><td>Dados da primeira IE encontrada</td><td>.Result.datas[0]</td><td>Retorna todos os dados de uma IE específica.</td></tr><tr><td>CNPJ</td><td>.Result.datas[0].CNPJ</td><td>Retorna o CNPJ da IE.</td></tr><tr><td>CPF</td><td>.Result.datas[0].CPF</td><td>Retorna o CPF da IE.</td></tr><tr><td>Inscrição Estadual</td><td>.Result.datas[0].IE</td><td>Retorna o número da IE.</td></tr><tr><td>Razão Social</td><td>.Result.datas[0].RazaoSocial</td><td>Retorna a razão social da IE.</td></tr><tr><td>Nome Fantasia</td><td>.Result.datas[0].NomeFantasia</td><td>Retorna o nome fantasia da IE.</td></tr><tr><td>Data Inscrição Estadual</td><td>.Result.datas[0].DataInscricaoEstadual</td><td>Retorna a data da inscrição estadual.</td></tr><tr><td>Situação Cadastral Sintegra</td><td>.Result.datas[0].SituacaoCadastralSintegra</td><td>Retorna a Situação Cadastral da IE no Sintegra.</td></tr><tr><td>Situação Cadastral</td><td>.Result.datas[0].SituacaoCadastral</td><td>Retorna a Situação Cadastral da IE.</td></tr><tr><td>Regime de Apuração do ICMS</td><td>.Result.datas[0].RegimeApuracaoICMS</td><td>Retorna o Regime de Apuração de ICMS da IE.</td></tr><tr><td>UF (Unidade Federal)</td><td>.Result.datas[0].UF</td><td>Retorna a UF da IE.</td></tr><tr><td>Município</td><td>.Result.datas[0].Municipio</td><td>Retorna o município da IE.</td></tr><tr><td>CEP</td><td>.Result.datas[0].CEP</td><td>Retorna o CEP da IE.</td></tr><tr><td>Bairro</td><td>.Result.datas[0].Bairro</td><td>Retorna o bairro da IE.</td></tr><tr><td>Logradouro</td><td>.Result.datas[0].Logradouro</td><td>Retorna o Logradouro da IE.</td></tr><tr><td>Complemento sobre o Endereço</td><td>.Result.datas[0].Complemento</td><td>Retorna o complemento do endereço da IE.</td></tr><tr><td>Número</td><td>.Result.datas[0].Numero</td><td>Retorna o número do endereço da IE.</td></tr><tr><td>Telefone</td><td>.Result.datas[0].Telefone</td><td>Retorna o telefone da IE.</td></tr><tr><td>Endereço Eletrônico (Email)</td><td>.Result.datas[0].EnderecoEletronico</td><td>Retorna o endereço da IE.</td></tr><tr><td>Atividade Econômica Principal</td><td>.Result.datas[0].AtividadePrincipal</td><td>Retorna as Informações da Atividade Principal da IE.</td></tr><tr><td>Código CNAE</td><td>.Result.datas[0].AtividadePrincipal.CNAE</td><td>Retorna o código CNAE da Atividade Principal da IE.</td></tr><tr><td>Descrição CNAE</td><td>.Result.datas[0].AtividadePrincipal.Descricao</td><td>Retorna a Descrição do CNAE da Atividade Principal da IE.</td></tr><tr><td>Data Inicial</td><td>.Result.datas[0].AtividadePrincipal.DataInicial</td><td>Retorna a data inicialda atividade principal da IE.</td></tr></tbody></table>

* Acessar dados das **ATIVIDADES SECUNDÁRIAS** de uma IE.

Para cada IE, o robô retorna uma lista com todas as atividades secundárias da IE. Para acessar a lista basta utilizar **.Result.datas\[0].OutrasAtividades.** **P**ara acessar uma atividade secundária específica basta utlizar **.Result.datas.OutrasAtividades\[posicao],** em que "posicao" é a posição em que a atividade secundária está na lista (iniciando por 0). O número "0" presente na tabela é somente um exemplo.

<table><thead><tr><th width="221">Informação</th><th width="350">Propriedade</th><th>Retorno</th></tr></thead><tbody><tr><td>Lista com as Atividades Secundárias</td><td>.Result.datas[0].OutrasAtividades</td><td>Retorna uma lista com todas as Atividades secundárias de uma IE.</td></tr><tr><td>Dados de uma Atividade Secundária</td><td>.Result.datas[0].OutrasAtividades[0]</td><td>Retorna os dados de uma Atividade Secundária.</td></tr><tr><td>Código CNAE</td><td>.Result.datas[0].OutrasAtividades[0].CNAE</td><td>Retorna o Código CNAE de uma Atividade Secundária.</td></tr><tr><td>Descrição da CNAE</td><td>.Result.datas[0].OutrasAtividades[0].Descricao</td><td>Retorna a Descrição do CNAE da Atividade Secundária. </td></tr><tr><td>Data Inicial</td><td>.Result.datas[0].OutrasAtividades[0].DataInicial</td><td>Retorna a Data Inicial da Atividade Secundária.</td></tr></tbody></table>

## CÓDIGOS E MENSAGENS DE RETORNO

Utilizando-se do .Result, é possível obter o código e a mensagem de retorno do processamento do robô pronto. Contudo, existem códigos que possibilitam maiores detalhes:

* .code (para obter o código do processamento)&#x20;
* .message (para obter a mensagem do processamento).&#x20;

Esses códigos são necessários para realizar uma validação de maior precisão quanto ao funcionamento do robô pronto.

Abaixo segue a relação dos códigos e mensagens disponíveis atualmente no robô.

| .Result.code | .Result.message                                                                                |
| ------------ | ---------------------------------------------------------------------------------------------- |
| SIN000       | Erro inesperado!                                                                               |
| SIN001       | Valores extraídos com sucesso!                                                                 |
| SIN010       | Site indisponível no momento. Tente novamente mais tarde!                                      |
| SIN011       | Resultado indisponível no momento. Tente novamente mais tarde!                                 |
| SIN012       | Erro da pagina:                                                                                |
| SIN013       | Mais de uma IE para o CNPJ informado. Deve ser consultado por IE.                              |
| SIN014       | Documento inválido, não informado ou não suportado no portal do estado                         |
| SIN015       | Erro inesperado! Não foi possível gerar o Token                                                |
| SIN016       | Tipo de busca não informada                                                                    |
| SIN017       | Documento não informado ou não encontrado no Cadastro de Contribuinte do ICMS                  |
| SIN018       | Erro ao executar sintegra: {motivoDoErro}                                                      |
| SIN019       | Excesso de tentativas alcançado: {motivoDoErro}                                                |
| SIN020       | Falha ao capturar imagem das informações durante a consulta do Sintegra: {motivoDoErro}        |
| SIN021       | Erro ao converter arquivo PDF para HTML: {motivoDoErro}                                        |
| SIN022       | Aconteceu um erro no captcha, favor tente novamente!                                           |
| SIN023       | Não existe registro de Inscrição Estadual na Secretaria de Estado da Fazenda de Santa Catarina |
| SIN024       | Site não carregou a informação correta!                                                        |

## CASOS DE USO

* Utilizar para consultar informações gerais de empresas e caso deseje salvar essas informações para automação posterior.

## EXEMPLO

**Utilizar CNPJ da empresa desejada para verificar as informações em tela e caixa de mensagem.**