Web Service - NFAgRecepcao
O Serviço de Recepção de NFAg é o serviço oferecido pelo Ambiente Autorizador para recepção das NFAg emitidas pelos contribuintes credenciados para emissão da NFAg.
A forma de processamento é síncrona, sem a formação de lotes. O contribuinte transmite uma NFAg e recebe o resultado do processamento na mesma conexão.
Função: serviço destinado à recepção de mensagens de envio de NFAg.
Processo: síncrono.
Nome Serviço: NFAgRecepcao.
Método: NFAgRecepcao.
Parâmetro da Mensagem da área de dados: compactada utilizando GZip (Base64).
1. Leiaute da Mensagem de Entrada
Entrada: Estrutura XML da Nota Fiscal de Água e Saneamento Eletrônica definida no Anexo I: Manual de Orientações do Contribuinte – Leiaute e Regras de Validação.
Schema XML: NFAg_v9.99.xsd.
2. Leiaute da Mensagem de Retorno
Retorno: Estrutura XML com a mensagem do resultado do envio da NFAg.
Schema XML: retNFAg_v9.99.xsd.
| # | Campo | Ele | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| BR01 | retNFAg | 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 NFAg. |
| 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 | protNFAg | E | BR01 | G | 0-1 | XML | Resposta ao processamento da NFAg |
3. Leiaute de NFAg Processada
| # | Campo | Ele | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| PR01 | protNFAg | Raiz | - | - | - | - | TAG raiz da resposta 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, preencher o campo com o Nro do Protocolo, precedido com o 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 NFAg. |
| PR07 | chNFAg | E | PR03 | N | 1-1 | 44 | Chave de acesso da NFAg |
| PR08 | dhRecbto | E | PR03 | D | 1-1 | - | Data e Hora do Processamento Formato = AAAA-MM-DDTHH:MM:SS TZD Preenchido com data e hora da gravação da NFAg no Banco de Dados. Em caso de Rejeição, com data e hora do recebimento do Arquivo de NFAg enviado. |
| PR09 | nProt | E | PR03 | N | 0-1 | 16 | Número do protocolo de autorização da NFAg |
| PR10 | digVal | E | PR03 | C | 0-1 | 28 | Digest Value da NFAg processada, utilizada para conferir a integridade com a NFAg original |
| PR11 | cStat | E | PR03 | N | 1-1 | 3 | Código do status da resposta para a NFAg |
| PR12 | xMotivo | E | PR03 | C | 1-1 | 1-255 | Descrição literal do status da resposta para a NFAg |
| PR13 | infFisco | G | PR01 | - | 0-1 | - | Grupo reservado para envio de mensagem do Fisco para o 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
Deverão ser aplicadas as validações gerais relacionadas 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 |
4.1. Validação das Regras de Negócio da NFAg
As regras de negócio aplicáveis à NFAg estão descritas no Grupo G do Anexo I: Manual de Orientações do Contribuinte – Leiaute e Regras de Validação.
5. Final do Processamento da NFAg
A validação da NFAg poderá resultar em:
- Rejeição: a NFAg será descartada, não sendo armazenada no Banco de Dados, podendo ser corrigida e novamente transmitida;
- Autorização de uso: a NFAg será armazenada no Banco de Dados.
| Validação da NFAg | Consequência | ||
|---|---|---|---|
| De forma da NFAg | Situação da NFAg | Para o contribuinte | Banco de Dados |
| Inválida | Rejeição | Corrigir NFAg | Não gravar |
| Válida | Autorização de uso | Autorizada | Gravar |
Para cada NFAg será atribuído um número de protocolo do Ambiente Autorizador.