Web Service - NFComRecepcao
O Serviço de Recepção de NFCom é oferecido pelos Portais das Secretarias da Fazenda dos Estados para recepção das NFCom emitidas pelos contribuintes credenciados em sua unidade federada.
A forma de processamento é síncrona, sem a formação de lotes. O contribuinte transmite uma NFCom e recebe o resultado do processamento na mesma conexão.
- Função: serviço destinado à recepção de mensagens de envio de NFCom;
- Processo: síncrono;
- Nome do serviço:
NFComRecepcao; - Método:
nfcomRecepcao; - Parâmetro da mensagem da área de dados: compactada utilizando GZip (Base64).
1. Leiaute da Mensagem de Entrada
Entrada: a estrutura XML da Nota Fiscal Fatura de Serviço de Comunicação Eletrônica está definida no Anexo I: Manual de Orientações do Contribuinte - Leiaute e Regras de Validação.
Schema XML: NFCom_v9.99.xsd.
2. Leiaute da Mensagem de Retorno
Retorno: estrutura XML com a mensagem do resultado do envio da NFCom.
Schema XML: retNFCom_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| BR01 | retNFCom | 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 NFCom. |
| BR06 | cStat | E | BR01 | N | 1-1 | 3-4 | Código do status da resposta. |
| BR07 | xMotivo | E | BR01 | C | 1-1 | 1-255 | Descrição literal do status da resposta. |
| BR08 | protNFCom | E | BR01 | G | 0-1 | XML | Resposta ao processamento da NFCom. |
3. Leiaute de NFCom Processada
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| PR01 | protNFCom | Raiz | - | - | - | - | TAG raiz da resposta do 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. Em caso de assinatura da resposta pela SEFAZ, preencher o campo 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 NFCom. |
| PR07 | chNFCom | E | PR03 | C | 1-1 | 44 | Chave de acesso da NFCom. |
| PR08 | dhRecbto | E | PR03 | D | 1-1 | - | Data e hora do processamento. Formato: AAAA-MM-DDTHH:MM:SS TZD. Preenchido com a data e a hora da gravação da NFCom no banco de dados. Em caso de rejeição, com a data e a hora do recebimento do arquivo de NFCom enviado. |
| PR09 | nProt | E | PR03 | N | 0-1 | 16 | Número do protocolo de autorização da NFCom. |
| PR10 | digVal | E | PR03 | C | 0-1 | 28 | Digest Value da NFCom processada, utilizado para conferir a integridade com a NFCom original. |
| PR11 | cStat | E | PR03 | N | 1-1 | 3-4 | Código do status da resposta para a NFCom. |
| PR12 | xMotivo | E | PR03 | C | 1-1 | 1-255 | Descrição literal do status da resposta para a NFCom. |
| 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 interessada. |
4. Regras de Validação Básicas do Serviço
Deverão ser aplicadas as validações gerais conforme o quadro abaixo:
| 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 NFCom
As regras de negócio aplicadas à NFCom estão descritas no Grupo G do Anexo I: Manual de Orientações do Contribuinte - Leiaute e Regras de Validação.
6. Final do Processamento da NFCom
A validação da NFCom poderá resultar em:
- Rejeição: a NFCom será descartada, não será armazenada no banco de dados e poderá ser corrigida e novamente transmitida;
- Autorização de uso: a NFCom será armazenada no banco de dados.
| Validação da NFCom | Situação da NFCom | Para o contribuinte | Banco de Dados |
|---|---|---|---|
| Inválida | Rejeição | Corrigir NFCom | Não gravar |
| Válida | Autorização de uso | Autorizada | Gravar |
Para cada NFCom será atribuído um número de protocolo do Ambiente Autorizador.