Pular para conteúdo

Controle de Numeração do RPS

Com o intuito de realizar o controle de numeração e série para a NFS-e, implementamos a tag IDUnico nos layouts de envio, consulta e cancelamento de NFS-e que pode ser utilizada tanto na integração via Web Service e API REST.

Esta tag é de preenchimento opcional, mas se for utilizada irá substituir o número e a série do documento enviado. Se preenchida, será necessário que exista uma série cadastrada no InvoiCy, pois é através dela que faremos o controle de numeração e série do documento.

O ID Único do documento pode ser verificado na aba "Geral" dos RPS nos detalhes do documento, conforme segue:

alt text

No cadastro da série, além do módulo NFS-e, é preciso informar também o número do último RPS emitido, pois o InvoiCy irá incrementar e enviar esse número RPS para a prefeitura.

Caso o campo RPSSerie não for preenchido, o InvoiCy irá utilizar a série padrão cadastrada. No entanto, se for enviado o IDUnico, o número e a série no documento, o InvoiCy não irá atualizar o cadastro de séries, portanto a numeração não será incrementada.

Cada NFS-e terá um ID único, ou seja, o mesmo ID não poderá ser utilizado para outra nota. Dentro deste campo, pode ser preenchido qualquer valor que possa identificar o RPS, entretanto essa tag aceita até 200 caracteres.

As regras da série são válidas para o envio, consulta e cancelamento de documentos.

Envio de Documento

Abaixo, pode-se observar um exemplo XML de envio de documento com a tag IDUnico preenchida:

<Envio>
    <ModeloDocumento>NFSE</ModeloDocumento>
    <Versao>1.00</Versao>
    <RPS>
        <RPSNumero/>
        <RPSSerie/>
        <RPSTipo>1</RPSTipo>
        <IDUnico>IDUNICO_5</IDUnico>
        <dEmis>2026-01-20T16:41:40</dEmis>
[...]

Mais informações sobre a estrutura completa do envio de documentos podem ser consultadas aqui.

No retorno do documento enviado, o InvoiCy irá trazer o DocNumero seguindo a sequência do último RPS emitido e também o DocSerie conforme a série cadastrada.

Consulta de Documento

Para consulta de documentos é preciso preencher somente a tag IDUnico, com o mesmo valor utilizado para a emissão RPS.

Segue abaixo um exemplo do XML de envio:

<Consulta>
    <ModeloDocumento>NFSe</ModeloDocumento>
    <Versao>1.00</Versao>
    <tpAmb>2</tpAmb>
    <CnpjEmissor>99999999999999</CnpjEmissor>
    <NumeroInicial/>
    <NumeroFinal/>
    <Serie/>
    <IDUnico>IDUNICO_5</IDUnico>
[...]

Acesse aqui, mais informações sobre o XML de consulta de documentos.

No retorno da consulta do documento, o InvoiCy irá trazer as tags DocNumero e DocSerie preenchidas.

Cancelamento de Documento

Já para o cancelamento do RPS continua sendo obrigatório preencher o campo NFSeNumero além do IDUnico. Segue abaixo, um exemplo envio da estrutura do XML que deve ser enviada neste cenário:

<EnvioEvento>
    <ModeloDocumento>NFSe</ModeloDocumento>
    <Versao>1</Versao>
    <Evento>
        <CNPJ>99999999999999</CNPJ>
        <NFSeNumero>56</NFSeNumero>
        <RPSNumero/>
        <RPSSerie/>
        <IDUnico>IDUNICO_5</IDUnico>
[...]

Mais informações sobre a estrutura XML de envio, podem ser obtidas aqui.

No retorno do cancelamento do documento, o InvoiCy irá trazer as tags DocNumero e DocSerie preenchidas.