Web Service - BPeConsulta
cStat aplicável aos Schemas de retorno.- Função: atendimento de solicitações de consulta da situação atual do BP-e na base de dados do Ambiente Autorizador.
- Processo: síncrono.
- Método:
bpeConsultaBP. - Parâmetro da mensagem da área de dados: XML sem compactação.
1. Leiaute da Mensagem de Entrada
Entrada: estrutura XML contendo a Chave de Acesso do BP-e.
Schema XML: consSitBPe_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| BP01 | consSitBPe | Raiz | - | - | - | - | TAG raiz. |
| BP02 | versao | A | BP01 | N | 1-1 | 2v2 | Versão do leiaute. |
| BP03 | tpAmb | E | BP01 | N | 1-1 | 1 | Identificação do ambiente: 1 - Produção; 2 - Homologação. |
| BP04 | xServ | E | BP01 | C | 1-1 | 9 | Serviço solicitado: “CONSULTAR”. |
| BP05 | chBPe | E | BP01 | N | 1-1 | 44 | Chave de acesso do BP-e. |
2. Leiaute da Mensagem de Retorno
Retorno: estrutura XML com o resultado da consulta da situação.
Schema XML: retConsSitBPe_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| BR01 | retConsSitBPe | Raiz | - | - | - | - | TAG raiz da resposta. |
| BR02 | versao | A | BR01 | N | 1-1 | 2v2 | Versão do leiaute. |
| BR03 | tpAmb | E | BR01 | N | 1-1 | 1 | Identificação do ambiente: 1 - Produção; 2 - Homologação. |
| BR04 | verAplic | E | BR01 | C | 1-1 | 1-20 | Versão do aplicativo que processou a consulta. |
| BR05 | cStat | E | BR01 | N | 1-1 | 3-4 | Código do status da resposta. |
| BR06 | xMotivo | E | BR01 | C | 1-1 | 1-255 | Descrição literal do status da resposta. |
| BR07 | cUF | E | BR01 | N | 1-1 | 2 | Código da UF que atendeu à solicitação. |
| BR08 | protBPe | G | BR01 | XML | 0-1 | - | Protocolo de autorização de uso do BP-e. |
| BR09 | procEventoBPe | G | BR01 | XML | 0-N | - | Informações dos eventos e respectivos protocolos de registro. |
3. Descrição do Processo de Web Service
O aplicativo do contribuinte envia a solicitação ao Web Service do Ambiente Autorizador. A aplicação processa a consulta e retorna a situação atual do BP-e, o respectivo protocolo de autorização de uso e os eventos associados.
Aplicativos mantidos em consulta permanente devem aguardar no mínimo 3 minutos entre uma consulta e outra, evitando sobrecarga desnecessária dos servidores do Ambiente Autorizador.
4. Regras de Validação Básicas do Serviço
| Grupo | Descrição |
|---|---|
| A | Validação do Certificado Digital do Transmissor no protocolo TLS. |
| B | Validação inicial da mensagem no Web Service. |
| C | Validação da área de dados da mensagem. |
O XML está sujeito ao limite de 1024 Kbytes, à validação de formação, disponibilidade do serviço, Schema, namespace, caracteres de edição, prefixos e codificação UTF-8.
5. Validação das Regras de Negócio da Consulta Situação
| # | Regra de Validação | Aplic. | cStat | Efeito | Mensagem |
|---|---|---|---|---|---|
| G01 | Tipo do ambiente informado difere do ambiente do Web Service. | Obrig. | 252 | Rej. | Rejeição: Ambiente informado diverge do Ambiente de recebimento. |
| G02 | UF da Chave de Acesso difere da UF do Web Service. | Obrig. | 226 | Rej. | Rejeição: Código da UF do Emitente diverge da UF autorizadora. |
| G03 | Verificar se o ano-mês da Chave de Acesso está com atraso superior a 6 meses em relação ao ano-mês atual. | Obrig. | 413 | Rej. | Rejeição: Consulta a uma Chave de Acesso muito antiga. |
| G04 | Validar a Chave de Acesso. Retornar o motivo quando houver CNPJ zerado ou inválido, ano inferior a 2017 ou superior ao atual, mês inválido, modelo diferente de 63, número zerado, tipo de emissão inválido, Site de Autorização inválido, UF inválida ou DV inválido. | Obrig. | 236 | Rej. | Rejeição: Chave de Acesso inválida. [Motivo: XXXXXXXXX] |
| G05 | Acessar a base de dados pela chave CNPJ do emitente, modelo, série e número; verificar se o BP-e não existe. | Obrig. | 217 | Rej. | Rejeição: BP-e não consta na base de dados da SEFAZ. |
| G06 | Verificar se o campo “Código Numérico” informado na Chave de Acesso é diferente do existente na base de dados. | Obrig. | 216 | Rej. | Rejeição: Chave de Acesso difere da cadastrada. |
| G07 | Chave de Acesso difere da existente na base de dados. Opcionalmente, o campo xMotivo pode apresentar a Chave de Acesso quando o autor da consulta for o emissor. | Obrig. | 600 | Rej. | Rejeição: Chave de Acesso difere da existente em BD. |
6. Final do Processamento
O pedido pode resultar em mensagem de erro quando o BP-e não for localizado. Quando localizado, o serviço retorna a situação atual, o protocolo de autorização de uso e os registros de eventos.
| cStat | Situação |
|---|---|
| 100 | Autorizado o Uso do BP-e. |
| 101 | Cancelamento de BP-e homologado. |
| 102 | Substituição do BP-e homologada. |
| 150 | Autorizado o Uso do BP-e, autorização fora de prazo. |