Web Service - NF3eRecepcaoLote Desativado
O Serviço de Recepção Lotes de NF3e era oferecido pelos Portais das Secretarias da Fazenda dos Estados para a recepção das NF3e emitidas pelos contribuintes credenciados, permitindo submeter conjuntos de notas em uma mesma conexão.
A forma de processamento era assíncrona: o contribuinte transmitia o lote pelo Web Service de recepção e buscava o resultado no Web Service de consulta ao processamento do lote. O MOC o recomendava para emissões realizadas dentro da empresa emitente, seguindo o ciclo de faturamento, quando não fosse adotada a emissão na localização do acessante (On Site Billing).
- Função: serviço destinado à recepção de mensagens de envio de lotes de NF3e.
- Processo: assíncrono.
- Nome do Serviço:
NF3eRecepcao. - Método:
nf3eRecepcaoLote. - Parâmetro da mensagem da área de dados: compactada utilizando GZip (Base64).
1. Leiaute da Mensagem de Entrada
Entrada: estrutura XML com o lote de NF3e.
Schema XML: enviNF3e_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| AP01 | enviNF3e | Raiz | - | - | - | - | TAG raiz. |
| AP02 | versao | A | AP01 | N | 1-1 | 2v2 | Versão do leiaute. |
| AP03 | idLote | E | AP01 | N | 1-1 | 1-15 | Identificador de controle do Lote de envio da NF3e. Número sequencial autoincremental único para identificação do Lote. A responsabilidade de gerar e controlar é exclusiva do emitente. O Web Service não faz qualquer uso deste identificador. |
| AP04 | NF3e | G | AP01 | XML | 1-50 | - | Conjunto de NF3e transmitidos, com o máximo de 50 NF3e, seguindo a definição do Anexo I - Leiaute e Regras de Validação da NF3e. O tamanho máximo de 1 MB também pode limitar a quantidade máxima de NF3e. |
2. Leiaute da Mensagem de Retorno
Retorno: estrutura XML com a mensagem do resultado do envio da transmissão do lote.
Schema XML: retEnviNF3e_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| AR01 | retEnviNF3e | Raiz | - | - | - | - | TAG raiz da resposta. |
| AR02 | versao | A | AR01 | N | 1-1 | 2v2 | Versão do leiaute. |
| AR03 | tpAmb | E | AR01 | N | 1-1 | 1 | Identificação do Ambiente: 1 - Produção; 2 - Homologação. |
| AR04 | cUF | E | AR01 | N | 1-1 | 2 | Código da UF que atendeu à solicitação. |
| AR05 | verAplic | E | AR01 | C | 1-1 | 1-20 | Versão do aplicativo que recebeu o Lote. |
| AR06 | cStat | E | AR01 | N | 1-1 | 3 | Código do status da resposta. |
| AR07 | xMotivo | E | AR01 | C | 1-1 | 1-255 | Descrição literal do status da resposta. |
| AR08 | infRec | G | AR01 | - | 0-1 | - | Dados do Recibo do Lote, gerados somente se o Lote fosse aceito. |
| AR09 | nRec | E | AR08 | 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. |
| AR10 | dhRecbto | E | AR08 | D | 1-1 | - | Data e Hora do Recebimento. Formato: AAAA-MM-DDTHH:MM:SS TZD. Preenchido com a data e hora do recebimento do lote. |
| AR11 | tMed | E | AR08 | N | 1-1 | N | Tempo médio de resposta do serviço, em segundos, nos últimos 5 minutos. Se o tempo médio ficasse abaixo de 1 segundo, seria informado como 1 segundo. As frações de segundo seriam arredondadas para cima. |
As mensagens recebidas com erro geravam uma mensagem de erro. Nas demais hipóteses, o serviço retornava um recibo com número, data, hora local de recebimento e tempo médio de resposta dos últimos 5 minutos. O número do recibo era a chave de acesso do serviço de consulta ao resultado do processamento do lote.
3. Processo de Recepção de Lotes de NF3e
O método era responsável por receber as mensagens de envio de lotes de NF3e e colocá-las na fila de entrada. Cada lote admitia até 50 NF3e e deveria reunir documentos do mesmo estabelecimento, considerando o mesmo CNPJ e a mesma IE do emitente.
O tamanho máximo do lote era de 1024 KB. O contribuinte deveria compor o lote sem ultrapassar esse limite, ainda que a quantidade de documentos fosse inferior a 50.
3.1. Regras de Validação Básicas do Serviço
| Grupo | Descrição |
|---|---|
| A | Validação do Certificado de Transmissão (protocolo TLS). |
| B-0 | Validação da Compactação da Mensagem. |
| B | Validação Inicial da Mensagem no Web Service. |
| C | Validação da Área de Dados da mensagem. |
3.2. Validação Específica do Serviço de Recepção de Lotes
| # | Regra de Validação | Aplic. | cStat | Efeito | Mensagem |
|---|---|---|---|---|---|
| F01 | Verificar se o lote contém NF3e de mais de um estabelecimento emissor, considerando o CNPJ e a IE do emitente de cada NF3e. | Obrig. | 403 | Rej. | Rejeição: O lote contém NF3e de mais de um estabelecimento emissor. |
| F02 | Verificar se o lote contém apenas uma NF3e. | Obrig. | 401 | Rej. | Rejeição: O lote deve conter mais de uma NF3e. |
Qualquer erro na validação de forma da área de dados implicava a rejeição de todo o lote.
3.3. Geração da Resposta com o Recibo
Não existindo problema nas validações, o aplicativo gerava um número de recibo e gravava a mensagem juntamente com o CNPJ do transmissor, a versão da mensagem e o código da UF de origem. Após a gravação na fila de entrada, a resposta de confirmação informava:
- identificação do ambiente;
- versão do aplicativo;
- código 103 e o literal “Lote recebido com Sucesso”;
- código da UF que atendeu à solicitação;
- número do recibo, com data, hora e local de recebimento da mensagem;
- tempo médio de resposta do processamento nos últimos 5 minutos.
Se houvesse problema de validação, a resposta informava a identificação do ambiente, a versão do aplicativo, o código e a mensagem de erro e o código da UF que atendeu à solicitação.
4. Descrição do Processamento do Lote de NF3e
O Servidor de Processamento de NF3e consumia as mensagens armazenadas na fila de entrada pelo método nf3eRecepcaoLote, validava a forma e as regras de negócio e armazenava o resultado na fila de saída.
4.1. Validação das Regras de Negócio da NF3e
As regras de negócio aplicadas à NF3e eram as regras do Grupo G do Anexo I - Leiaute e Regras de Validação.
4.2. Resultado do Processamento do Lote de NF3e
O resultado permanecia disponível na fila de saída e continha o resultado da validação de cada NF3e do lote. O MOC determinava disponibilidade mínima de 24 horas.