WSConsultarCadastro - Consultar cadastro de informações do contribuinte
O web service WSConsultarCadastro realiza consultas de forma síncronas. A consulta será realizada na SEFAZ, baseado no CNPJ, CPF ou Inscrição Estadual, caso encontre as informações estas serão retornadas repassado na consulta.
Para realizar as consultas, este web service utiliza algumas configurações do Job como o certificado. Sendo assim, é necessário informar, na tag <identificador>, o JobKey de NF-e.
O retorno dos documentos ocorrerá no formato TXT.
<XML retorno> ConsultarCadastro(<XML consulta>)
|
O parâmetro <XML consulta> irá conter os dados que irão filtrar os dados dos contribuintes na SEFAZ, conforme abaixo:
Para efetuar o download do schema xsd clique aqui!
<eformsConsultarCadastro xmlns="http://www.nddigital.com.br/connector" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<versao></versao>
<identificador></identificador>
<consCad></consCad>
</eformsConsultarCadastro>
|
Detalhamento do Schema ConsultarCadastro
|
eformsConsultarCadastro
|
#
|
Pai
|
Campo
|
Descrição
|
Tipo
|
Obrigatório
|
Ocorrências
|
Tamanho
|
Observações
|
1
|
|
Versão
|
Versão do schema.
|
C
|
S
|
1
|
4
|
Versão do schema.
|
2
|
|
identificador
|
JobKey (Chave do Job) que será utilizado para capturar as configurações.
|
C
|
S
|
1
|
1..60
|
|
3
|
|
consCad
|
Parâmetro de pesquisa do arquivo TXT.
|
C
|
S
|
1
|
|
Apresentação das informações no quadro abaixo.
|
 Legenda do schema Web Services
Legenda
|
Item pai
|
Número do item que agrupa este elemento.
|
|
Campo
|
Nome do campo conforme está no schema.
|
|
Descrição
|
Descrição rápida dos campos.
|
|
Tipo
|
Tipo de dado no campo.
|
N = Numérico
C = Alfanumérico
D = Data no formato AAAA-MM-DD HH:MM:SS
G = Grupo que conterá outros elementos filhos
|
Obrigatório
|
Indica se o campo é obrigatório ou não
|
S = Obrigatório
N = Não é obrigatório
|
Ocorrência
|
Indica a quantidade de ocorrências possíveis de determinado elemento
|
1 = Apenas 1 vez
1..N = Pode ser de 1 a vários elementos
0..N = Pode ser de nenhum a vários elementos
|
Tamanho
|
Indica o tamanho aceitável do campo
|
1 = Apenas 1 caractere ou número
1..N = Entre 1 caractere ou número ou vários até o valor final definido
|
Observação
|
Observações adicionais sobre o campo
|
|
Para poder realizar a consulta é necessário inserir os dados no padrão a seguir:
0000;CONSCAD;2.00
1000;SC;000000000;11111111111111;
Dados para realização da consulta
|
0000
|
OBR.
|
Versão do arquivo e tipo de operação
|
0000;CONSCAD;2.00
|
#
|
Campo
|
Descrição
|
Tipo
|
Ob.
|
Tam.
|
Dec.
|
Observação
|
1
|
CONSCAD
|
Descrição do serviço solicitado
|
C
|
S
|
1 a 7
|
|
|
2
|
versao
|
Tag de grupo das informações da NF-e
|
C
|
S
|
4
|
|
Indicação da versão do schema de NF-e (2.00 ou 3.10)
|
1000
|
OBR.
|
Dados do cadastro que se deseja consultar
|
1000;UF;IE;CNPJ;CPF
|
#
|
Campo
|
Descrição
|
Tipo
|
Ob.
|
Tam.
|
Dec.
|
Observação
|
3
|
UF
|
Estado onde será realizado a consulta
|
C
|
S
|
2
|
|
|
4
|
IE
|
IE
|
C
|
S
|
2 a 14
|
|
Caso não ocorra o preenchimento, será executado a consulta com o CNPJ informado
|
5
|
CNPJ
|
CNPJ
|
C
|
S
|
14
|
|
Informar o CNPJ ou CPF. É usado apenas um campo para as duas informações, mas apenas uma delas será informada. Caso não ocorra o preenchimento, será executado a consulta com a IE informada
|
6
|
CPF
|
CPF
|
C
|
N
|
11
|
|
|
|
Visualizar modelo do retorno da chamada