Web Service - NF3eRetRecepcao Desativado
Serviço desativado. A NT NF3e 2024.002 v.1.01 eliminou os serviços de Recepção de Lotes e Retorno Recepção em produção em 07/10/2024. O serviço passou a retornar cStat 998: Rejeição: Serviço de recepção de lotes desativado (NT2024.002). Migrar para recepção síncrona! O conteúdo abaixo é preservado como registro histórico; campos e regras extintos estão tachados.
Este serviço era utilizado pelo emitente para obter o resultado do processamento do lote de NF3e enviado ao serviço de recepção assíncrono.
- Função: serviço destinado a devolver o resultado do processamento do lote de NF3e.
- Processo: síncrono.
- Nome do Serviço:
NF3eRetRecepcao. - Método:
nf3eRetRecepcao. - Parâmetro da mensagem da área de dados: XML sem compactação.
1. Leiaute da Mensagem de Entrada
Entrada: estrutura XML contendo o número do recibo que identifica a mensagem de envio de lotes.
Schema XML: consReciNF3e_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| CP01 | consReciNF3e | Raiz | - | - | - | - | TAG raiz. |
| CP02 | versao | A | CP01 | N | 1-1 | 2v2 | Versão do leiaute. |
| CP03 | tpAmb | E | CP01 | N | 1-1 | 1 | Identificação do Ambiente: 1 - Produção; 2 - Homologação. |
| CP04 | nRec | E | CP01 | N | 1-1 | 16 | Número do Recibo gerado pelo Portal da Secretaria de Fazenda Estadual, composto por duas posições com o Código da UF (codificação do IBGE) onde o Lote foi entregue, uma posição para o Tipo de Autorizador, uma posição para o Site de Autorização e doze posições numéricas sequenciais. |
2. Leiaute da Mensagem de Retorno
Retorno: estrutura XML com o resultado do processamento do lote de NF3e.
Schema XML: retConsReciNF3e_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| CR01 | retConsReciNF3e | Raiz | - | - | - | - | TAG raiz da resposta. |
| CR02 | versao | A | CR01 | N | 1-1 | 2v2 | Versão do leiaute. |
| CR03 | tpAmb | E | CR01 | N | 1-1 | 1 | Identificação do Ambiente: 1 - Produção; 2 - Homologação. |
| CR04 | verAplic | E | CR01 | C | 1-1 | 1-20 | Versão do aplicativo que recebeu o lote. |
| CR05 | nRec | E | CR01 | N | 1-1 | 16 | Número do Recibo consultado. |
| CR06 | cStat | E | CR01 | N | 1-1 | 3 | Código do status da resposta. |
| CR07 | xMotivo | E | CR01 | C | 1-1 | 1-255 | Descrição literal do status da resposta. |
| CR08 | protNF3e | G | CR01 | XML | 0-50 | - | Resultado de processamento da NF3e. |
3. Descrição do Processo de Web Service
O método oferecia a consulta ao resultado do processamento do lote de NF3e.
O aplicativo do contribuinte deveria aguardar pelo menos 15 segundos entre o envio do lote para processamento e a consulta do resultado, evitando a obtenção desnecessária do status 105 - “Arquivo em Processamento”.
4. Regras de Validação Básicas do Serviço
| Grupo | Descrição |
|---|---|
| A | Validação do Certificado de Transmissão (protocolo TLS). |
| B | Validação Inicial da Mensagem no Web Service. |
| C | Validação da Área de Dados da mensagem. |
5. Validação das Regras de Negócio do Retorno Recepção
| # | Regra de Validação | Aplic. | cStat | Efeito | Mensagem |
|---|---|---|---|---|---|
| H01 | Tipo do ambiente informado difere do ambiente do Web Service. | Obrig. | 252 | Rej. | Rejeição: Ambiente informado diverge do Ambiente de recebimento. |
| H02 | UF do recibo difere da UF do Web Service. | Obrig. | 248 | Rej. | Rejeição: UF do Recibo difere da UF autorizadora. |
| H03 | Tipo de Autorizador do recibo não compatível com o órgão autorizador: 1 - SEFAZ Autorizadora; 3 - SEFAZ Virtual RS. | Obrig | 473 | Rej. | Rejeição: Tipo Autorizador do Recibo diverge do Órgão Autorizador. |
| H04 | Identificador do Site de recepção do recibo não compatível com o Site que atendeu à requisição. Observação: aplicável apenas a ambientes com múltiplos sites; o padrão para autorizador com um site é zero. | Obrig. | 483 | Rej. | Rejeição: Site de recepção incompatível com o informado no recibo do Lote. |
| H05 | Verificar se o lote existe, identificado pelo recibo. | Obrig. | 106 | Rej. | Lote não localizado. |
| H06 | Verificar se o lote já foi processado. | Obrig. | 105 | Rej. | Lote em processamento. |
| H07 | CNPJ do transmissor do lote difere do CNPJ do transmissor da consulta. | Obrig. | 223 | Rej. | Rejeição: CNPJ do transmissor do arquivo difere do CNPJ do transmissor da consulta. |
6. Final do Processamento
A mensagem de retorno poderia ser:
- Lote processado - cStat 104: com o resultado do processamento da NF3e.
- Lote em processamento - cStat 105: o contribuinte deveria fazer nova consulta.
- Lote não localizado - cStat 106: o contribuinte deveria providenciar o reenvio da mensagem.
- Recibo ou CNPJ do requisitante com problemas - cStat 248 ou 223: o contribuinte deveria sanar o problema.