Web Service - NF3eRecepcao
O Serviço de Recepção de NF3e é oferecido pelos Portais das Secretarias da Fazenda dos Estados para a recepção das NF3e emitidas pelos contribuintes credenciados em sua unidade federada.
O processamento é síncrono e não utiliza lotes. O contribuinte transmite uma NF3e e recebe o resultado na mesma conexão. O MOC recomenda este serviço para a autorização on-line, quando a emissão e a geração da nota ocorrem no momento da leitura na localização do acessante (On Site Billing), com dispositivo móvel conectado à internet.
- Função: serviço destinado à recepção de mensagens de envio de NF3e.
- Processo: síncrono.
- Nome do Serviço:
NF3eRecepcaoSinc. - Método:
nf3eRecepcao. - Parâmetro da mensagem da área de dados: compactada utilizando GZip (Base64).
1. Leiaute da Mensagem de Entrada
Entrada: a estrutura XML da NF3e está definida no Anexo I - Leiaute e Regras de Validação.
Schema XML: NF3e_v9.99.xsd.
2. Leiaute da Mensagem de Retorno
Retorno: estrutura XML com a mensagem do resultado do envio da NF3e.
Schema XML: retNF3e_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| BR01 | retNF3e | 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 | cUF | E | BR01 | N | 1-1 | 2 | Código da UF que atendeu à solicitação. |
| BR05 | verAplic | E | BR01 | C | 1-1 | 1-20 | Versão do aplicativo que recebeu a NF3e. |
| BR06 | cStat | E | BR01 | N | 1-1 | 3 | Código do status da resposta. |
| BR07 | xMotivo | E | BR01 | C | 1-1 | 1-255 | Descrição literal do status da resposta. |
| BR08 | protNF3e | E | BR01 | G | 0-1 | XML | Resposta ao processamento da NF3e. |
3. Leiaute de NF3e Processada
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| PR01 | protNF3e | Raiz | - | - | - | - | TAG raiz da resposta de processamento. |
| PR02 | versao | A | PR01 | N | 1-1 | 2v2 | Versão do leiaute. |
| PR03 | infProt | G | PR01 | - | 1-1 | - | Informações do protocolo de resposta. |
| PR04 | Id | A | PR03 | C | 0-1 | - | Identificador da TAG a ser assinada. Somente precisa ser informado se a UF assinar a resposta. Nesse caso, preencher com o número do Protocolo precedido do literal “ID”. |
| PR05 | tpAmb | E | PR03 | N | 1-1 | 1 | Identificação do Ambiente: 1 - Produção; 2 - Homologação. |
| PR06 | verAplic | E | PR03 | C | 1-1 | 1-20 | Versão do aplicativo que recebeu a NF3e. |
| PR07 | chNF3e | E | PR03 | N | 1-1 | 44 | Chave de acesso da NF3e. |
| PR08 | dhRecbto | E | PR03 | D | 1-1 | - | Data e Hora do Processamento. Formato: AAAA-MM-DDTHH:MM:SS TZD. Preenchido com a data e hora da gravação da NF3e no Banco de Dados ou, em caso de rejeição, com a data e hora do recebimento do arquivo enviado. |
| PR09 | nProt | E | PR03 | N | 0-1 | 16 | Número do protocolo de autorização da NF3e. |
| PR10 | digVal | E | PR03 | C | 0-1 | 28 | Digest Value da NF3e processada, utilizado para conferir a integridade com a NF3e original. |
| PR11 | cStat | E | PR03 | N | 1-1 | 3 | Código do status da resposta para a NF3e. |
| PR12 | xMotivo | E | PR03 | C | 1-1 | 1-255 | Descrição literal do status da resposta para a NF3e. |
| PR13 | infFisco | G | PR01 | - | 0-1 | - | Grupo reservado para envio de mensagem do Fisco ao contribuinte. |
| PR14 | cMsg | E | PR13 | N | 1-1 | 3 | Código de status da mensagem do Fisco. |
| PR15 | xMsg | E | PR13 | C | 1-1 | 1-255 | Mensagem do Fisco para o contribuinte. |
| PR16 | Signature | G | PR01 | XML | 0-1 | - | Assinatura XML do grupo identificado pelo atributo “ID”. A decisão de assinar a mensagem fica a critério da UF. |
4. 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. |
5. Validação das Regras de Negócio da NF3e
As regras de negócio aplicadas à NF3e são as regras do Grupo G do Anexo I - Leiaute e Regras de Validação.
6. Final do Processamento da NF3e
A validação da NF3e pode resultar em:
- Rejeição: a NF3e é descartada e não é armazenada no Banco de Dados, podendo ser corrigida e novamente transmitida.
- Autorização de uso: a NF3e é armazenada no Banco de Dados.
| Validação de forma da NF3e | Situação da NF3e | Para o contribuinte | Banco de Dados |
|---|---|---|---|
| Inválida | Rejeição | Corrigir NF3e | Não gravar |
| Válida | Autorização de uso | Autorizada | Gravar |
Para cada NF3e é atribuído um número de protocolo do Ambiente Autorizador.