CSC NFCe: Gerenciamento Web Service 2014/001 e Regras SEFAZ
Administre o CSC da NFCe via Web Service (NT-NFCe 2014/001). Aborda regras de uso, limites de CSC ativos e automação do QR-Code no DANFE NFCe.
CSC NFCe: Gerenciamento Web Service 2014/001 e Regras SEFAZ
A Nota Fiscal de Consumidor Eletrônica (NFCe) exige o Código de Segurança do Contribuinte (CSC) para a correta geração do QR-Code no Documento Auxiliar da Nota Fiscal de Consumidor Eletrônica (DANFE NFCe). Este manual técnico, a NT-NFCe 2014/001 Web Service de Gerenciamento do CSC, define as especificações e critérios técnicos para que empresas emissoras possam gerenciar seus números de CSC via Web Service. Este serviço oferece uma alternativa à gestão do CSC por meio de página web.
Introdução ao gerenciamento de CSC NFCe
O Web Service de gerenciamento do CSC NFCe foi criado para permitir que empresas emissoras de NFCe administrem seus códigos de segurança eletronicamente. O Código de Segurança do Contribuinte (CSC) e seu número de identificação são informações fundamentais. Sem eles, a geração do QR-Code no DANFE NFCe, que permite a consulta da nota, não é possível.
Este serviço automatiza processos que antes poderiam depender de interfaces web, simplificando a rotina fiscal das empresas. O manual técnico fornece as diretrizes para a implementação e utilização do Web Service, garantindo a padronização das operações.
Modelo operacional do Web Service
A operação do Web Service de manutenção do CSC NFCe exige que a empresa emissora gere um arquivo eletrônico em formato XML. Este arquivo deve seguir um leiaute específico, conforme definido no manual técnico. O serviço oferece três funcionalidades distintas para o gerenciamento dos códigos de segurança.
As funcionalidades são: consulta de códigos de segurança ativos, revogação de um código de segurança ativo e requisição de um novo código de segurança. O arquivo XML gerado pelo contribuinte é transmitido via Internet para o ambiente autorizador. Este ambiente realiza uma pré-validação do arquivo e retorna uma mensagem eletrônica com o resultado da operação.
Limites de CSC ativos
Cada contribuinte, identificado pelo CNPJ Raiz, pode manter até dois CSCs ativos de forma simultânea. O Web Service é responsável por fazer este controle. Caso o contribuinte já possua dois CSCs ativos, uma nova requisição de código de segurança só será aceita após a revogação de um dos códigos existentes.
A funcionalidade de consulta de CSCs ativos não possui restrições. Pode ser utilizada a qualquer momento, sem que o número máximo de códigos seja um impeditivo para sua execução. O modelo de comunicação para essas funcionalidades é síncrono. Isso significa que o retorno do serviço solicitado é dado ao contribuinte na mesma conexão usada para realizar a solicitação.
Estrutura técnica do Web Service
O Web Service de gerenciamento do CSC NFCe disponibiliza serviços que são utilizados pelos aplicativos dos emissores de NFCe. A arquitetura de utilização deste Web Service segue premissas específicas para garantir a segurança e a integridade das operações. A URL de cada ambiente autorizador de NFCe é publicada no portal nacional da Nota Fiscal Eletrônica.
Nesta URL, o contribuinte pode obter o WSDL (Web Service Description Language) do serviço. O processo de utilização é sempre iniciado pelo emissor da NFCe. A comunicação ocorre com o envio de uma mensagem nos padrões XML e SOAP (versão 1.2), utilizando o protocolo SSL com autenticação mútua.
Padrões de comunicação
O Web Service disponibiliza um único método para atender a todas as operações de gerenciamento de CSC. O envio da solicitação e a obtenção do retorno são realizados na mesma conexão. Este padrão de comunicação síncrona é implementado para garantir a resposta imediata às requisições dos contribuintes.
A utilização do SSL com autenticação mútua é um requisito de segurança. Ele assegura que tanto o cliente (emissor da NFCe) quanto o servidor (ambiente autorizador) verifiquem a identidade um do outro. Qualquer erro na validação dos dados recebidos interrompe o processo. Em caso de falha, é disponibilizada uma mensagem contendo o código e a descrição do erro.
Serviço de manutenção do CSC NFCe: método admCscNFCe
O serviço de manutenção do CSC NFCe é o recurso oferecido pelo Web Service da SEFAZ autorizadora. Sua finalidade é atualizar o repositório de Códigos de Segurança do Contribuinte da NFCe. A escolha da funcionalidade desejada é feita por meio da especificação do tipo de operação no XML de requisição.
O método admCscNFCe é destinado às opções de consulta, requisição e revogação dos números de CSC NFCe. Este processo é síncrono, ou seja, a resposta é imediata à solicitação.
Mensagem de entrada
A mensagem de entrada para o método admCscNFCe é uma estrutura XML que contém os dados para a administração do CSC NFCe. O leiaute desta mensagem é definido pelo schema XML admCscNFCe_v1.00.xsd.
Os principais campos da mensagem de entrada incluem:
- versao: Versão do leiaute.
- tpAmb: Identificação do tipo de ambiente (1 para Produção, 2 para Homologação).
- indOp: Identificador do tipo de operação (1 para Consulta CSC Ativos, 2 para Solicita novo CSC, 3 para Revoga CSC Ativo).
- raizCNPJ: Raiz do CNPJ do contribuinte que está realizando a operação.
- dadosCsc: Grupo de dados do CSC a ser revogado (ocorre apenas na operação de revogação).
- idCsc: Número identificador do CSC a ser revogado.
- codigoCsc: Código alfanumérico do CSC a ser revogado.
Esses campos permitem que o Web Service identifique o contribuinte, o ambiente e a operação desejada, além de fornecer os dados necessários para revogação, quando aplicável.
Mensagem de retorno
A mensagem de retorno do método admCscNFCe também é uma estrutura XML. Ela apresenta o resultado da solicitação de administração do CSC NFCe, seguindo o leiaute definido pelo schema XML retAdmCscNFCe_v1.00.xsd.
Os elementos presentes na mensagem de retorno são:
- versao: Versão do leiaute de retorno.
- tpAmb: Identificação do tipo de ambiente (Produção ou Homologação).
- indOp: Identificador do tipo de operação realizada (Consulta, Requisição ou Revogação).
- cStat: Código do resultado do processamento da solicitação.
- xMotivo: Descrição literal do resultado do processamento da solicitação.
- dadosCsc: Grupo de dados para retorno de até dois CSCs. Este grupo pode conter:
- idCsc: Número sequencial do CSC na base de dados do órgão autorizador.
- codigoCsc: Código alfanumérico do CSC.
A combinação do cStat e xMotivo informa o status da operação, indicando se foi bem-sucedida ou se houve alguma rejeição. No caso de consulta ou requisição bem-sucedidas, os dados do CSC são retornados no grupo dadosCsc.
Regras de validação e códigos de retorno
O Web Service de gerenciamento do CSC NFCe aplica uma série de regras de validação para garantir a conformidade das solicitações. Estas regras se dividem em validações gerais e validações específicas para cada tipo de operação (consulta, requisição ou revogação). O não cumprimento de qualquer uma dessas regras resulta na rejeição da solicitação.
Validações comuns
Existem diversas regras de validação que são comuns a todos os tipos de serviço de manutenção do CSC NFCe. As principais incluem:
- Validação do schema XML (código 215): Verifica se a estrutura do XML está correta.
- Versão do arquivo XML não suportada (código 239): Rejeita solicitações com versões de leiaute desatualizadas.
- Validação do cabeçalho (código 242): Checa a integridade do cabeçalho da mensagem.
- Ambiente informado diverge do ambiente de recebimento (código 252): Garante que a operação ocorre no ambiente correto (produção ou homologação).
- Validação de certificado transmissor: Inclui verificações sobre validade (281), CNPJ (282), cadeia de certificação (283), revogação (284), diferença do ICP-Brasil (285) e erro no acesso à Lista de Certificados Revogados (LCR) (286). O certificado deve ser válido (280).
- Codificação XML (código 402): Exige que o XML da área de dados esteja codificado em UTF-8.
- Prefixo de namespace não permitido (código 404): Rejeita o uso de prefixos não autorizados.
- Campos
cUFeversaoDadosno SOAP Header (códigos 409, 410, 411): Valida a existência e a correção desses campos. - Solicitante não autorizado (código 695): Verifica a permissão do contribuinte para realizar a consulta.
A rejeição por falha nessas validações interrompe o processamento da solicitação, e o motivo é informado no cStat da mensagem de retorno.
Validações específicas por operação
Além das regras comuns, cada tipo de operação possui validações adicionais:
- Requisição de novo CSC: Se o contribuinte já possui o número máximo de dois CSCs ativos, a solicitação de um novo código será rejeitada (código 802).
- Revogação de CSC ativo:
- Rejeição se o CSC e o identificador informado não possuem correspondência (código 803).
- Rejeição se o CSC informado não pertence ao solicitante da revogação (código 804).
- Rejeição se o CSC informado já está revogado (código 805).
Essas regras asseguram que as operações de requisição e revogação respeitem as condições de uso e posse dos CSCs.
Códigos de processamento
Ao final do processamento da solicitação, o Web Service retorna um código de status (cStat) e uma descrição (xMotivo) indicando o resultado. Os códigos de sucesso e rejeição mais relevantes são:
- 150: Consulta de CSC realizada com sucesso, com CSC ativo(s).
- 151: Consulta de CSC realizada com sucesso, sem CSC ativo.
- 152: CSC gerado.
- 153: CSC revogado.
- 802: Rejeição: Contribuinte possui número máximo de CSC ativo.
- 803: Rejeição: O CSC e o identificador informado não possuem correspondência.
- 804: Rejeição: O CSC informado não pertence ao solicitante da revogação.
- 805: Rejeição: O CSC informado está revogado.
- 215: Rejeição: Falha no schema XML.
- 280: Rejeição: Certificado Transmissor inválido.
- 999: Rejeição: Erro não catalogado.
Estes códigos são essenciais para que os sistemas das empresas possam interpretar o retorno do Web Service e tomar as ações necessárias, seja para registrar um novo CSC, confirmar uma revogação ou tratar um erro.
Conclusão
O Web Service de gerenciamento do CSC NFCe, detalhado na NT-NFCe 2014/001, é um mecanismo técnico para que as empresas emissoras de NFCe automatizem a administração dos Códigos de Segurança do Contribuinte. As funcionalidades de consulta, requisição e revogação de CSCs são padronizadas por meio de mensagens XML e comunicação síncrona, exigindo a utilização de certificados digitais.
A estrita observância das regras de validação e o correto tratamento dos códigos de retorno são necessários para o sucesso das operações. Este serviço otimiza a gestão fiscal e assegura a conformidade na geração dos QR-Codes do DANFE NFCe.