N FS - e

Manual de Integrao

Aditivo Belo Horizonte

Verso 1.0 08/02/2011

Pgina 2 de 7

PREFEITURA DE BELO HORIZONTE

Reviso 1.00

SUMRIO
1 2 3 INTRODUO ..................................................................................................... 3 ARQUITETURA DE COMUNICAO COM O CONTRIBUINTE ....................... 4 2.1.1 CONSULTA DE NFS-E POR FAIXA ................................................................... 4 ESTRUTURA DE DADOS DO WEB SERVICE................................................... 5 3.1 MODELO OPERACIONAL ................................................................................... 5 3.2 TIPOS SIMPLES ............................................................................................... 5 3.3 SERVIOS ....................................................................................................... 6 3.3.1 CONSULTA DE NFS-E POR FAIXA ................................................................... 6

Pgina 3 de 7

PREFEITURA DE BELO HORIZONTE

Reviso 1.00

1 INTRODUO
O objetivo deste documento complementar o Manual de Integrao do Contribuinte WebService - verso 1.0, que continua vigente, com as informaes necessrias para a construo do servio Web Service da NFS-e Consulta de NFS-e por faixa. Por ser um aditivo, somente esto contidas neste documento as informaes que no se encontram na documentao publicada no portal do BHISS Digital (www.pbh.gov.br/bhissdigital).

Pgina 4 de 7

PREFEITURA DE BELO HORIZONTE

Reviso 1.00

2 ARQUITETURA DE COMUNICAO COM O CONTRIBUINTE

2.1.1 Consulta de NFS-e por faixa
Esse servio permite a obteno de determinada NFS-e j gerada.
Administrao Tributria Municipal Prestador ou Tomador Aplicao Cliente
2.b 2.a <XML> Identif. da NFS-e 2.c

?
Consulta

2.e <XML> NFS-e / Mensag.

Web Services

2.d Processamento NFS-e NFS-e / Msg

XML de Envio validado pelo elemento do schema do arquivo nfse.xsd: ConsultarNfseFaixaEnvio XML de Resposta validado pelo elemento do schema do arquivo nfse.xsd: ConsultarNfseFaixaResposta

Passos para execuo

1. A aplicao acessa o servio de Consulta de NFS-e por faixa e submete os dados para processamento. 2. A requisio recebida pelo servidor do Web Service, que verifica os dados preenchidos e identifica as NFS-e correspondentes. 3. O Web Service retorna uma mensagem com o resultado do processamento do servio.

Pgina 5 de 7

PREFEITURA DE BELO HORIZONTE

Reviso 1.00

3 ESTRUTURA DE DADOS DO WEB SERVICE

3.1 Modelo Operacional

Assim, o servio de Consulta de NFS-e sero implementados da seguinte forma: Servio Consulta de NFS-e por faixa Implementao Sncrona

3.2

Tipos Simples

A seguir encontra-se a tabela com a lista dos tipos simples que sero utilizados como tipos de dados. A tabela est dividida em 4 colunas, a saber: Campo: nome do tipo simples; Tipo: tipo primitivo de dados utilizados pelo campo: o C: Caractere; o N: Nmero; o D: Data ou Data/Hora; o T: Token Descrio: descreve informaes sobre o campo; Tam.: tamanho do campo: o Quando forem caracteres o tamanho define a quantidade mxima de caracteres que o texto poder ter; o Quando for numrico o tamanho pode ser representado das seguintes formas Nmero inteiro, que define o total de dgitos existente no nmero. Exemplo: 15 significa que o nmero poder ter, no mximo, 15 dgitos; Nmero fracionrio, que define o total de dgitos e quantos deles sero designados para a parte fracionria. Exemplo: 15,2 significa que o nmero poder ter, no mximo, 15 dgitos sendo 2 deles a da parte fracionria. A parte fracionria no obrigatria quando assim definido; o Quando for data, no haver definio de tamanho.
Tipo
N

Campo
tsPagina

Descrio
Nmero da pgina da consulta

Tam.
6

Pgina 6 de 7

PREFEITURA DE BELO HORIZONTE

Reviso 1.00

3.3

Servios

A seguir esto os servios direlaionados sponveis, conforme descritos no item Erro! Fonte de referncia no encontrada., no WebService e seus XML Schema. O XML Schema define a estrutura e formatao do arquivo XML que conter os dados a serem trafegados. Esses documentos sero enviados de forma textual (como uma string) como parmetros do servio oferecido pelo Web Service, como descrito em Erro! Fonte de referncia no encontrada.. As tabelas que detalham cada XML Schema esto divididas da seguinte forma:
(1)
# (2) Nome (3) Tipo (4) Pai (5) Ocorrncia (6) (8) Observao (7) (9)

Legenda da tabela: Elemento Nmero identificador do campo, quando este contiver subitens; Nome do campo; Nome do tipo do campo que pode ser do tipo primitivo, simples ou complexo; Indica qual o campo pai, para definio da hierarquia; Quantas vezes o campo se repete na estrutura de dados: a. Formato: z-y onde x a quantidade mnima e y a quantidade mxima. Se a quantidade mxima for indefinida, ser utilizado N no lugar do y; (7) Descreve alguma observao pertinente; (8) Formato de grupo, utilizado para definio de uma escolha (ver prximo item); (9) Identifica os campos ou grupos que faro parte de uma escolha (Choice). (1) (2) (3) (4) (5) (6)

3.3.1 Consulta de NFS-e por faixa

Esse servio ser executado pelo mtodo ConsultarNfseFaixa, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue.
ConsultarNfseFaixaEnvio
# 1 Nome ConsultarNfseFaixaEnvio Prestador 2 Faixa NumeroNfseInicial NumeroNfseFinal tsNumeroNfse tsNumeroNfse tcIdentificacaoPrestador 1 1 2 2 Tipo Pai Ocorrncia 1-1 1-1 0-1 1-1 1-1 Observao

Pgina 7 de 7

PREFEITURA DE BELO HORIZONTE

Reviso 1.00

Pagina

tsPagina

1-1

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.

ConsultarNfseFaixaResposta
# 1 2 Nome ConsultarNfseFaixaResposta ListaNfse CompNfse Pagina 3 ListaMensagemRetorno CompNfse tsPagina ListaMensagemRetorno 1 2 2 1 Tipo Pai Ocorrncia 1-1 1-1 1-50 1-1 1-1 Choice Observao