manual de integração consulta robotizada web service...

62
1 Manual de Integração Consulta Robotizada Web Service Individual Síncrona Padrões Técnicos de Comunicação Versão 4.0 Julho de 2017

Upload: trinhdung

Post on 01-Dec-2018

257 views

Category:

Documents


6 download

TRANSCRIPT

Page 1: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

1

Manual de Integração

Consulta Robotizada Web Service Individual Síncrona

Padrões Técnicos de Comunicação

Versão 4.0

Julho de 2017

Page 2: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

2

Controle de Alterações

Nome Data Versão Obs.

Marcello Paz 30/03/2010 1.0 Criação do documento

Leonardo Bianco 10/04/2010 1.0 Incluídos Parsers SimplesNacional e FDCCNPJ

Leonardo Bianco 20/08/2010 1.0 Correções no parser Sintegra

Leonardo Bianco 13/09/2010 1.0 Incluídos Parsers NIT e QSA

Marcello Paz 15/10/2010

1.0 Incluídas informações detalhadas sobre parâmetros e retornos

dos Parsers. Retirados parsers NIT e QSA por atual

indisponibilidade no WebService.

Marcello Paz 22/10/2010

1.0 Incluídas informações layout Sintegra (ObrigNFE) e

alterações no Layout do Manual

Marcello Paz 27/10/2010 1.0 Incluídas informações técnicas sobre o Parser ConsultaNIT

Marcello Paz 28/10/2010

1.0 Inclusão dos Parsers ConsultaIbama e

ConsultaIbamaEmbargos, ateração do Parser FDCCNPJ e

inclusão de detalhes relacionados à estrutura de retorno que

agora possibilita o retorno de itens de detalhes.

Marcello Paz 29/10/2010

1.1 Retirada a estrutura de Itens de Detalhe provisoriamente. A

inclusão desta funcionalidade será feita em prazo pré-

estabelecido que será divulgado posteriormente.

Marcello Paz 03/11/2010 1.2 Corrigidos campos de alguns Parsers

Marcello Paz 04/11/2010 1.3 Correção Parser Sintegra

Leonardo Bianco 10/11/2010

1.4 Incluídas duas novas colunas (TipoLogradouro e

LogradouroSemTipo) na ReceitaFederalCNPJ e no

SINTEGRA

Leonardo Bianco 23/11/2010

1.5 Alteração dos Parsers ConsultaIbama e Parser FDCCNPJ e

inclusão de detalhes relacionados à estrutura de retorno que

agora possibilita o retorno de itens de detalhes.

Leonardo Bianco 27/12/2010 1.6 Incluído Parser AnttCPF.

Leonardo Bianco 19/01/2011

1.7 Incluído o Status -4 Param obrig nao inf na tabela código de

ocorrência, Anexo II.

Leonardo Bianco 01/07/2011 1.8 Incluído Detalhamento do Serviço de Saneamento Online.

Marcello Paz 13/07/2011

1.9 Incluído Parser ConsultaCEP e alterados parsers ANTT e

Ibamas. Alterado também o formato de chamada do

WebService (ConsultaSincrona)

Marcello Paz 28/09/2011

2.0 Incluidos os Parsers AnvisaProcesso, ConsultaNumeroNIT e

ConsultaJUCESP

Marcello Paz 20/10/2011 2.1 Incluída a consulta do cadastro Farma

Marcello Paz 25/10/2011 2.2 Incluída a consulta ao DAE CE

Leonardo Bianco 01/11/2011

2.3 Incluídos campos Data Validade DOU, Núm. Autorização

ANVISA, Núm. Processo SIVISA, na consulta do cadastro

Farma

Leonardo Claudio 16/12/2011 2.4 Incluído novo parser ConsultaAnttVeiculo

Leonardo Bianco 28/03/2012 2.5 Incluídas Situações Cadastrais novas no Sintegra

Leonardo Cláudio 02/04/2012 2.6 Incluído novo parser – ObrigatoriedadeNFe

Fernando Garcia 06/2013 2.7 Revisão e Atualização completa do manual.

Page 3: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

3

Fernando Garcia 02/07/2013

2.8 Incluído novo parser ConsultaNCM

Incluído parser “PrefeituraSPInterno”

Fernando Garcia 06/09/2013 2.9 Incluído novo parser ConsultaFEBRABAN

Fernando Garcia 06/09/2013 3.0 Incluído novos parâmetros AGENCIA e CODBANCO

Leonardo Cláudio 18/09/2013 3.1 Correção dos endereços de integração

Fernando Garcia 14/10/2013 3.2 Incluído novo parser ConsultaCepomRJ

Fernando Garcia 17/12/2013 3.3 Incluído novo parser QualificacaoESocial (e-Social)

Fernando Garcia 31/03/2014 3.4 Incluído novo parser ConsultaFGTSCRF

Fernando Garcia 31/03/2014 3.5 Incluído novo parser ConsultaINSSDATAPREV

Thaís Oliveira 24/06/2014 3.6 Atualização do Documento

Thaís Oliveira 08/08/2014 3.7 Incluído novo parser ConsultaANP

Fernando Garcia 30/09/2014 3.8 Incluído novo parser PreQualificacao

Fernando Garcia 30/09/2014 3.8 Incluído novo parser ConsultaSeguroDesemprego

Fernando Garcia 01/06/2015 3.9 Atualização ReceitaCPF

Fernando Garcia 11/07/2015 4.0 Incluído novo parser ConsultaAntecedentesCriminaisRJ

Page 4: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

4

Sumário

1. INTRODUÇÃO ...................................................................................................................................................... 7

2. CONSIDERAÇÕES INICIAIS .............................................................................................................................. 7

2.1 OBJETIVOS DO SERVIÇO .................................................................................................................................................. 7

2.2 DESCRIÇÕES SIMPLIFICADA DO PROCESSO ...................................................................................................................... 7

3. PADRÕES TÉCNICOS .......................................................................................................................................... 7

3.1 PADRÕES DE DOCUMENTO XML .................................................................................................................................... 7

3.2 PADRÕES DE COMUNICAÇÃO .......................................................................................................................................... 7

3.3 PADRÕES DE MENSAGENS DOS WEB SERVICES ............................................................................................................... 8

3.3.1 Retornos da Consultas ............................................................................................................................................ 8

3.3.2 Exemplos de Retorno .............................................................................................................................................. 9

3.3.3 Ocorrências durante a Consulta ............................................................................................................................. 9

4. WEB SERVICES .................................................................................................................................................. 10

4.1 LEIAUTE DA MENSAGEM DE REQUISIÇÃO ..................................................................................................................... 10

4.2 LEIAUTE DA MENSAGEM DE RETORNO ......................................................................................................................... 11

5. SANEAMENTO ONLINE ................................................................................................................................... 12

5.1 PADRONIZAÇÕES DE CONTEÚDO ................................................................................................................................... 12

5.2 ABREVIAÇÕES ............................................................................................................................................................... 12

5.3 CARACTERES ESPECIAIS................................................................................................................................................ 13

5.4 ACENTUAÇÃO E CAIXA BAIXA ...................................................................................................................................... 13

5.5 AJUSTAMENTOS DE TEXTO AO TAMANHO DO CAMPO .................................................................................................... 13

6. FLUXO OPERACIONAL .................................................................................................................................... 13

6.1 ETAPAS OPERACIONAIS................................................................................................................................................. 13

6.1.1 Cadastramento ...................................................................................................................................................... 13

7. CONTATO ........................................................................................................................................................... 14

ANEXOS ....................................................................................................................................................................... 14

PARSERS ..................................................................................................................................................................... 19

LISTA DE RETORNOS POR PARSER ....................................................................................................................................... 23

Parser: AnttCnpj ............................................................................................................................................................ 23

Parser: AnttCpf .............................................................................................................................................................. 23

Parser: AnvisaCNPJ ...................................................................................................................................................... 24

Parser: ConsultaANP .................................................................................................................................................... 26

Parser: ConsultaAntt ..................................................................................................................................................... 26

Parser: ConsultaAnttVeiculo ......................................................................................................................................... 27

Parser: ConsultaCadastroFarma .................................................................................................................................. 27

Parser: ConsultaCEP .................................................................................................................................................... 29

Parser: ConsultaCepomRJ ............................................................................................................................................ 29

Parser: ConsultaCNDMT .............................................................................................................................................. 29

Parser: ConsultaCrm ..................................................................................................................................................... 30

Parser: ConsultaDAECE ............................................................................................................................................... 30

Parser: ConsultaFEBRABAN ........................................................................................................................................ 30

Parser: ConsultaFGTSCRF ........................................................................................................................................... 31

Page 5: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

5

Parser: ConsultaNCM ................................................................................................................................................... 31

Parser: ConsultaINSSDATAPREV ................................................................................................................................ 31

Parser: ConsultaIbama.................................................................................................................................................. 31

Parser: ConsultaIbamaEmbargos ................................................................................................................................. 31

Parser: ConsultaJUCESP.............................................................................................................................................. 32

Parser: ConsultaNIT ..................................................................................................................................................... 32

Parser: ConsultaNumeroNIT ......................................................................................................................................... 33

Parser: ConsultaQSA .................................................................................................................................................... 33

Parser: Denatran ........................................................................................................................................................... 34

Parser: DenatranCNH ................................................................................................................................................... 35

Parser: DetranAC .......................................................................................................................................................... 36

Parser: DetranAL .......................................................................................................................................................... 36

Parser: DetranAM ......................................................................................................................................................... 37

Parser: DetranAP .......................................................................................................................................................... 37

Parser: DetranBA .......................................................................................................................................................... 38

Parser: DetranCE .......................................................................................................................................................... 39

Parser: DetranDF ......................................................................................................................................................... 40

Parser: DetranES .......................................................................................................................................................... 40

Parser: DetranGO ......................................................................................................................................................... 40

Parser: DetranMA ......................................................................................................................................................... 41

Parser: DetranMG ......................................................................................................................................................... 41

Parser: DetranMS ......................................................................................................................................................... 42

Parser: DetranPA .......................................................................................................................................................... 42

Parser: DetranPB .......................................................................................................................................................... 43

Parser: DetranPE .......................................................................................................................................................... 43

Parser: DetranPI ........................................................................................................................................................... 44

Parser: DetranPR .......................................................................................................................................................... 44

Parser: DetranRJ ........................................................................................................................................................... 46

Parser: DetranRJMultas................................................................................................................................................ 46

Parser: DetranRN .......................................................................................................................................................... 46

Parser: DetranRO ......................................................................................................................................................... 47

Parser: DetranRR .......................................................................................................................................................... 48

Parser: DetranRS .......................................................................................................................................................... 48

Parser: DetranSC .......................................................................................................................................................... 49

Parser: DetranSE .......................................................................................................................................................... 51

Parser: DetranSP2 ........................................................................................................................................................ 51

Parser: DetranSPMultas ............................................................................................................................................... 52

Parser: DetranTO .......................................................................................................................................................... 52

Parser: FDCCNPJ ......................................................................................................................................................... 52

Parser: MinisterioTrabalho ........................................................................................................................................... 53

Parser: ObrigatoriedadeIE ............................................................................................................................................ 54

Parser: PrefeituraSPInterno .......................................................................................................................................... 54

Parser: PreQualificacao................................................................................................................................................ 54

Parser: ReceitaFederalCNPJ ........................................................................................................................................ 55

Parser: ReceitaFederalCPF .......................................................................................................................................... 56

Parser: Simples Nacional .............................................................................................................................................. 56

Parser: Sintegra............................................................................................................................................................. 57

Parser: Suframa............................................................................................................................................................. 58

Parser: ObrigatoriedadeNFeFull .................................................................................................................................. 59

Page 6: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

6

Parser: QualificacaoESocial ......................................................................................................................................... 62

Page 7: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

7

1. Introdução

Este documento tem por objetivo a definição das especificações e critérios técnicos necessários

para a integração entre o Web Service da SIM>Consultas e os sistemas de nossos clientes.

2. Considerações Iniciais

A SIM>Consultas utilizando das mais avançadas tecnologias de robotização web, disponibiliza

de maneira totalmente automática as informações disponíveis nas consultas de diversos sites como

Receita Federal, Sintegra, Anvisa, etc.

2.1 Objetivos do Serviço

A SIM>Consultas tem como objetivo tornar os processos de validação e atualização cadastral

mais ágeis e impedir a entrada de dados incorretos nos sistemas de nossos clientes por erros humanos.

2.2 Descrições simplificada do processo

De maneira simplificada o cliente através de seus sistemas ou através do site da SIM>Consultas,

informa os parâmetros mínimos para a consulta em cada Parser e de maneira síncrona o servidor executa

a consulta e retorna os dados em formato de retorno padronizado.

3. Padrões Técnicos

3.1 Padrões de Documento XML

A especificação do documento XML adotada é a recomendação W3C para XML 1.0, disponível

em www.w3.org/TR/REC-xml e a codificação dos caracteres será em UTF-8, assim todos os

documentos XML serão iniciados com a seguinte declaração:

<?xml version=”1.0” encoding=”UTF-8”?>

3.2 Padrões de Comunicação

A comunicação será baseada em Web Services disponibilizados pela SIM>Consultas.

A troca de mensagens entre o Web Service da SIM>Consultas e o aplicativo do cliente pode ser

realizada utilizando o padrão SOAP, HTTP GET ou HTTP POST.

Page 8: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

8

Formato de uma mensagem requisição padrão SOAP 1.1:

Formato de requisição HTTP GET

Formato de requisição HTTP POST

3.3 Padrões de Mensagens dos Web Services

As chamadas do Web Service da SIM>Consultas são síncronas, ou seja, a chamada é finalizada

com o retorno esperado para a consulta.

3.3.1 Retornos da Consultas

A resposta de toda consulta obedece sempre o mesmo padrão de retorno que é um XML com a

seguinte estrutura:

<?xml version="1.0" encoding="utf-8"?><soap:Envelope

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<ConsultaSincrona xmlns="http://simconsultas.com.br/">

<chaveAcesso>string</chaveAcesso>

<Parser>string</Parser>

<Parametros>string</Parametros>

</ConsultaSincrona>

</soap:Body>

</soap:Envelope>

GET

/service.asmx/ConsultaSincrona?chaveAcesso=string&Parser=string&Parametro

s=string HTTP/1.1

Host: ws.simconsultas.com.br

POST /service.asmx/ConsultaSincrona HTTP/1.1

Host: ws.simconsultas.com.br

Content-Type: application/x-www-form-urlencoded

Content-Length: length

chaveAcesso=string&Parser=string&Parametros=string

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<ConsultaSincronaResponse xmlns="http://simconsultas.com.br/">

<ConsultaSincronaResult>

<HasError>boolean</HasError>

<ErrorDesc>string</ErrorDesc>

<ErrorCode>int</ErrorCode>

<Rows>

<ParseDataRow>

<Status>int</Status>

<StatusDesc>string</StatusDesc>

<Parser>string</Parser>

<Columns xsi:nil="true" />

</ParseDataRow>

<ParseDataRow>

<Status>int</Status>

<StatusDesc>string</StatusDesc>

Page 9: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

9

Os formatos de retorno de cada parser podem ser vistos no Anexo III.

Em cada ParseDataRow pode haver sub-itens que irão aparecer dentro da TAG <Rows> que conterá uma

coleção de ParseDataRow. Estes itens aparecerão em casos que a consulta traga detalhes como nos Parsers

ConsultaIbama e FDCCNPJ.

3.3.2 Exemplos de Retorno

(Parser ReceitaFederalCPF)

3.3.3 Ocorrências durante a Consulta

Caso ocorra qualquer problema com o processo de consulta o campo HasError será preenchido

com o valor “true” indicando que houve uma ocorrência. Se não houver ocorrências o campo é

preenchido com o valor “false”.

<?xml version="1.0" encoding="utf-8"?>

<DataReturn xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://simconsultas.com.br/">

<HasError>false</HasError>

<ErrorCode>0</ErrorCode>

<Rows>

<ParseDataRow>

<Status>0</Status>

<Columns>

<ParseDataColumn>

<Key>CPF</Key>

<Value>12345678901</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>Nome</Key>

<Value>JOÃO DA SILVA</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>SituacaoCadastro</Key>

<Value>REGULAR</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>SituacaoFlag</Key>

<Value>1</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>CodigoControle</Key>

<Value>C2BA.B95F.C4C1.CB67</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>DataConsulta</Key>

<Value>22/10/2010 16:07:01</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>Parser</Key>

<Value>ReceitaFederalCPF</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>CPF</Key>

<Value>12345678901</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>ChaveAcesso</Key>

<Value> DFA</Value>

<Type>string</Type>

</ParseDataColumn>

</Columns>

Page 10: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

10

A ocorrência é especificada através dos campos ErrorCode e ErrorDesc que contém

respectivamente o código da falha e a descrição do problema.

Todos os motivos de ocorrências estão listados no ANEXO II.

4. Web Services

O Web Service da SIM>Consultas disponibiliza o serviço que será utilizado pelos aplicativos

dos clientes. O mecanismo de utilização do Web Service segue as seguintes premissas:

a) O envio da solicitação e a obtenção do retorno serão realizados na mesma conexão

através de um único método.

b) A URL do Web Service encontra-se no Anexo I deste manual. Acessando a URL

pode ser obtido o WSDL (Web Services Description Language) do Web Service.

c) O processo de utilização do Web Service sempre é iniciado pelo cliente enviando

uma mensagem no padrão XML SOAP ou HTTP GET ou HTTP POST.

4.1 Leiaute da Mensagem de Requisição

# Campo Ele Pai Tip Ocor Tam Dec Descrição/Obs.

S01 ConsultaSi

ncrona

Raiz - - - - - TAG Raiz

S02 ChaveAces

so

E S1 C 1 36 Chave de acesso exclusiva

do cliente fornecida

previamente pela

SIM>Consultas

S03 Parser E S1 C 1 - Nome do Parser

S04 Parametros E S1 C 1 9 Parâmetros da consulta no

padrão:

CNPJ=00000000000000&

UF=XX&IE=00000000

No campo “PARAMETROS”, é possível passar parâmetros de validação, informando o nome do

campo a ser validado seguido da palavra VALIDA. Exemplo: Se adicionarmos o parâmetro

“&NUMEROVALIDA=000”, e o campo NUMERO do retorno seja diferente de 000, a consulta irá

retornar:

Page 11: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

11

É possível passar mais de 1 campo com este parâmetro VALIDA, mas se houver mais de 1 campo

com valor diferente, ele irá retornar na descrição apenas 1, a primeira diferença que achar. 4.2 Leiaute da Mensagem de Retorno

# Campo Ele Pai Tipo Ocor. Tam. Dec. Descrição/Obs.

R01 DataReturn Raiz - - - - - TAG Raiz

R02 HasError E R01 B 1 - Informa se houve problemas

na consulta. true / false

R03 ErrorDesc E R01 C 1 256 Texto descritivo sobre o

problema ocorrido

R04 ErrorCode E R01 N 1 2 Código de Status

informativo do erro ocorrido

R05 Rows E R01 1 Retornos da consulta (Cada

ParseDataRow, representa

um registro retornado)

R06 ParseDataRow E R05 1-N

R07 Status E R06 N 1 2 Código de Status

informativo do erro ocorrido

R08 Columns E R05 1-N Campos retornados (Cada

linha possui N Campos)

R09 ParseDataColumn E R08 1-N

R10 Key E R09 C 1 - Nome do Campo

R11 Value E R09 C 1 - Valor do Campo

R12 Type E R09 C 1 - Tipo do Campo.

String/Int/Boolean

<HasError>true</HasError>

<ErrorDesc>O Conteudo retornado no campo NUMERO=XXX foi diferente do

parametro de validacao informado NUMEROVALIDA=000</ErrorDesc>

<ErrorCode>51</ErrorCode>

Page 12: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

12

R13 Rows E R06 1 Detalhes da Consulta. Sub-

itens. Aparecem quando a

consulta tem itens detalhes.

R14 ParseDataRow E R13 1-N

R15 Status E R13 N 1 2 Código de Status

informativo do erro ocorrido

R16 Columns E R14 1-N Campos retornados (Cada

linha possui N Campos)

R17 ParseDataColumn E R16 1-N

R18 Key E R16 C 1 - Nome do Campo

R19 Value E R16 C 1 - Valor do Campo

R20 Type E R16 C 1 - Tipo do Campo.

String/Int/Boolean

5. Saneamento Online

O serviço de Saneamento Online dos dados cadastrais engloba o tratamento e a normalização do

cadastro em tempo real de consulta, as informações retornadas são padronizadas e saneadas observados

os parâmetros definidos pelo cliente, que envolvem desde a manutenção de caracteres especiais até a

utilização de dicionários de abreviaturas. As exigências legais estabelecidas para geração dos arquivos

da NF-e (Ato COTEPE 22 de 25/06/08), SPED FISCAL (Ato COTEPE 9 de 18/04/08) e SPED

CONTABIL (IN RFB 787/07 de 19/11/07) e demais legislações pertinentes podem, também, ser

plenamente observadas mediante definição do cliente.

5.1 Padronizações de Conteúdo

Com o objetivo de harmonizar o cadastro, nosso sistema possui a inteligência de padronizar as

palavras e informações de acordo com a necessidade de cada cliente, respeitando a individualidade de

cada segmento de mercado.

5.2 Abreviações

Possuímos um dicionário padrão de abreviações, com as palavras principais, no singular, plural,

masculino e feminino, este serviço pode ser customizado para cada cliente, caso não queira utilizar o

dicionário padrão da SIM>Consultas o cliente poderá criar um próprio, que sera cadastrado e aplicado

durante o processo do saneamento.

Page 13: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

13

5.3 Caracteres Especiais

Atendendo as exigências do manual do contribuinte da NFe e do SPED, o processo de

saneamento remove os caracteres especiais desnecessários, evitando assim problemas para transmissão

dos arquivos eletrônicos para os orgãos oficiais.

5.4 Acentuação e Caixa Baixa

Atendendo as exigências do manual do contribuinte da NFe e do SPED, o processo de

saneamento remove as acentuações e padroniza todas as palavras em caixa alta, evitando assim

problemas para transmissão dos arquivos eletronicos para os orgãos oficiais.

5.5 Ajustamentos de texto ao tamanho do campo

Utilizando a técnica abreviação e de compactação nosso processo de saneamento consegue gerar

o retorno dos textos dentro do tamanho que for necessário para atualização dos dados no ERP, sem ter

que cortar (truncar) partes da informação, mantendo assim a qualidade dos dados.

6. Fluxo Operacional

A SIM>Consultas disponibiliza um canal direto com o departamento de operações que será

responsável pelo suporte ao serviço de consulta via WebServices. O objetivo é prestar todo apoio

necessário para que o processo das consultas funcione corretamente, tanto nas etapas de testes e

implantação quanto na manutenção dos serviços posteriores.

6.1 Etapas Operacionais

Detalhamento das etapas necessárias para realização dos testes e implantação do serviço de

consultas via WebServices, após acordo previamente realizado com o departamento comercial.

6.1.1 Cadastramento

O Cliente/Parceiro receberá junto à documentação completa necessária para configuração e

implantação dos serviços contratados, suas informações de login, sendo um usuário e uma senha para

acesso ao Portal de Clientes SIM>Consultas através do endereço portal.simconsultas.com.br. Através

deste portal, será possível realizar consultas, visualizar o extrato das consultas realizadas, bem como

exportá-las se necessário. E também recebe uma chave de acesso exclusiva para comunicação via Web

Service, assim como créditos para a utilização das consultas liberados pelo departamento comercial após

a negociação. Para conhecer mais sobre este Portal, solicite ao departamento de suporte o envio do

manual de utilização do mesmo.

A SIM Consultas conta com um serviço de notificações e comunicados quando necessário, em

casos de instabilidade e outros fatores. Para receber essas notificações é necessário informar o e-mail e

Page 14: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

14

telefone dos responsáveis operacionais para a equipe de suporte para que sejam cadastradas as

informações para o devido envio.

7. Contato

Dúvidas? Acesse nossa central de ajuda pelo endereço simconsultas.zendesk.com ou entre em

contato com nosso setor de Suporte e Operações através do e-mail [email protected].

ANEXOS Tabela de informações técnicas

# Tipo Conteúdo Descrição

IT01 URL http://lb.simconsultas.com.br/webservice/service.asmx Endereço do Web

Service

IT02 URL http://lb.simconsultas.com.br/webservice/service.asmx

?WSDL

Endereço para

acessar o WSDL

IT03 Liberar

Firewall

*.simconsultas.com.br Devem ser liberados

no Firewall todos os

endereços

terminados por

simconsultas.com.br

IT04 E-mail

contato

[email protected] E-mail utilizado em

comunicações

automáticas enviadas

pelos serviços.

Liberar no Anti-

SPAM.

IT05 E-mail

suporte

[email protected] E-mail utilizado para

comunicação de

problemas ou

esclarecimento de

dúvidas.

IT06 Método do

WebService

ConsultaSincrona Faz a consulta de

forma Síncrona

retornando os dados

em formato padrão

Page 15: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

15

Tabela de informações Gerais

# Tipo Conteúdo Descrição

I

G01

URL http://portal.simconsultas.com.br/Login.aspx. Portal para

acompanhamento de

consultas realizadas,

estatísticas, avisos gerais,

etc.

ANEXO II

Tabela Código Ocorrência

# id Status Descrição Sucesso Cobra

RE01 -3 Chave acesso Invalida SIM NÃO

RE02 -2 Erro n Identificado NÃO NÃO

RE03 -1 Timeout NÃO NÃO

RE04 2 Consultado SIM SIM

RE05 3 Inexistente SIM SIM

RE06 4 Falha Consulta NÃO NÃO

RE07 5 Retorno Múltiplo SIM SIM

RE08 7 Site fora do ar SIM NÃO

RE08 8 VerificarPessoalment

Dirigir-se a Secretaria da Receita

Federal do Brasil para obter a

informação desejada.

SIM SIM

RE09 10 CNPJ/CPF Inválido SIM SIM

RE10 12 IE Recadastrada SIM SIM

RE11 13 Site Retornou Erro SIM NÃO

RE12 14 Não Consulta CPF SIM NÃO

RE13 15 IE Invalida SIM SIM

Page 16: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

16

RE14 17 CPF Com Dados

Incomp SIM SIM

RE15 18 Consulta Desligada Consulta não contemplada pelo software

SIM>CONSULTAS NÃO NÃO

RE16 30 Erro ao acessar site NÃO NÃO

RE17 35 UF Inválida SIM SIM

RE18 51 CNPJ Diferente SIM SIM

RE19 52 IE Diferente SIM SIM

RE20 98 Em estudo problema NÃO NÃO

RE21 99 Parado Manualmente NÃO NÃO

RE22 1001 Parser Inexistente SIM NÃO

RE24 -4 Param obrig nao inf SIM NÃO

RE25 75 Divergência Divergência nos dados cadastrais SIM SIM

RE26 -9 Falha em analise NÃO NÃO

RE27 19 NFe em contingência

Nota Fiscal Eletrônica emitida em

contingência e ainda não autorizada pela

SEFAZ. Apenas é permitida a Consulta

Resumida para esta NF-e.

SIM SIM

RE28 20 Verificar NIT Procure uma agência do INSS SIM SIM

RE29 25 Digito NF-e inválido Digito do Número da NFe invalido SIM SIM

RE30 31 Nfe Inexistente 180

dia Nfe Inexistente 180 dias SIM SIM

RE31 55 Não é NFE SIM SIM

RE32 6 Multiplo cons por IE Retorno foi Múltiplo consultar por IE. NÃO NÃO

RE33 9 Erro tratamento Erro não tratado e não esperado NÃO NÃO

RE34 40 NFe não internada NFe não internada no site da

SUFRAMA SIM SIM

RE35 102 Parametro Informado

Inválido Parametro Informado Inválido SIM SIM

Page 17: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

17

ANEXO III

Parâmetros

Parâmetro Tipo Tamanho

chaveAcesso Texto 36

Parser Texto Variável

RENAVAM Numérico 9

PLACA Texto 7

CNH Numérico 11

CHASSI Texto Variável

CPF Numérico 11

CNPJ Numérico 14

IE Numérico Variável

RNTRC Numérico 8

UF Texto 2

NIT Numérico Variável

CEP Numérico 8

IS Numérico

NOME Nome completo igual ao da Receita Federal Variável

NOMEMAE Nome da Mãe Variável

DATANASCTO Data de Nascimento 10

DATANASCIMENTO Data de Nascimento 10

RAZAOSOCIAL Texto Variável

DAE Numérico

CNAE Texto Variável

LISTACNAE Texto Variável

Page 18: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

18

NUMEROSEGURANCA Numérico Variável

NCM Texto Variável

AGENCIA Numérico Variável

CODBANCO Numérico Variável

PIS Numérico Variável

Page 19: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

19

Parsers Parser Descrição Parâmetros obrigatórios

AnttCNPJ Consulta Situação cadastral

Transportador ANTT CNPJ ou RNTRC

AnttCPF Consulta Situação cadastral

Transportador ANTT por CPF CPF

AnvisaCNPJ Consulta Anvisa por CNPJ CNPJ

ConsultaAntecedentesCriminaisRJ Atestado Antecedentes Criminais RJ

NOME, NOMEPAI,

NOMEMAE,

DTEXPEDICAO, RG E

DTNASCIMENTO

ConsultaANP Consulta ANP CNPJ

ConsultaANTT Consulta ANTT por

CNPJ/CPF/RNTRC CNPJ ou CPF ou RNTRC

ConsultaAnttVeiculo Consulta ANTT por CNPJ/CPF/Placa Placa e CNPJ ou CPF ou

RNTRC

ConsultaCadastroFarma Consulta dados ANVISA, SIVISA,

DOU, RECEITA e SINTEGRA CNPJ

ConsultaCEP Consulta dados Endereço pelo CEP CEP

ConsultaCepomRJ Consulta Situação Cadastral do

Prestador – CEPOM RJ CNPJ

ConsultaCNDMT Consulta ao Sistema de Certidão

Negativa de Débito - MT CNPJ

ConsultaCrm Consulta situação cadastral do CRM CRM e UF

ConsultaDAECE Consulta ao DAE do estado CE DAE

ConsultaFEBRABAN

Consulta os dados do banco de acordo

com a agencia e código do banco

informado

AGENCIA e CODBANCO

ConsultaFGTSCRF Consulta FGTS CNPJ

ConsultaNCM Consulta a base interna de NCM NCM

ConsultaINSSDATAPREV Consulta INSS DataPrev CNPJ

Page 20: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

20

ConsultaIbama Consulta Certificado Regularidade

Ibama CNPJ ou CPF

ConsultaIbamaEmbargos Consulta áreas embargadas IBAMA CNPJ ou CPF

ConsultaJUCESP Consulta dados da empresa na Junta

Comercial de SP RAZAOSOCIAL

ConsultaNIT Consulta dados cadastrais NIT NIT

ConsultaNumeroNIT Consulta o Número do NIT

CPF, NOME,

DATANACTO,

NOMEMAE

ConsultaSeguroDesemprego

Consulta a situação do seguro

desemprego PIS

ConsultaQSA

Consulta Quadro de Sócios

Administradores CNPJ

ConsultaTrabalhoEscravoFULL Consulta trabalho escravo Não é necessário passar

nenhum parâmetro

Denatran Consulta Denatran RENAVAM e CNPJ ou CPF

DenatranCNH Consulta Denatran CNH CPF, CNH E

NUMEROSEGURANCA

DetranAC Consulta Detran - AC PLACA E RENAVAM

DetranAL Consulta Detran - AL PLACA E RENAVAM

DetranAM Consulta Detran - AM RENAVAM

DetranAP Consulta Detran - AP PLACA E RENAVAM

DetranBA Consulta Detran - BA RENAVAM OU CHASSI

DetranCE Consulta Detran - CE PLACA E RENAVAM

DetranDF Consulta Detran - DF PLACA E RENAVAM

DetranES Consulta Detran - ES PLACA E RENAVAM

DetranGO Consulta Detran - GO PLACA E RENAVAM

DetranMA Consulta Detran - MA RENAVAM

DetranMG Consulta Detran - MG PLACA E CHASSI

Page 21: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

21

DetranMS Consulta Detran - MS PLACA E RENAVAM

DetranMT Consulta Detran - MT PLACA E RENAVAM

DetranPA Consulta Detran - PA PLACA E RENAVAM

DetranPB Consulta Detran - PB PLACA

DetranPE Consulta Detran - PE PLACA

DetranPI Consulta Detran - PI PLACA E RENAVAM

DetranPR Consulta Detran - PR RENAVAM

DetranRJ Consulta Detran - RJ RENAVAM

DETRANRJMULTAS Consulta multas no Detran de RJ RENAVAM e CNPJ ou CPF

DetranRN Consulta Detran - RN PLACA E RENAVAM

DetranRO Consulta Detran - RO PLACA

DetranRR Consulta Detran - RR PLACA E RENAVAM

DetranRS Consulta Detran - RS PLACA E RENAVAM

DetranSC Consulta Detran - SC PLACA E RENAVAM

DetranSE Consulta Detran - SE RENAVAM

DetranSP2 Consulta Detran - SP PLACA E RENAVAM

DetranTO Consulta Detran - TO PLACA E RENAVAM

FDCCNPJ Consulta de ficha de dados Cadastrais

(FDC) da prefeitura de SP CNPJ

MinisterioTrabalho Consulta Lista Suja Ministerio do

Trabalho CNPJ ou CPF

ObrigatoriedadeIE

Verifica se dentre uma lista de

CNAE, algum obriga a empresa a ter

IE.

LISTACNAE

ObrigatoriedadeNfeFull Consulta a obrigatoriedade de

emissão de Nfe

CNPJ ou CNAE ou

LISTACNAE, IE*** e

UF***

PrefeituraCuritiba Consulta Cadastro Prefeitura Curitiba CNPJ

Page 22: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

22

PrefeituraSPInterno

Consulta Situação Cadastral de

Prestadores de Serviços de Outros

Municípios

CNPJ

PreQualificacao

Qualifica os dados do NIS (PIS,

PASEP, NIT) para os eventos iniciais

do eSocial

NOME, CPF, PIS,

DATANASCIMENTO,

NOMEMAE (Este último

pode ser enviado o valor

“Ignorado”)

QualificacaoESocial Qualificação on-line – e-Social

CPF, PIS,

DATANASCIMENTO,

NOME

ReceitaFederalCNPJ Consulta Receita Federal por CNPJ CNPJ

ReceitaFederalCPF Consulta Receita Federal por CPF CPF e

DATANASCIMENTO

SimplesNacional Consulta se a empresa é optante do

SIMPLES Nacional CNPJ

Sintegra Consulta Sintegra CNPJ OU CPF, UF e IE*

SIVISA Consulta valores de emissão nota

fiscal do portal NFE CNPJ

Suframa Consulta Suframa CNPJ OU CPF, UF, IS** e

IE*

*Na consulta ao Sintegra e Suframa o parâmetro “IE” não é obrigatório, mas recomendamos usá-lo

sempre que possível, assim evitando retornos como “Retorno múltiplo” e “IE Diferente”.

**Na consulta ao Suframa o parâmetro “IS” não é obrigatório, mas recomendamos usá-lo sempre que

possível, assim evitando retornos como “Retorno múltiplo”.

*** Na consulta ObrigatoriedadeNfeFull os parâmetros “IE” e “UF” não são obrigatórios, mas

recomendamos usá-lo sempre que possível, pois para que a consulta seja validada em todas as bases

possíveis devem ser passados como parâmetros o CNPJ, UF e IE (IE somente para evitar “Retorno

Múltiplo”, caso não tenha não é necessário).

Page 23: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

23

Lista de Retornos por Parser

Parser: AnttCnpj (Consulta Situação cadastral Transportador ANTT)

Campo Tipo Descrição Valores / Formato

Transportador Texto Nome, Razão Social

CNPJ Numérico CNPJ sem formatação 00000000000000

Categoria Texto Categoria de Transportador

Empresa,

Autônomo,

Cooperativa.

RNTRC Numérico RNTRC sem formatação 00000000

Situacao Texto Situação do Cadastro

SUSPENSO |

ATIVO | etc.

SituacaoFlag Binário FLAG da Situação [0|1]

DataEmissao Data Data Emissão dd/MM/yyyy

DataValidade Data Data Validade dd/MM/yyyy

Empresaequiparada Booleano

Equiparada ao Transportador Autônomo

de Cargas [True|False]

Empresaobrigada Booleano

Obrigada a cumprir as disposições da

Resolução ANTT 3658/11. [True|False]

Parser: AnttCpf

(Consulta Situação cadastral Transportador ANTT por CPF)

Campo Tipo Descrição Valores / Formato

Transportador Texto Nome

CNPJ Numérico CPF sem formatação 00000000000

Categoria Texto Categoria de Transportador Autônomo | etc.

RNTRC Numérico RNTRC sem formatação 00000000

Situacao Texto Situação do Cadastro

SUSPENSO |

ATIVO | etc.

SituacaoFlag Binário FLAG da Situação [0|1]

DataEmissao Data Data Emissão dd/MM/yyyy

DataValidade Data Data Validade dd/MM/yyyy

Empresaequiparada Booleano

Equiparada ao Transportador Autônomo de

Cargas [True|False]

Page 24: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

24

Empresaobrigada Booleano

Obrigada a cumprir as disposições da

Resolução ANTT 3658/11. [True|False]

Parser: AnvisaCNPJ

(Consulta ANVISA Cadastro)

Campo Tipo Descrição Valores / Formato

RazaoSocial Texto Razão Social

CNPJ Numérico CNPJ sem formatação 00000000000000

Autorizacao Numérico Número da Autorização

AutorizadoEm Data Data da Autorização d/M/yyyy HH:mm:ss

Processo Numérico Número do Processo

RespLegal Texto Nome do Responsável Legal

RespTecnico Texto Nome do Responsável Técnico

Endereco Texto Endereço

Bairro Texto Bairro

Municipio Texto Município

Uf Texto Estado XX

CEP Numérico CEP sem formatação

Email Texto Email Contato

Situacao Texto Situação do Cadastro Autorização REGULAR|IRREGU

LAR|CANCELADA

ValidadeInicio Data/Hora Data Validade Início Autorização d/M/yyyy HH:mm:ss

ValidadeFim Data/Hora Data Validade Final d/M/yyyy HH:mm:ss

ValidadeDocumento Texto Número Documento de Autorização

ValidadeTipo Texto Tipo de Autorização

ValidadeSituacao Texto Situação da Autorização

Parser: ConsultaAntecedentesCriminaisRJ

(Atestado Antecedentes Criminais RJ)

Nesta consulta o XML pode ser retornado em 2 formatos diferentes, dependendo do retorno do

site:

Quando “Existe atestado dentro da validade”:

Campo Tipo Descrição Valores / Formato

NrAtestado Texto Número do atestado

Validade Data Data de validade DD/MM/AAAA

CodAutenticidade Texto Código Autenticidade

Nome Texto Nome

Afiliacao Texto Nome do Pai e Mãe

Page 25: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

25

DtNascimento Data Endereço

DD/MM/AAAA

RG Texto RG

Antecedentes Texto Situação Antecedente

Obs Texto Observação

Status_Atestado Texto Status da Consulta

DtConsulta DateTime Data da Consulta dd/MM/yyyy HH:mm:ss

URLProvaConsulta Texto Link da Prova de Consulta

Quando “Existe solicitação de atestado em processo de avaliação”:

Campo Tipo Descrição Valores / Formato

Protocolo Texto Número do Protocolo

DtEntrega Data Data de entrega DD/MM/AAAA

NomeMae Texto Nome da Mãe

Nome Texto Nome

RG Texto RG

OrgaoExpedidor Texto Orgao Expedidor

NomePai Texto Nome da Pai

DtNascimento Data Endereço

DD/MM/AAAA

DtExpedicao Data Endereço

DD/MM/AAAA

DtSolicitacao Data Endereço

DD/MM/AAAA

Status_Atestado Texto Status da Consulta

DtConsulta DateTime Data da Consulta dd/MM/yyyy HH:mm:ss

URLProvaConsulta Texto Link da Prova de Consulta

Page 26: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

26

Parser: ConsultaANP

(Consulta ANP)

Campo Tipo Descrição Valores / Formato

Situacao Texto Situação do Cadastro

Autorização

REGULAR|IRREGULAR|CA

NCELADA

Autorizacao Texto

CNPJ Texto CNPJ sem formatação 00000000000000

RazaoSocial Texto Razão Social

NomeFantasia Texto Nome Fantasia

Endereco Texto Endereço

Complemento Texto Complemento

Bairro Texto Bairro XX

Municipio Texto Município

UF Texto Estado

CEP Texto CEP sem formatação

NumeroDespacho Texto Numero de Despacho

DataPublicacao Texto Data de Publicação dd/MM/yyyy

Bandeira Texto Bandeira

TipoDoPosto Texto Tipo de Posto

DataConsulta

Data/H

ora Data Consulta dd/MM/yyyy HH:mm:ss

SituacaoFlag Binário FLAG da Situação [0|1]

Produto Texto Produto

Tancagem Texto Tancagem

Bicos Texto Bicos

Parser: ConsultaAntt

(Consulta ANTT por CNPJ/CPF/RNTRC)

Campo Tipo Descrição Valores / Formato

Transportador Texto Nome, Razão Social

CNPJ Numérico CNPJ ou CPF sem formatação

00000000000000 ou

00000000000

Page 27: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

27

Categoria Texto Categoria de Transportador

Empresa | Autônomo |

Cooperativa

RNTRC Numérico RNTRC sem formatação 00000000

Situacao Texto Situação do Cadastro

SUSPENSO | ATIVO

| etc.

SituacaoFlag Binário FLAG da Situação [0|1]

DataEmissao Data Data Emissão dd/MM/yyyy

DataValidade Data Data Validade dd/MM/yyyy

Empresaequiparada Booleano

Equiparada ao Transportador Autônomo

de Cargas [True|False]

Empresaobrigada Booleano

Obrigada a cumprir as disposições da

Resolução ANTT 3658/11. [True|False]

Parser: ConsultaAnttVeiculo

(Consulta ANTT Cadastro de Transportadores por Veículo)

Campo Tipo Descrição Valores / Formato

Transportador Texto Nome, Razão Social

CNPJ Numérico CNPJ ou CPF sem formatação

00000000000000 ou

00000000000

Categoria Texto Categoria de Transportador

[Empresa|Autônomo

|Cooperativa]

RNTRC Numérico RNTRC sem formatação 00000000

Situacao Texto Situação do Cadastro

SUSPENSO |

ATIVO | etc.

SituacaoFlag Binário FLAG da Situação [0|1]

DataEmissao Data Data Emissão dd/MM/yyyy

DataValidade Data Data Validade dd/MM/yyyy

Placa Texto Placa Consultada AAA0000

VeiculoCadastrado Booleano

Veículo cadastrado na frota do

Documento [True|False]

VeiculoAutorizado Booleano Autorização para realizar transporte [True|False]

Empresaequiparada Booleano

Equiparada ao Transportador Autônomo

de Cargas [True|False]

Empresaobrigada Booleano

Obrigada a cumprir as disposições da

Resolução ANTT 3658/11. [True|False]

Parser: ConsultaCadastroFarma

(Consulta dados ANVISA, SIVISA, DOU, RECEITA e SINTEGRA)

Campo Tipo Descrição

Origem

dado Valores / Formato

Regra Texto

REGRA 1 | REGRA 2

| etc.

CNPJ Numérico CNPJ

RECEITA

FEDERAL 00000000000000

Page 28: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

28

RazaoSocial Texto Razão Social

RECEITA

FEDERAL

CodigoAssunto Texto

Código do assunto

referente à petição da

Anvisa

ANVISA

PROCESS

O 785 | 7044 | etc.

Status Texto

Situação da última

petição válida

ANVISA

PROCESS

O

Tipo Texto

Tipo de ocorrência.

Relacionada ao Assunto

ANVISA

PROCESS

O

AE | AFE|

Cancelamento da

AFE | Reconsideração

de Indeferimento |

Retificação de

Publicação | etc.

AutorizacaoPsico Texto

Informa sobre a

permissão de

comercialização e

dispensação de

medicamento controlado

DIÁRIO

OFICIAL

SIM | etc.

DataPublicacao Data

Data do status da última

petição válida

ANVISA

PROCESS

O dd/MM/yyyy

DataConcessao Data

Data de início da

Concessão

ANVISA

CADAST

RO dd/MM/yyyy

DataValidade Data Data final da Concessão

ANVISA

CADAST

RO dd/MM/yyyy

SituacaoANVISA Texto

Situação do cadastro na

Anvisa

ANVISA

CADAST

RO

REGULAR |

IRREGULAR | etc.

DataVctoSIVISA Data

Data de vencimento da

SIVISA

SIVISA SP

dd/MM/yyyy

SituacaoSivisa Texto

Situação do cadastro na

SIVISA

SIVISA SP

Ativo | etc.

SituacaoReceita Texto

Situação do cadastro na

Receita Federal

RECEITA

FEDERAL

ATIVA | BAIXADA |

etc.

SituacaoSintegra Texto

Situação do cadastro no

SINTEGRA

SINTEGR

A

Habilitada |

Inabilitada | etc.

IE Numérico Inscrição Estadual

SINTEGR

A

RESOLUCAO Numérico

Número da

RESOLUÇÃO do Diário

Oficial

DIÁRIO

OFICIAL

DataDOU Data

Data de publicação do

Diário Oficial

(Suplemento Anvisa)

DIÁRIO

OFICIAL

dd/MM/yyyy

DataValidadeDOU Data

Data Validade da

publicação do Diário

DIÁRIO

OFICIAL

dd/MM/yyyy

Page 29: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

29

Oficial (Suplemento

Anvisa)

NrAutorizacaoANVIS

A Numérico

Número de Autorização

no cadastro da Anvisa

ANVISA

CADAST

RO

NrProcessoSIVISA

Número do Processo

SIVISA

SIVISA SP

Parser: ConsultaCEP

(Consulta os dados de endereço do CEP informado com base nos CORREIOS)

Campo Tipo Descrição Valores / Formato

UF Texto UF XX

Municipio Texto Município

Bairro Texto Bairro

TipoLog Texto Tipo de Logradouro Ex: Rua, Avenida, etc.

Logradouro Texto Logradouro Ex: Floriano Peixoto

Complemento Texto Complemento do Logradouro Ex: Até 500/501

Abreviatura Texto Endereço Completo Abreviado Ex: R Floriano Peixoto

Tipo Numérico Tipo do CEP

Parser: ConsultaCepomRJ

(Consulta Situação Cadastral do Prestador – CEPOM RJ)

Campo Tipo Descrição Valores / Formato

Cnpj Texto CNPJ sem formatação 00000000000000

RazaoSocial Texto Razão Social

Município Texto Município do prestador

Uf Texto UF XX

Dt_Consulta Texto Data da consulta

Observação Texto Observações

Cod_Servico Texto Codigo do(s) serviço(s)

Parser: ConsultaCNDMT

(Consulta ao Sistema de Certidão Negativa de Débito – Mato Grosso)

Campo Tipo Descrição Valores / Formato

nrCertidao Numérico Número da certidão

Endereco Texto Endereço

Cnae Texto Descrição CNAE

RazaoSocial Texto Razão Social

Observacao Texto Observações

Contribuinte Texto CNPJ e Razão do contribuinte

Filiais Texto

Socios Texto

Participacoes Texto

ParticipacoesSocio Texto

CodigoAutenticidade Texto Cod. de Autenticidade da certidão

Page 30: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

30

ValidadeCertidao Data Validade da Certidão dd/MM/yyyy

DataConsulta Data Data da Consulta dd/MM/yyyy hh:MM:ss

Parser: ConsultaCrm

(Consulta situação cadastral do CRM – Somente estado de SP)

Campo Tipo Descrição Valores / Formato

NrCnpj Numérico Número do CRM

DtAbertura Data Data de inscrição do CRM dd/MM/yyyy

Nome Texto Nome

Email Texto Email

Especialidade Texto Especialidade

PEDIATRIA - RQE nº 5650 |

ANESTESIOLOGIA - RQE nº 1118 |

etc.

Endereco Texto Endereco

Situação Data

Data do status da última

petição válida

ATIVO | INATIVO DESDE

dd/MM/yyyy | etc.

Parser: ConsultaDAECE

(Consulta ao DAE do estado CE)

Campo Tipo Descrição Valores / Formato

DAE Numérico Código DAE

DataPagamento Data Data do Pagamento dd/MM/yyyy

ValorPago Texto Valor Pago Ex.: 30,12

LocalPagamento Texto Local de Pagamento Ex.: Caixa Econômica Federal

Situacao Texto Situação

Ex.: PAGAMENTO CONSTA

NA BASE DE DADOS DA

SEFAZ

PeriodoReferencia Texto Período de Referência Ex.: 082011

CodigoReceita Texto Código Receita Ex.: 1023

Contribuinte Texto Dados do Contribuinte

Parser: ConsultaFEBRABAN

(Consulta os dados do banco de acordo com a agencia e codigo do banco informado)

Campo Tipo Descrição Valores / Formato

Banco Texto Nome do Banco

Site Texto Site do Banco

Tipo Texto Tipo do Banco Ex.: Agência Bancária

Cod_Banco Texto Código do Banco

Nome_Agencia Texto Nome da Agencia

Cod_Agencia Texto Código da Agencia

Endereco Texto Endereço do Banco

Cep Texto CEP

Bairro Texto Bairro

Cidade Texto Cidade

Telefone Texto Telefone(DDD)

Page 31: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

31

Parser: ConsultaFGTSCRF

(Consulta FGTS)

Campo Tipo Descrição Valores / Formato

CNPJ Numérico CNPJ 00000000000000

RazaoSocial Texto Razão Social

Endereco Texto Endereco

ValidaAte Data Data de Validade dd/MM/yyyy

NumeroCertificado Numérico Número do Certificado

Parser: ConsultaNCM

(Consulta a base interna de NCM)

Campo Tipo Descrição Valores / Formato

NCM Texto Código NCM

DESCRICAO Texto Descrição

ALIQUOTA Texto Alíquota

Parser: ConsultaINSSDATAPREV

(Consulta INSS DataPrev)

Campo Tipo Descrição Valores / Formato

CodigoCertidao Numerico Código da Certidão

RazaoSocial Texto Razao Social

CNPJ Numerico CNPJ 00000000000000

EmitidaEm Data Data de Emissão dd/MM/yyyy

ValidaAte Data Data de Validade dd/MM/yyyy

Parser: ConsultaIbama

(Consulta Certificado de Regularidade Ibama)

Campo Tipo Descrição Valores / Formato

CNPJ Texto CNPJ 00.000.000/0000-00

RazaoSocial Texto Razão Social

Endereco Texto Endereço

Bairro Texto Bairro

Municipio Texto Município

SituacaoAcessoOnline Texto Situação Cadastro

REGULAR | IRREGULAR |

etc.

DataConsulta Data/Hora Data Consulta dd/MM/yyyy HH:mm:ss

Parser: ConsultaIbamaEmbargos

(Consulta áreas embargadas no Ibama)

Campo Tipo Descrição Valores / Formato

NrAI Numérico Número AI

Page 32: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

32

Julgamento Data Data Julgamento dd/MM/yyyy

LocalizacaodoImovel Texto Localização do Imóvel

NrTAD Numérico Número TAD

Area_ha Decimal Área

DatadeInsercaonaLista Data Data de inserção dd/MM/yyyy

Infracao Texto Descrição da Infração

UF Texto UF XX

Municipio Texto Município

RazaoSocial Texto Município

CNPJ Numérico CNPJ 00000000000000

Acao Texto Link para o Mapa da área

Parser: ConsultaJUCESP

(Consulta dados da Empresa no cadastro da JUCESP (Junta Comercial do estado de São Paulo)

Campo Tipo Descrição Valores / Formato

RazaoSocial Texto Razão Social

NIREMATRIZ Texto Número do NIRE

TipoEmpresa Texto Tipo da Empresa

DataConstituicao Data Data de Constituição dd/MM/yyyy

InicioAtividade Data Data de Início de Atividade dd/MM/yyyy

CNPJ Texto CNPJ

IE Texto Inscrição Estadual

Objeto Texto Objeto social da Empresa

Capital Texto Captial Social da Empresa

Logradouro Texto Logradouro

Numero Texto Número

Bairro Texto Bairro

Complemento Texto Complemento

Municipio Texto Município

CEP Texto CEP

UF Texto UF

DataConsulta Data/Hora Data Consulta dd/MM/yyyy HH:mm:ss

Parser: ConsultaNIT

(Consulta dados cadastrais Dataprev pelo NIT/PIS/PASEP)

Campo Tipo Descrição Valores / Formato

NIT Numérico Número NIT sem formatação 00000000000

Categoria Texto Categoria Contribuinte

CONTRIBUINTE INDIVIDUAL |

EMPREGADO DOMÉSTICO |

etc.

Nome Texto Nome do Contribuinte

Endereco Texto Endereço

Bairro Texto Bairro

CEP Texto CEP

Municipio Texto Município

Page 33: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

33

Estado Texto Estado

DataConsulta Data/Hora Data Consulta dd/MM/yyyy HH:mm:ss

Parser: ConsultaNumeroNIT

(Consulta o número do NIT/PIS/PASEP baseado nos dados completos da Pessoa Física)

Campo Tipo Descrição Valores / Formato

NIT Texto Número NIT/PIS/PASEP

TIPO Texto Tipo do cadastro [PIS/PASEP | NIT]

Nome Texto Nome completo

DataConsulta Data/Hora Data Consulta dd/MM/yyyy HH:mm:ss

Parser: ConsultaSeguroDesemprego

(Consulta a situação do seguro desemprego)

Campo Tipo Descrição

Valores /

Formato

Numero_do_PIS Numérico Número do PIS

Nome Texto Nome

Situacao Texto Situacao do seguro

Ex.: Seguro

Completo

Tempo_de_Servico Texto Tempo de Servico

Procedimento Texto Procedimento

Detalhes das Parcelas

Cada parcela será retornada em detalhes conforme estrutura de exemplo abaixo:

<ParseDataRow>

<Status>0</Status>

<StatusDesc/>

<Parser/>

<Tipo>Detail</Tipo>

<Columns>

<ParseDataColumn>

<Key>Parcela</Key>

<Value>1</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>Situacao</Key>

<Value>Paga</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>Disponivel_a_partir_de</Key>

<Value>2011-04-18</Value>

<Type>string</Type>

</ParseDataColumn>

Parser: ConsultaQSA

(Consulta Quadro de Sócios Administradores)

Page 34: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

34

Campo Tipo Descrição

Valores /

Formato

CapitalSocial Texto Capital Social

NomeEmpresarial Texto Razão Social

Relação de Sócios

Cada sócio será retornado em detalhes conforme estrutura de exemplo abaixo, será um bloco desse

para cada sócio: <ParseDataRow>

<Status>0</Status>

<StatusDesc/>

<Parser/>

<Tipo>Detail</Tipo>

<Columns>

<ParseDataColumn>

<Key>SolicitacaoConsulta</Key>

<Value>0</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>Nome</Key>

<Value>JOSE CARLOS</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>Qualificacao</Key>

<Value>49-Sócio-Administrador</Value>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>TipoLogradouro</Key>

<Value/>

<Type>string</Type>

</ParseDataColumn>

<ParseDataColumn>

<Key>LogradouroSemTipo</Key>

<Value/>

<Type>string</Type>

</ParseDataColumn>

</Columns>

</ParseDataRow>

Parser: Denatran

(Consulta Denatran)

Campo Tipo Descrição Valores / Formato

Placa Texto Placa do veículo AAA0000

Renavam Numérico Renavam 00000000000

cnpjcpf Texto CNPJ ou CPF do proprietário

00.000.000/0000-00 |

000.000.000-00

Proprietario Texto Nome ou Razão Social

Tipo Texto Tipo do veículo

AUTOMOVEL |

CAMINHAO

TRATOR | etc.

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

Page 35: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

35

Carroceria Texto Tipo Carroceria

Ex.: NãO

APLICAVEL

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Combustivel Texto Tipo Combustível

GASOLINA |

DIESEL | etc.

Marca Texto Marca do Veículo VW | M.BENZ | etc.

Modelo Texto Modelo do veículo

anofabricacao Texto Ano de Fabricação yyyy

anomodelo Texto Ano do modelo yyyy

Cor Texto Cor do Veículo

BRANCA | AZUL |

etc.

lotacao Texto Lotação

Capacidade Texto Capacidade

Potencia Texto Potencia

Cilindradas Texto Cilindradas

restricao1 Texto Registro de restrições

NAO HA |

ALIENACAO

FIDUCIARIA | etc.

restricao2 Texto Registro de restrições

NAO HA |

ALIENACAO

FIDUCIARIA | etc.

restricao3 Texto Registro de restrições

NAO HA |

ALIENACAO

FIDUCIARIA | etc.

restricao4 Texto Registro de restrições

NAO HA |

ALIENACAO

FIDUCIARIA | etc.

roubo Texto Registro de roubo Sim | Não

furto Texto Registro de furto Sim | Não

comunicacao_venda Texto Comunicação de Venda Sim | Não

restricao_judicial_renajud Texto Restrição Judicial Sim | Não

multa_interestadual Texto Multa Interestadual Sim | Não

recall Texto Recall Sim | Não

Parser: DenatranCNH

(Consulta Denatran CNH)

Campo Tipo Descrição Valores / Formato

NomeMae Texto Nome Mãe do Condutor

DataEmissaoCNH Data Data Emissão CNH dd/MM/yyyy

NomedoCondutor Texto Nome do Condutor

NroRegistro Numérico Número registro CNH

NroCNH Numérico Número CNH

ValidadeCNH Data Data de Validade dd/MM/yyyy

Categoria Texto Categoria CNH A | B | AB | etc.

NroSeguranca Numérico Número Segurança CNH

Page 36: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

36

Parser: DetranAC

(Consulta Detran - AC)

Campo Tipo Descrição Valores / Formato

Placa Texto Placa do veículo AAA0000

Renavam Numérico Renavam 00000000000

Chassi Texto Chassi do Veículo

Marca/modelo Texto Marca e Modelo Veículo

Cor Texto Cor do Veículo BRANCA | AZUL | etc.

Fab/mod Texto

Ano de fabricação/Ano do

modelo yyyy/yyyy

Tipo Texto Tipo Veículo

Combustivel Texto Tipo Combustível

GASOLINA | DIESEL |

etc.

Potencia/cilindradas Texto Potencia/Cilindradas

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Passageiros Numérico Lotação

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

Nacionalidade Texto Nacionalidade Veículo

NACIONAL |

IMPORTADO | etc.

Roubo/Furto: Texto Registro de roubo/furto

Situacao Texto Situação Veículo

Licenciamento Texto

restrição Texto Registro de restrições

Licenciaento Ano Texto

Licenciaento Vencimento Data

Data vencimento

licenciamento dd/MM/yyyy

Licenciaento Valor Texto Valor do licenciamento Ex.: R$ 74,58

Licenciaento Valor Pago Texto Ex.: R$ 0,00

Licenciaento Valor Diferenca Texto Ex.: R$ 74,58

IPVA Ano Texto yyyy

IPVA Vencimento Data Data Vencimento IPVA

IPVA Valor Texto Valor do IPVA Ex.: R$ 279,27

Parser: DetranAL

(Consulta Detran - AL)

Campo Tipo Descrição Valores / Formato

placa Texto Placa do veículo AAA0000

Renavam Numérico Renavam 00000000000

Licenciamento Texto Ano Licenciamento yyyy

Modelo Texto Modelo Veículo

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Cor Texto Cor do Veículo BRANCA | AZUL | etc.

Ano Texto Ano fabricação yyyy

Page 37: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

37

Tipo Texto Tipo Veículo

Combustivel Texto Tipo Combustível

GASOLINA | DIESEL |

etc.

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

Restricao Texto Registro de restrições

Proprietario Texto

Nome/Razão Social do

proprietario

Infracao Texto Registro de infrações SIM | NÃO

Infracaosuspensa Texto SIM | NÃO

Debito Texto SIM | NÃO

Roubo/furto Texto Registro de roubo/furto SIM | NÃO

Parser: DetranAM

(Consulta Detran - AM)

Campo Tipo Descrição Valores / Formato

Proprietario Texto

Nome/Razão Social do

proprietário

Placa Texto Placa do veículo AAA-0000

Renavam Numérico Renavam

Chassi Texto Chassi do veículo

Marca Texto Marca do Veículo VW | M.BENZ | etc.

Ano/Modelo Texto

Ano de fabricação/Ano do

modelo yyyy/yyyy

Cor Texto Cor do Veículo BRANCA | AZUL | etc.

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Tipo Texto Tipo Veículo

CAMINHAO TRATOR

| CAM.TRATOR | etc.

UltimoLicenciamento Texto Ano ultimo licenciamento yyyy

VencimentoLicenciado Data

Data de vencimento do

licenciamento dd/MM/yyyy

Restricoes Texto Registro de restrições

Taxas Decimal Ex.: 0,00

MultasDETRAN Decimal Registro de valor multa Ex.: 0,00

MultasMunicipais Decimal Registro de valor multa Ex.: 0,00

MultasOutrasUFs Decimal Registro de valor multa Ex.: 0,00

SeguroObrigatorio Decimal

Registro de valor seguro

obrigatório Ex.: 0,00

IpvaAnosAnteriores Decimal

Registro de valor IPVA anos

anteriores Ex.: 0,00

IpvaExercicioAtual Decimal Registro de valor IPVA atual Ex.: 0,00

Total Decimal Total de débitos do veículo Ex.: 0,00

Parser: DetranAP

(Consulta Detran - AP)

Campo Tipo Descrição Valores / Formato

Page 38: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

38

Placa Texto Placa do veículo AAA0000

Renavam Numérico Renavam

Chassi Texto Chassi do veículo

Marca/Modelo Texto Marca e Modelo Veículo

Cor Texto Cor do Veículo

BRANCA | AZUL |

etc.

AnoFab/Mod Texto

Ano de fabricação/Ano do

modelo yyyy / yyyy

Combustivel Texto Tipo Combustível

GASOLINA |

DIESEL | etc.

Potencia/Cilindradas Texto Potencia/Cilindradas

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

CapacidadePassageiros Numérico Capacidade de Passageiros

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

Nacionalidade Texto Nacionalidade Veículo

NACIONAL |

IMPORTADO | etc.

Municipio Texto Municipio

Roubo/Furto Texto Registro de Roubo/Furto

SituacaoVeiculo Texto Situação do Veiculo

Ex.: EM

CIRCULACAO

AnoUltimoLicenciamento Texto Ano ultimo licenciamento yyyy

Restricao Texto Registro de restrições

LicenciamentoAno Texto yyyy

LicenciamentoVencimento Data

Data de vencimento do

licenciamento dd/MM/yyyy

LicenciamentoValor Texto Valor do licenciamento Ex.: R$ 0,00

LicenciamentoValorPago Texto Valor pago do licenciamento Ex.: R$ 0,00

LicenciamentoValorDiferenca Texto

Valor diferença do

licenciamento Ex.: R$ 0,00

DPVATAno Texto Ano do seguro obrigatório yyyy

DPVATVencimento Data

Data vencimento do seguro

obrigatório dd/MM/yyyy

DPVATValor Texto Valor do seguro obrigatório Ex.: R$ 0,00

Parser: DetranBA

(Consulta Detran - BA)

Campo Tipo Descrição Valores / Formato

Proprietario Texto

Nome/Razão Social do

proprietário

Licenciado Texto Ano licenciamento yyyy

Aquisicao Texto

Data de aquisição do

veículo dd-MM-yyyy

Ipva Texto Ano IPVA yyyy

Placa Texto Placa do veículo AAA0000

Renavam Numérico Renavam

Page 39: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

39

Chassi Texto Chassi do veículo

Tipo Texto Tipo Veículo

CAMINHAO TRATOR

| CAM.TRATOR | etc.

Procedencia Texto Nacionalidade Veículo

NACIONAL |

IMPORTADO | etc.

Marca/Modelo Texto Marca/Modelo do Veículo

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

AnoModelo Texto Ano do modelo yyyy

Cor Texto Cor do veiculo

Combustivel Texto Tipo Combustível

GASOLINA | DIESEL |

etc.

AnoFabricacao Texto Ano de Fabricação yyyy

Restricao Texto

Descrição das restrições do

veiculo

RestricaoFinanceira Texto Restrição financeira Sim | Não

RestricaoAdministrativa Texto Restrição administrativa Sim | Não

RestricaoJuridica Texto Restrição jurídica Sim | Não

ComunicadoVenda Texto Comunicado de Venda Sim | Não

Parser: DetranCE

(Consulta Detran - CE)

Campo Tipo Descrição Valores / Formato

Placa Texto Placa do veículo AAA0000

Renavam Numérico Renavam

Chassi Texto Chassi do veículo

Municipio Texto Município

Anofabricacao Texto Ano de Fabricação yyyy

Anomodelo Texto Ano do modelo yyyy

Numeromotor Numérico Número do motor

Marca Texto Marca do veículo

Cor Texto Cor do veiculo

Tipo Texto Tipo Veículo

CAMINHAO TRATOR

| CAM.TRATOR | etc.

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

Combustivel Texto Tipo Combustível

GASOLINA | DIESEL |

etc.

Nacionalidade Texto Nacionalidade Veículo

NACIONAL |

IMPORTADO | etc.

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Exercicio Texto Ano exercício yyyy

Isentoipva Texto Isenção de IPVA Ex.: NAO ISENTO

DebitoIpva Texto Existe débito IPVA SIM | NÃO

Page 40: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

40

QueixaRoubo Texto Queixa de roubo SIM | NÃO

SNG Texto Restrições

Ex.: VEICULO COM

ALIENACAO

FIDUCIARIA

AnoSeguro Texto Ano do seguro yyyy

Parser: DetranDF

(Consulta Detran - DF)

Campo Tipo Descrição Valores / Formato

Placa Texto Placa do veículo AAA0000

Renavam Numérico Renavam

Chassi Texto Chassi do veículo

Marca Texto Marca do veículo

Modelo Texto Modelo do veículo

Tipo Texto Tipo Veículo

CAMINHAO

TRATOR |

CAM.TRATOR | etc.

Combustivel Texto Tipo Combustível

GASOLINA | DIESEL |

etc.

Potencia Texto Potência do Veículo

Cilindradas Texto Cilindradas do Veículo

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Passageiros Numérico Lotação máxima

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

Nacionalidade Texto Nacionalidade Veículo

NACIONAL |

IMPORTADO | etc.

Municipio Texto Município

Uf Texto UF XX

Roubo Texto Registro de roubo

Furto Texto Registro de furto

Situacao Texto Situação do veículo

Ex.: EM

CIRCULACAO

Anolicenciamento Texto Ano licenciamento yyyy

Parser: DetranES

(Consulta Detran - ES)

Consulta temporariamente indisponível.

Parser: DetranGO

(Consulta Detran - GO)

Campo Tipo Descrição Valores / Formato

Ano Texto Ano fabricação veículo yyyy

Chassi Texto Chassi do veículo

Cor Texto Cor do Veículo

BRANCA | AZUL |

etc.

Page 41: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

41

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

Marca Texto Marca do Veículo VW | M.BENZ | etc.

Municipio Texto Município

NumeroMotor Texto Número do motor

Observacao Texto

Placa Texto Placa do veículo AAA0000

Restricao Texto Registro de restrições

SituacaoDetran Texto

SituacaoFurto Texto Ex.: NAO EXISTE

SituacaoIpva Texto Ex.: SEM DEBITO

SituacaoLicenciamento Texto Ex.: SEM DEBITO

SituacaoMulta Texto Ex.: NAO EXISTE

Parser: DetranMA

(Consulta Detran - MA)

Campo Tipo Descrição Valores / Formato

Renavam Numérico Renavam

Marca/Modelo Texto Marca e Modelo Veículo

CorBase Texto Cor do Veículo

BRANCA | AZUL |

etc.

Proprietario Texto

Nome/Razão Social do

proprietário

Municipio Texto Município

Parser: DetranMG

(Consulta Detran - MG)

Campo Tipo Descrição Valores / Formato

Placa Texto Placa do veículo AAA0000

PlacaAnterior Texto Placa anterior do veículo

Municipio Texto Município

MunicipioAnterior Texto Município Anterior

Marca Texto Marca do veículo

AnoFabricacao Texto Ano fabricação veículo yyyy

AnoModelo Texto Ano modelo veículo yyyy

IPVAPago Texto Ano pagamento IPVA yyyy

Parcela Texto Forma de pagamento IPVA Ex.: UNICA

SeguroPago Texto Ano Seguro yyyy

Parcela2 Texto Ex.: UNICA

SeguroAnteriorPago Texto Ano Seguro Anterior yyyy

Parcela3 Texto Ex.: UNICA

TaxaLicenciamentoPaga Texto Ano Licenciamento yyyy

DataLicenciamento Data Data do licenciamento dd/MM/yyyy

SituacaoLicenciamento Texto

NumeroAR Numérico

Page 42: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

42

Parser: DetranMS

(Consulta Detran - MS)

Campo Tipo Descrição Valores / Formato

Placa Texto Placa do veículo AAA0000

Chassi Texto Chassi do veículo

Motor Texto

Renavam Numérico Renavam

Marca Texto Marca do Veículo VW | M.BENZ | etc.

Cor Texto Cor do Veículo

BRANCA | AZUL |

etc.

Cidade Texto Nome Cidade

AnoFabricacao Texto Ano fabricação veículo yyyy/yyyy

Dt.Exp.Doc Data dd/MM/yyyy

Observacao Texto

Parser: DetranPA

(Consulta Detran - PA)

Campo Tipo Descrição Valores / Formato

InformacoesProprietario Texto

Nome/Razão Social do

proprietário

Placa Texto Placa do veículo AAA0000

PlacaAnterior Texto Placa anterior do veículo

Renavam Numérico Renavam

Chassi Texto Numeração Chassi

TipoRemarcacaoChassi: Texto

AnoFabricacao Texto Ano fabricação veículo yyyy

AnoModelo Texto Ano modelo veículo yyyy

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Marca/Modelo Texto Marca e modelo do veículo

MunicipioEmplacamento Texto

Procedencia Texto Nacionalidade Veículo

NACIONAL |

IMPORTADO | etc.

Jurisdicao Texto UF XX

Eixos Numérico Número de Eixos do veículo

DataAquisicao Data dd/MM/yyyy

DataRegistro Data dd/MM/yyyy

Observacao Texto

AnoLicenciado Texto yyyy

Ipva Texto Situação IPVA

DataLicenciamento Data dd/MM/yyyy

Seguro Texto Situação Seguro

SituacaoLicenciamento Texto

StatusVeiculo Texto

Cor Texto Cor do Veículo BRANCA | AZUL | etc.

Page 43: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

43

Combustivel Texto Tipo Combustível

GASOLINA | DIESEL |

etc.

TipoVeiculo Texto Tipo Veículo

CAMINHAO

TRATOR |

CAM.TRATOR | etc.

TipoCarroceria Texto Tipo Carroceria

Potencia Texto Potência do Veículo

CaixaCambio Texto

Cilindradas Texto

CMT Texto

CapacidadeCarga Texto

PBT Texto

CapacidadePassageiros Texto

NumeroMotor Texto

EspecieVeiculo Texto

Restricoes Texto

Infracoes Texto

Parser: DetranPB

(Consulta Detran - PB)

Campo Tipo Descrição

Valores /

Formato

Licenciado Texto Ano licenciamento yyyy

Proprietario Texto Nome/Razão Social do proprietário

Placa Texto Placa do veículo AAA0000

Combustivel Texto Tipo Combustível

GASOLINA |

DIESEL | etc.

Marca/modelo Texto Marca e Modelo Veículo

Especie/tipo Texto

anofabricacao Texto Ano de Fabricação yyyy

anomodelo Texto Ano do Modelo yyyy

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Cor Texto Cor do Veículo

BRANCA |

AZUL | etc.

vencimento_licenciamento Data Data vencimento licenciamento dd/MM/yyyy

observacao Texto

Restricao Texto

Financeira Texto

Cidade Texto

Situacao Texto Situação veículo

Parser: DetranPE

(Consulta Detran - PE)

Campo Tipo Descrição

Valores /

Formato

Page 44: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

44

Placa Texto Placa do veículo AAA0000

placaanterior Texto Placa anterior do veículo AAA0000

Chassi Texto Numeração Chassi

Tipo Texto

Combustivel Texto Tipo Combustível

GASOLINA |

DIESEL | etc.

Marca/modelo Texto Marca e Modelo Veículo

anofabricacao Texto Ano de Fabricação yyyy

anomodelo Texto Ano do Modelo yyyy

CAP/POT/CIL Texto Capacidade, Potência, Cilindradas

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Cor Texto Cor do Veículo

BRANCA |

AZUL | etc.

restricoes Texto Registro de restrições

Parser: DetranPI

(Consulta Detran - PI)

Campo Tipo Descrição

Valores /

Formato

Obs Texto Observações

Marca/Modelo Texto Marca e Modelo Veículo

Placa Texto Placa do veículo AAA0000

Renavam Numérico Renavam

Exercicio Texto yyyy

Parser: DetranPR

(Consulta Detran - PR)

Campo Tipo Descrição Valores / Formato

anofabricacao Texto Ano de Fabricação yyyy

anomodelo Texto Ano do Modelo yyyy

averbacao Texto

Cadastrado Texto

caixacambio Texto

Capacidade Texto Lotação máxima

carnelicenciamento Texto

Carroceria Texto

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

categoria_dpvat Texto

Chassi Texto

Cidade Texto

Cilindradas Texto

cmt Texto

Combustivel Texto Tipo Combustível

GASOLINA | DIESEL |

etc.

Page 45: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

45

Cor Texto Cor do Veículo BRANCA | AZUL | etc.

data_aquisicao Data dd/MM/yyyy

data_expedicao Data dd/MM/yyyy

data_registro Data dd/MM/yyyy

debitoipva Texto

Eixos Texto

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

excecao Texto

exercicio Texto

Financeira Texto

Furto Texto Registro de furto

Gravame Texto

Impedimentos Texto Registro de impedimentos

Infracaosuspensa Texto

infracoes Texto Registro de infracoes

ipva Texto

ipva_anteriores Texto

ipva_parcela Texto

isentoipva Texto

Licenciado Texto

licenciado_ate Texto

Licenciamento Texto

Marca Texto Marca do Veículo VW | M.BENZ | etc.

marca_modelo Texto

Modelo Texto

Motor Texto

multas_detran Texto

multas_municipais Texto

multas_outras_ufs Texto

Municipio Texto

municipio_anterior Texto

Nacionalidade Texto

numero_ar Texto

numero_motor Texto

observacao Texto Observações

origem_dados Texto

Passageiros Texto Lotação máxima

pbt Texto

Placa Texto Placa do veículo AAA-0000

placa_anterior Texto Placa anterior do veículo AAA-0000

Potencia Texto

procedencia Texto

Proprietario Texto

Nome/Razão Social do

proprietário

Page 46: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

46

proprietario_anterior Texto

Nome/Razão Social do

proprietário anterior

Recadastrado Texto

remarcacaochassi Texto

renainf Texto

Renavam Texto Renavam

restricoes Texto Registro de restrições

Roubo Texto Registro de roubo

Seguro Texto

seguro_obrigatorio Texto

Situacao Texto Situação Veículo

situacao_detran Texto

situacao_furto Texto

situacao_ipva Texto

situacao_licenciamento Texto

situacao_multa Texto

situacao_restricao Texto

situacaolacre Texto

Taxas Texto

Tipo Texto Tipo Veículo

CAMINHAO TRATOR |

CAM.TRATOR | etc.

Uf Texto XX

vencimento_licenciamento Texto

cnpj/cpf Texto

Parser: DetranRJ

(Consulta Detran - RJ)

Consulta temporariamente indisponível.

Parser: DetranRJMultas

(Consulta multas no Detran de RJ)

Consulta temporariamente indisponível.

Parser: DetranRN

(Consulta Detran - RN)

Campo Tipo Descrição

Valores /

Formato

Placa Texto Placa do veículo AAA0000

Renavam Numérico Renavam

placaanterior Texto Placa anterior do veículo AAA0000

Tipo Texto Tipo do Veículo

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

Passageiros Texto Lotação máxima

Page 47: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

47

Marca/modelo Texto Marca e Modelo Veículo

Fabricação/Modelo Texto Ano Fabricação e Ano modelo yyyy/yyyy

Potencia Texto

Combustivel Texto Tipo Combustível

GASOLINA |

DIESEL | etc.

Cor Texto Cor do Veículo

BRANCA |

AZUL | etc.

Carroceria Texto

Proprietario Texto Nome/Razão Social do proprietário

Recadastrado Texto

proprietarioanterior Texto

Nome/Razão Social do proprietário

anterior

situacaolacre Texto

Municipio Texto

Licenciado Texto

Adquirido Data dd/MM/yyyy

Situacao Texto Situação do Veículo

Restricao Texto Registro de restrições

Impedimentos Texto Registro de impedimentos

Parser: DetranRO

(Consulta Detran - RO)

Campo Tipo Descrição Valores / Formato

Placa Texto Placa do veículo AAA0000

Chassi Texto Chassi do veículo

Renavam Numérico Renavam

Tipo Texto Tipo Veículo

CAMINHAO

TRATOR |

CAM.TRATOR |

etc.

Marca/Modelo Texto Marca e modelo do veículo

AnoFabricacao/AnoMod

elo/Fabricacao Texto

AnoFabricacao/AnoModelo/Fabri

cacao

yyyy / yyyy /

NACIONAL |

IMPORTADO

NumeroMotor Texto Número do Motor

Cor Texto Cor do veículo

AnoEmissaoLicenciame

nto/AnoPagamentoLicen

ciamento Texto

AnoEmissaoLicenciamento/AnoP

agamentoLicenciamento yyyy / yyyy

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Combustivel Texto Tipo Combustível

GASOLINA |

DIESEL | etc.

Carroceria Texto Tipo Carroceria

Cap.Passageiro Numérico Lotação máxima

Page 48: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

48

Cap.Cargas Numérico Cap. De Carga – Peso 0,00

MunicipioEmplacamento Texto Município de emplacamento

Cilindrada Numérico Cilindradas do Veículo

HP Numérico

Excecao Texto Registro de exceções

Roubo/Furto Texto Registro de roubo/furto Sim | Não

Parser: DetranRR

(Consulta Detran - RR)

Campo Tipo Descrição Valores / Formato

Placa Texto Placa do veículo AAA0000

Renavam Numérico Renavam

Chassi Texto Chassi do veículo

Marca/Modelo Texto Marca e modelo do veículo

Cor Texto Cor do veículo

AnoFab/Mod Texto

Ano de Fabricação e Ano do

Modelo yyyy / yyyy

Tipo Texto Tipo Veículo

CAMINHAO TRATOR

| CAM.TRATOR | etc.

Combustivel Texto Tipo Combustível

GASOLINA | DIESEL |

etc.

Potencia/Cilindradas Texto

Potência/Cilindradas do

veículo

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

CapacidadePassageiros Numérico Lotação máxima

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

Nacionalidade Texto Nacionalidade do veículo

NACIONAL |

IMPORTADO

Municipio Texto Município

Roubo/Furto Texto Registro de roubo/furto

SituacaoVeiculo Texto Situação do Veiculo

AnoUltimoLicenciamento Texto Ano do último Licenciamento yyyy

Restricao Texto Registro de restrição

Parser: DetranRS

(Consulta Detran - RS)

Campo Tipo Descrição Valores / Formato

Placa Texto Placa do veículo AAA0000

Chassi Texto

Numeração

Chassi

Renavam Numérico Renavam

anofabricacao Texto

Ano de

Fabricação yyyy

anomodelo Texto Ano modelo yyyy

Page 49: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

49

Marca Texto

Marca do

Veículo VW | M.BENZ | etc.

Modelo Texto

Modelo do

Veículo

Tipo Texto Tipo Veículo CAMINHAO TRATOR | CAM.TRATOR | etc.

Especie Texto Espécie PASSAGEIRO | TRACAO | etc.

Cor Texto Cor do Veículo BRANCA | AZUL | etc.

Municipio Texto Município

Licenciamento Texto

Restricao Texto

Registro de

restrições

Parser: DetranSC

(Consulta Detran - SC)

Campo Tipo Descrição

Valores /

Formato

anofabricacao Texto Ano de Fabricação yyyy

Anolicenciamento Texto

anomodelo Texto Ano modelo yyyy

averbacao Texto

Cadastrado Texto

caixacambio Texto

Capacidade Texto Lotação máxima

carnelicenciamento Texto

Carroceria Texto

Ex.: 999-NAO

APLICAVEL

Categoria Texto Ex.: 2-Aluguel

categoria_dpvat Texto Ex.: 10

Chassi Texto Numeração Chassi

Cidade Texto Cidade

Cilindradas Texto

cmt Texto

Combustivel Texto Tipo Combustível

GASOLINA |

DIESEL | etc.

Cor Texto Cor do Veículo

BRANCA |

AZUL | etc.

data_aquisicao Data dd/MM/yyyy

data_expedicao Data dd/MM/yyyy

data_registro Data dd/MM/yyyy

debitoipva Texto Registro de débitos IPVA

Eixos Texto Número de Eixos

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

excecao Texto

exercicio Texto

Financeira Texto

Page 50: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

50

Furto Texto Registro de furto

Gravame Texto

Impedimentos Texto Registro de impedimentos

Infracaosuspensa Texto

infracoes Texto Registro de infrações

ipva Texto

ipva_anteriores Texto

ipva_parcela Texto

isentoipva Texto

Licenciado Texto

licenciado_ate Texto

Licenciamento Texto

Marca Texto Marca do Veículo

marca_modelo Texto

Modelo Texto Modelo do Veículo

Motor Texto

multas_detran Texto

multas_municipais Texto

multas_outras_ufs Texto

Municipio Texto

municipio_anterior Texto

Nacionalidade Texto

numero_ar Texto

numero_motor Texto

observacao Texto

origem_dados Texto

Passageiros Texto

pbt Texto

Placa Texto Placa do veículo AAA0000

placa_anterior Texto Placa anterior do veículo AAA0000

Potencia Texto

procedencia Texto

Proprietario Texto Nome/Razão Social do proprietário

proprietario_anterior Texto

Nome/Razão Social do proprietário

anterior

Recadastrado Texto

remarcacaochassi Texto

renainf Texto

Renavam Texto

restricoes Texto

Roubo Texto

Seguro Texto

seguro_obrigatorio Texto

Situacao Texto

Page 51: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

51

situacao_detran Texto

situacao_furto Texto

situacao_ipva Texto

situacao_licenciamento Texto

situacao_multa Texto

situacao_restricao Texto

situacaolacre Texto

Taxas Texto

Tipo Texto

Uf Texto

vencimento_licenciamento Texto

cnpj/cpf Texto

Parser: DetranSE

(Consulta Detran - SE)

Campo Tipo Descrição

Valores /

Formato

RENAVAM Numérico Renavam

Placa Texto Placa do veículo AAA0000

Proprietario/Arrendatario Texto Nome/Razão Social do proprietário

Observacao Texto

Parser: DetranSP2

(Consulta Detran - SP)

Campo Tipo Descrição Valores / Formato

Placa Texto Placa do veículo AAA0000

Renavam Numérico Renavam

Ipva Texto

Ex.: NADA

CONSTA

Multas Texto

Ex.: NADA

CONSTA

Bloqueiofurto Texto

Ex.: NADA

CONSTA

Restricaoadministrativa Texto

Ex.: NADA

CONSTA

Restricaotributaria Texto

Ex.: NADA

CONSTA

Restricajudiciaria Texto

Ex.: NADA

CONSTA

Restricaofinanceira Texto

Ex.: NADA

CONSTA

Registroguincho Texto

Ex.: NADA

CONSTA

Inspecaoveicularano Texto

Licenciamentoano Texto

Ex.: NADA

CONSTA

Page 52: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

52

Parser: DetranSPMultas

(Consulta multas no Detran SP)

Consulta temporariamente indisponível.

Parser: DetranTO

(Consulta Detran - TO)

Campo Tipo Descrição Valores / Formato

Placa Texto Placa do veículo AAA0000

Renavam Numérico Renavam

Placaanterior Texto Placa anterior do veículo AAA0000

Tipo Texto Tipo Veículo

CAMINHAO

TRATOR |

CAM.TRATOR | etc.

Categoria Texto Categoria

PARTICULAR |

ALUGUEL | etc.

Especie Texto Espécie

PASSAGEIRO |

TRACAO | etc.

Passageiros Numérico Lotação máxima

Marca/Modelo Texto Marca e modelo do veículo

Fabricacao/Modelo Texto

Ano de Fabricação e Ano

modelo yyyy/yyyy

Potencia Texto

Combustivel Texto Tipo Combustível

GASOLINA | DIESEL

| etc.

Cor Texto Cor do Veículo

BRANCA | AZUL |

etc.

Carroceria Texto

NomeProprietario Texto

Nome/Razão Social do

proprietário

SituacaoLacre Texto

ProprietarioAnterior Texto

Nome/Razão Social do

proprietário anterior

Cadastrado Texto

Municipio Texto

Licenciado Texto

AdquiridoEm Texto

Situacao Texto

RestricaoVenda Texto

Gravame Texto

Impedimentos Texto Registro de impedimentos

Parser: FDCCNPJ

(Consulta Prefeitura Municipal de São Paulo, Ficha de Dados Cadastrais)

Campo Tipo Descrição

Valores /

Formato

CCM Texto

Número do Cadastro de Contribuintes

Mobiliários

Page 53: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

53

RazaoSocial Texto Razão Social

000000000000

00

PessoaJuridica Texto Pessoa Jurídica

Logradouro Texto Endereço

Bairro Texto Bairro

CEP Texto CEP

Telefone Texto Telefone

CNPJ Texto CNPJ

InicioFuncionamento Data Data Início Funcionamento dd/MM/yyyy

DataInscricao Data Data da Inscrição dd/MM/yyyy

CCMCentralizador Texto Código Centralizador 00000000

NrOrdemEndereco Texto Tipo Endereço

Comercial/

Residencial

NrContribImpostoPredialS

QL Texto

Número Contribuição Imposto Predial

(SQL)

CodigoEstabelecimento Texto Código do Estabelecimento

DataInicioEstab Data/Hora Data início Estabelecimento dd/MM/yyyy

Taxa Texto Taxa

UltimaAtualizacao Data/Hora Data última atualização dd/MM/yyyy

Detalhes de Impostos

Ocorrências – 0-N

Campo Tipo Descrição

Valores /

Formato

Codigo Numérico Número Sequencial

DatadeInicio Data Data Início dd/MM/yyyy

Imposto Texto Tipo de Imposto

AliquotadoImposto Texto Alíquota do Imposto

Livros Texto Livros

Documentos Texto Documentos

QtdAnuncios Texto Quantidade de Anuncios

Parser: MinisterioTrabalho

(Consulta Lista Suja Ministério do Trabalho)

Campo Tipo Descrição

Valores /

Formato

RazaoSocialNome Texto Nome/Razão Social

Estabelecimento Texto Nome do estabelecimento

Localizacao Texto

Ex.: Zona

Rural

Municipio Texto

UF Texto

CNPJCPF Texto CNPJ/CPF sem formatação

NrTrabalhadoresLibertados Numérico Número de trabalhadores libertados

RamoAtividade Texto

Ramo de Atividade do

estabelecimento

MesAno Texto

Page 54: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

54

Parser: ObrigatoriedadeIE

(Verifica se dentre uma lista de CNAE, algum obriga a empresa a ter IE.)

Campo Tipo Descrição

Valores /

Formato

ObrigatoriedadeIE Texto Obrigado a ter IE - Sim ou Não S | N

Parser: PrefeituraCuritiba

(Consulta Prefeitura Municipal de Curitiba, Ficha de Dados Cadastrais)

Campo Tipo Descrição

Valores /

Formato

NOME Texto Nome/Razão Social

ENDERECO Texto Endereço

NUMERO Texto Número

IM Texto Inscrição Municipal

CNPJ Texto CNPJ 00000000000000

UNIDADE Texto Número da unidade

ANDAR Texto Andar

COMPLEMENTO Texto Complemento

BAIRRO Texto Bairro

CEP Texto CEP 00000-000

INICIOATIVIDADE Data Data Inicio Atividade dd/MM/yyyy

SITUACAO Texto Situação Cadastral

NUMEROALVARA Texto Número do alvará

DATAEMISSAO Data Data de Emissão dd/MM/yyyy

DATAEXPIRACAO Data Data Expiração dd/MM/yyyy

TIPOINSTALACAO Texto Tipo de instalçao

ATIVIDADEPRINCIPAL Texto Atividade Principal

ATIVIDADESECUNDARIA Texto Atividade Secundária

Parser: PrefeituraSPInterno

(Consulta Situação Cadastral de Prestadores de Serviços de Outros Municípios)

Campo Tipo Descrição

Valores /

Formato

CNPJ Texto CNPJ sem formatação

0000000000000

0

RSOCIAL Texto Razão Social

Atividade Texto

Descrição da atividade exercida pela

empresa. Para cada atividade será

aberta uma tag

<Key>Atividade</Key>.

Parser: PreQualificacao

(Qualifica os dados do NIS (PIS, PASEP, NIT) para os eventos iniciais do eSocial)

Page 55: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

55

Campo Tipo Descrição

Valores /

Formato

CPF Texto CPF sem formatação 00000000000

NomeCompleto Texto Nome Completo

Data_Nascimento Data Data de Nascimento dd/MM/yyyy

PIS Texto Número do PIS

StatusConsultaCPF Texto Status Consulta Receita CPF

Consultado |

Inexistente | etc.

SituacaoCPF Texto Situação Cadastro Receita CPF

REGULAR |

PENDENTE

DE

REGULARIZA

ÇÃO | etc.

Nome_RFB_QuandoDivergente Texto

Será retornado o nome obtido na

consulta da Receita CPF em caso de

divergência com o enviado para

consulta.

Mensagem_NIT3 Texto

Mensagem de retorno da consulta NIT

(Dataprev)

Ex.: NIS

validado no

Cadastro

Nacional de

Informações

Sociais.

NIT_QuandoDivergente Texto

Será retornado o número do PIS em

caso de divergência com o enviado

para consulta.

Mensagem_DataPrev Texto

Mensagem de retorno da consulta

complementar Dataprev

Parser: ReceitaFederalCNPJ

(Consulta situação do CNPJ na Receita Federal)

Campo Tipo Descrição Valores / Formato

CNPJ Numérico CNPJ sem formatação 00000000000000

DataAbertura Data/Hora Data de Abertura

dd/MM/yyyy

HH:mm:ss

RazaoSocial Texto Razão Social

NomeFantasia Texto Nome Fantasia

CodDescAtividadePrincipal Texto Atividade Principal

CodDescAtividadeSecundaria Texto Atividade(s) Secundaria(s)

CodDescNaturezaJuridica Texto Natureza Jurídica

Logradouro Texto Logradouro

Numero Texto Número

Complemento Texto Complemento

CEP Texto CEP

Bairro Texto Bairro

Municipio Texto Município

Page 56: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

56

UF Texto UF XX

Email Texto Email

Telefone Texto Telefone

SituacaoCadastro Texto Situação Cadastral

ATIVA |

SUSPENSA | etc.

SituacaoFlag Binário FLAG Situação Cadastral 0 | 1

DataSituacaoCadastro Data/Hora Data Situação Cadastral

dd/MM/yyyy

HH:mm:ss

DataConsulta Data/Hora Data Consulta

dd/MM/yyyy

HH:mm:ss

SituacaoEspecial Texto Situação Especial

DataSituacaoEspecial Data/Hora Data Situação Especial

dd/MM/yyyy

HH:mm:ss

TipoLogradouro Texto Tipo do Logradouro

LogradouroSemTipo Texto Logradouro sem o Tipo

Matriz Booleano

TRUE = Matriz | FALSE =

Filial TRUE|FALSE

Parser: ReceitaFederalCPF

(Consulta Situação CPF Receita Federal)

Campo Tipo Descrição Valores / Formato

CPF Numérico Número do CPF sem formatação 00000000000

Nome Texto Nome do Contribuinte

DtNascimento Data/Hora Data de Nascimento dd/MM/yyyy HH:mm:ss

SituacaoCadastro Texto Situação Cadastral

REGULAR | PENDENTE DE

REGULARIZAÇÃO | etc.

DtInscricao Texto Data da Inscrição

SituacaoFlag Binário FLAG Situação Cadastral 0 | 1

CodigoControle Texto Código de Controle da Consulta XXXX.XXXX.XXXX.XXXX

DigitoVerificador Texto Digito Verificador 00

DtObito Texto Ano do Óbito

DataConsulta Data/Hora Data Hora Execução da Consulta dd/MM/yyyy HH:mm:ss

Parser: Simples Nacional

(Consulta se a empresa é optante pelo SIMPLES)

Campo Tipo Descrição Valores / Formato

CNPJ Numérico CNPJ sem formatação 00000000000000

Page 57: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

57

RazaoSocial Texto Razão Social

SituacaoSIMPLES Texto Situação SIMPLES Nacional

Optante pelo Simples

Nacional desde

dd/MM/YYYY | NÃO

optante pelo Simples

Nacional | etc.

SItuacaoSIMEI Texto Situação SIMEI

Optante pelo SIMEI

desde dd/MM/YYYY |

NÃO optante pelo

SIMEI | etc.

OpcaoSimplesAnteriores Texto

Informações sobre opções

Anteriores

OpcaoSimeiAnteriores Texto

Informações sobre opções

Anteriores

DataSituacaoCadastro Data/Hora Data Situação Cadastro

dd/MM/yyyy

HH:mm:ss

DataConsulta Data/Hora Data Consulta

dd/MM/yyyy

HH:mm:ss

SituacaoFlag Binário FLAG Situação [0 | 1]

Parser: Sintegra

(Consulta Sintegra)

Campo Tipo Descrição Valores / Formato

CNPJ Numérico CNPJ sem formatação 00000000000000

IE Numérico Inscrição Estadual

DataAbertura Data/Hora Data de Abertura

dd/MM/yyyy

HH:mm:ss

RazaoSocial Texto Razão Social

NomeFantasia Texto Nome Fantasia

AtividadeEconomica Texto Atividade Econômica

CodDescAtividadePrincipal Texto Atividade Principal

CodDescAtividadeSecundaria Texto

Atividade(s)

Secundaria(s)

CodDescNaturezaJuridica Texto Natureza Jurídica

Logradouro Texto Logradouro

Numero Texto Número

Complemento Texto Complemento

CEP Texto CEP

Bairro Texto Bairro

Municipio Texto Município

UF Texto UF XX

SituacaoCadastro Texto Situação Cadastral

ATIVA ou Habilitada |

INATIVA ou

Inabilitada| etc.

SituacaoFlag Binário FLAG Situação Cadastral [0 | 1]

DataSituacaoCadastro Data/Hora Data Situação Cadastral

dd/MM/yyyy

HH:mm:ss

Page 58: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

58

DataConsulta Data/Hora Data Consulta

dd/MM/yyyy

HH:mm:ss

NumeroConsulta Numérico Número da Consulta

RegimeApuracao Texto Regime de Apuração

CodigoSituacao Binário FLAG Situação Cadastral

DataInicioFuncionamento Data/Hora

Data Início

Funcionamento

dd/MM/yyyy

HH:mm:ss

DataInscricao Data/Hora Data Inscrição

dd/MM/yyyy

HH:mm:ss

DataInicioEstabelecimento Data/Hora

Data Início

Estabelecimento

dd/MM/yyyy

HH:mm:ss

DataUltimaAtualizacao Data/Hora Data última atualização

dd/MM/yyyy

HH:mm:ss

Email Texto E-mail

Telefone Texto Telefone

RegFiscal Texto

Informa situação do

regime fiscal (Apenas

MT)

HABILITADO | NÃO

HABILITADO

ObrigNFe Texto

Informação sobre a

obrigatoriedade de

emissão da NF-e

DataObrigNFe Data/Hora

Data início

obrigatoriedade

dd/MM/yyyy

HH:mm:ss

ObrigEFD Texto

Informação sobre a

obrigatoriedade EFD

Parser: Suframa

(Consulta a situação no SUFRAMA)

Campo Tipo Descrição Valores / Formato

CNPJ Numérico CNPJ sem formatação 00000000000000

IS Numérico Inscrição SUFRAMA

RazaoSocial Texto Razão Social

AtividadeEconomica Texto Atividade Econômica

CodDescAtividadePrincipal Texto Atividade Principal

CodDescAtividadeSecundaria Texto Atividade(s) Secundaria(s)

Logradouro Texto Logradouro

Complemento Texto Complemento

CEP Texto CEP

Bairro Texto Bairro

Municipio Texto Município

UF Texto UF XX

SituacaoCadastro Texto Situação Cadastral

ATIVA | INATIVA|

etc.

SituacaoFlag Binário FLAG Situação Cadastral [0 | 1]

DataConsulta Data/Hora Data Consulta

dd/MM/yyyy

HH:mm:ss

Email Texto E-mail

Page 59: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

59

Telefone Texto Telefone

Parser: ObrigatoriedadeNFeFull

(Consulta a obrigatoriedade de emissão de Nfe)

Retorno quando a obrigatoriedade for enquadrada por credenciamento Sintegra:

Campo Tipo Descrição

Valores /

Formato

DataInicioObrigatoriedade Data/Hora Data início da obrigatoriedade

dd/MM/yyyy

HH:mm:ss

DataCredenciamento Data/Hora

Data do Credenciamento para

emissão de NFe

dd/MM/yyyy

HH:mm:ss

Detalhes da fonte da consulta

NrCnpj Numérico CNPJ sem formatação 00000000000000

NrInscrEstadual Numérico IE sem formatação NmRazaoSocial Texto Razão Social

NmFantasia Texto Nome Fantasia

DsLogradouro Texto Endereço

DsNumero Texto Número

DsComplemento Texto Complemento

DsBairro Texto Bairro

DsMunicipio Texto Municipio

DsEstado Texto UF XX

NrCep Texto CEP

DsAtividadeEconomica Texto Atividade Principal

DsAtividadeSecundaria Texto Atividade Secundária

DsSituacaoCadastro Texto Situação Cadastro

DmSituacao Binário DmStatus 0 | 1

DtSituacaoCadastro Data/Hora Data da Situação Cadastral

dd/MM/yyyy

HH:mm:ss

DtConsulta Data/Hora Data da Consulta

dd/MM/yyyy

HH:mm:ss

NrConsulta Numérico Número Consulta

DsRegimeApuracao Texto Regime de apuração

DtAbertura Data/Hora Data abertura

dd/MM/yyyy

HH:mm:ss

CodDescAtiveConPrincipal Texto

Código e Descrição Atividade

Principal

CodDescNatJur Texto

Código e Descrição Natureza

Jurídica

SituacaoEspecial Texto Situação Especial

DtSituacaoEspecial Data Data Situação Especial dd/MM/yyyy

NrCpf Numérico CPF sem formatação 00000000000

Nome Texto Nome

CdControle Texto Código Controle

Page 60: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

60

NrTelefone Texto Número Telefone

DtInicioFuncionamento Data Data Inicio Funcionamento dd/MM/yyyy

DtInscricao Data Data Inscrição dd/MM/yyyy

DtInicioEstabelecimento Data Data Inicio Estabelecimento dd/MM/yyyy

DtUltimaAtualizacao Data Data Última Atualização dd/MM/yyyy

DsRespTecnico Texto Responsável Técnico

DsRespLegal Texto Responsável Legal

NrAutorizacaoAnvisa Texto Autorização Anvisa

DtAutorizacaoAnvisa Texto Data Autorização Anvisa dd/MM/yyyy

NrProcessoAnvisa Texto Número Processo Anvisa

TpAutorizacaoAnvisa Texto Tipo Autorização Anvisa

DsSituacaoAnvisa Texto Descrição Situação Anvisa

DsEmail Texto E-mail

DtVenctoAutAnvisa Data

Data Vencimento Autorização

Anvisa dd/MM/yyyy

MotivoSituacao Texto Motivo da Situacao

DmCredenciamentoAntecipado Texto Credenciamento Antecipado

CNAEOBRIGATORIEDADE Numérico

CNAE que obriga emissão de

NFe

DESCRICAOCNAE Texto Descrição CNAE

DTINICIOOBRIGATORIEDA

DE Data Data Inicio Obrigatoriedade dd/MM/yyyy

REFERENCIA Texto

Portaria que faz referência à

obrigatoriedade

OBS1 Texto Observações

OBS2 Texto Observações

Retorno quando a obrigatoriedade for enquadrada pelo CNAE:

Campo Tipo Descrição

Valores /

Formato

CNAEObrigatoriedade Texto

Cod. CNAE que obriga a

emissão de NFe

DataInicioObrigatoriedade Data Data início da obrigatoriedade dd/MM/yyyy

Referencia Texto

Portaria que faz referência à

obrigatoriedade

Detalhes da fonte da consulta

NrCnpj Numérico CNPJ sem formatação 00000000000000

NrInscrEstadual Numérico IE sem formatação NmRazaoSocial Texto Razão Social

NmFantasia Texto Nome Fantasia

DsLogradouro Texto Endereço

DsNumero Texto Número

DsComplemento Texto Complemento

DsBairro Texto Bairro

DsMunicipio Texto Municipio

DsEstado Texto UF XX

Page 61: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

61

NrCep Texto CEP

DsAtividadeEconomica Texto Atividade Principal

DsAtividadeSecundaria Texto Atividade Secundária

DsSituacaoCadastro Texto Situação Cadastro

DmSituacao Binário DmStatus 0 | 1

DtSituacaoCadastro Data/Hora Data da Situação Cadastral

dd/MM/yyyy

HH:mm:ss

DtConsulta Data/Hora Data da Consulta

dd/MM/yyyy

HH:mm:ss

NrConsulta Numérico Número Consulta

DsRegimeApuracao Texto Regime de apuração

DtAbertura Data/Hora Data abertura

dd/MM/yyyy

HH:mm:ss

CodDescAtiveConPrincipal Texto

Código e Descrição Atividade

Principal

CodDescNatJur Texto

Código e Descrição Natureza

Jurídica

SituacaoEspecial Texto Situação Especial

DtSituacaoEspecial Data Data Situação Especial dd/MM/yyyy

NrCpf Numérico CPF sem formatação 00000000000

Nome Texto Nome

CdControle Texto Código Controle

NrTelefone Texto Número Telefone

DtInicioFuncionamento Data Data Inicio Funcionamento dd/MM/yyyy

DtInscricao Data Data Inscrição dd/MM/yyyy

DtInicioEstabelecimento Data Data Inicio Estabelecimento dd/MM/yyyy

DtUltimaAtualizacao Data Data Última Atualização dd/MM/yyyy

DsRespTecnico Texto Responsável Técnico

DsRespLegal Texto Responsável Legal

NrAutorizacaoAnvisa Texto Autorização Anvisa

DtAutorizacaoAnvisa Texto Data Autorização Anvisa dd/MM/yyyy

NrProcessoAnvisa Texto Número Processo Anvisa

TpAutorizacaoAnvisa Texto Tipo Autorização Anvisa

DsSituacaoAnvisa Texto Descrição Situação Anvisa

DsEmail Texto E-mail

DtVenctoAutAnvisa Data

Data Vencimento Autorização

Anvisa dd/MM/yyyy

MotivoSituacao Texto Motivo da Situacao

DmCredenciamentoAntecipado Texto Credenciamento Antecipado

CNAEOBRIGATORIEDADE Numérico

CNAE que obriga emissão de

NFe

DESCRICAOCNAE Texto Descrição CNAE

DTINICIOOBRIGATORIEDA

DE Data Data Inicio Obrigatoriedade dd/MM/yyyy

REFERENCIA Texto

Portaria que faz referência à

obrigatoriedade

Page 62: Manual de Integração Consulta Robotizada Web Service ...docs.simconsultas.com.br/manuais/manual-integracao-consulta... · 7 1. Introdução Este documento tem por objetivo a definição

62

OBS1 Texto Observações

OBS2 Texto Observações

Parser: QualificacaoESocial

(Qualificação on-line – e-Social)

Campo Tipo Descrição Valores / Formato

Nome Texto Nome completo

DataNascimento Texto Data de nascimento DD/MM/AAAA

SituaçãoCPF Texto Situação do CPF

NumeroNIS Texto Número NIS

SituaçãoCNIS Texto Situação do CNIS

CPF Texto CPF 00000000000

Mensagem Texto