Skip to main content
Skip table of contents

Integração Via Arquivo

A DLL de integração padrão irá gravar em um diretório pré-definido durante as configurações do aplicativo. A nomenclatura e a ordem da integração poderão ser alteradas nas configurações do NFS-e Settings, segue abaixo exemplos de retorno de integração via arquivo TXT e XML.

Integração de Erro no Input de RPS

Preenchimento da Nomenclatura de Retorno de Envio com Erro.

Campo

Descrição

Exemplo Preenchimento

Estado

Observação

[JOBID]

Número do JobId.

1

Opcional

Número do JobId.

[NUMRPS]

Número do RPS

4

Opcional

Número do RPS

[SERIE]

Série do RPS

NF

Opcional

Série do RPS

[TIPO]

Tipo da RPS.

1

Opcional

Tipo de envio do RPS.

[CNPJ]

CNPJ do Prestador de serviço.

12345678901234

Opcional

CNPJ do Prestador de Serviço.

[DATA]

Data de emissão da NFS-e

22/03/2016

Opcional

Data de Emissão da NFS-e.

[HORA]

Hora da Emissão da NFS-e

10:48:01

Opcional

Hora da Emissão da NFS-e.

Exemplo de Preenchimento da Nomenclatura

TXT:

<NUMRPS>_<SERIE>_<TIPO>_ERRO.txt

4_NF_1_ERRO.txt

 

XML:

<NUMRPS>_<SERIE>_<TIPO>_ERRO.xml

4_NF_1_ERRO.xml

 

Integração de Retorno de Envio com Erros (Input)

Campo

Descrição

Exemplo Preenchimento

Estado

Observação

0000

Número da Linha.

0000

Obrigatório

Número da linha.

NUMCGC

CNPJ do Prestador de Serviço.

12345678901234

Obrigatório

CNPJ do Prestador de Serviço

NUMRPS

Número do RPS.

4

Obrigatório

Número do RPS.

CODSNF

Série do RPS.

NF

Obrigatório

Série do RPS

INDSUC

Status do sucesso de retorno.

3

Obrigatório

Status:

2 – Rejeitada.

3 – Arquivo mal Formatado.

NUMNFS

Número da NFS-e

-

Opcional

Não será retornado informação para este campo.

CODVRF

Número do Código de Verificação da NFS-e

-

Opcional

Não será retornado informação para este campo.

DATHOR

Data e Hora de emissão da NFS-e.

-

Opcional

Não será retornado informação para este campo.

RPSCLI

Número do RPS original.

9310

Opcional

Número do documento original enviado pelo cliente. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v4 ou superior.

RPSID

Número da Matricula.

RPS_Id_9310_NF

Opcional

Campo que será identificado a matrícula. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v4 ou superior.

CODCTR

Controle do RPS.

-

Opcional

Controle do RPS.

1000

Número da Linha.

1000

Obrigatório

Número da linha.

<Codigo>

Número do código da integração.

00

Obrigatório

Número do código de integração.

<Mensagem>

Mensagem de erro gerado pelo input.

Mensagem de erro gerado pelo input.

Obrigatório

Descrição da mensagem de integração

<Correcao>

Mensagem de correção do erro gerado pelo input.

Mensagem de correção do erro gerado pelo input.

Obrigatório

Correção da Mesagem de integração.

2000

Número da Linha.

2000

Opcional

Número da linha.

Será retornado está linha apenas para o layout 5.00 do NFS-e.

<Code>

Número do código da integração.

200

Opcional

Códigos de Integração:

200 – Erro de Conversão;

201 – Documento reenviado pelo ERP;

203 – Documento em processamento

204 – Documento já cancelado;

999 – Rejeição genérica da prefeitura.

<Mensage>

Mensagem de erro gerado pelo input.

Mensagem de erro gerado pelo input.

Opcional

Será apresentado em uma mensagem genérica o erro que foi retornado pelo Web Service ou pela aplicação.

Exemplo de retorno de integração de Envio com ERRO

TXT:

0000;03062543000121;9310;NF;3;;;;9310;RPS_Id_9310_NF

1000;00;9=O valor: '' não contêm o mínimo de caracteres obrigatórios para o campo: 'InscricaoMunicipal'.;

2000;200;Erro de conversão: O valor: '' não contêm o mínimo de caracteres obrigatórios para o campo: 'InscricaoMunicipal'.

 

XML:

<?xml version="1.0" encoding="utf-8"?>

<IntegrationXml xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema ">

<param retorno="XML" />

<AtualizarNfse>

  <Dados>

    <param nome="NUMCGC" valor="12345678901234"/>

    <param nome="NUMRPS" valor="4" />

    <param nome="CODSNF" valor="NF" />

    <param nome="INDSUC" valor="3" />

    <param nome="RPSCLI" valor="9310"/>

    <param nome="RPSID" valor="0123_RPS_QUAL"/>

    <Mensagens>

      <MensagemRetorno>

        <Codigo>00</Codigo>

        <Mensagem>9=O valor: '' não contêm o mínimo de caracteres obrigatórios para o campo: 'InscricaoMunicipal'. </Mensagem>

      </MensagemRetorno>

    </Mensagens>

    <MensagensLote />

    <MessagesBusiness>

      <MessageBusiness>

        <Code>200</Code>

        <Message>Erro de conversão: O valor: '' não contêm o mínimo de caracteres obrigatórios para o campo: 'InscricaoMunicipal'.</Message>

      </MessageBusiness>

    </MessagesBusiness>

  </Dados>

</AtualizarNfse>

</IntegrationXml>

Integração de RPS Convertida com Sucesso

Preenchimento da Nomenclatura de RPS Convertida com Sucesso.

Campo

Descrição

Exemplo Preenchimento

Estado

Observação

[JOBID]

Número do JobId.

1

Opcional

Número do JobId.

[NUMRPS]

Número do RPS

4

Opcional

Número do RPS

[SERIE]

Série do RPS

NF

Opcional

Série do RPS

[TIPO]

Tipo do RPS.

1

Opcional

Tipo de envio do RPS.

[CNPJ]

CNPJ do Prestador de serviço.

12345678901234

Opcional

CNPJ do Prestador de Serviço.

[DATA]

Data de emissão da NFS-e

22/03/2016

Opcional

Data de Emissão da NFS-e.

[HORA]

Hora da Emissão da NFS-e

10:48:01

Opcional

Hora da Emissão da NFS-e.

Exemplo da nomenclatura de retorno de RPS Convertida com Sucesso

TXT:

<NUMRPS>_<SERIE>_<TIPO>_RPS.txt

4_NF_1_ERRO.txt

 

XML:

<NUMRPS>_<SERIE>_<TIPO>_RPS.xml

4_NF_1_ERRO.xml

 

Integração de Retorno de RPS Convertida com Sucesso

Campo

Descrição

Exemplo Preenchimento

Estado

Observação

0000

Número da Linha.

0000

Obrigatório

Número da linha.

NUMCGC

CNPJ do Prestador de Serviço.

12345678901234

Obrigatório

CNPJ do Prestador de Serviço

NUMRPS

Número do RPS.

4

Obrigatório

Número do RPS.

CODSNF

Número de série do RPS.

NF

Obrigatório

Série do RPS

INDSUC

Status do sucesso de retorno.

4

Obrigatório

Status: 4 – RPS convertida com sucesso..

NUMNFS

Número da NFS-e

-

Opcional

Não será retornado informação para este campo.

CODVRF

Número do Código de Verificação da NFS-e

-

Opcional

Não será retornado informação para este campo.

DATHOR

Data e Hora de emissão da NFS-e.

-

Opcional

Não será retornado informação para este campo.

RPSCLI

Número do RPS original.

9310

Opcional

Número do documento original enviado pelo cliente. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v4 ou superior.

RPSID

Número da Matricula.

RPS_Id_9310_NF

Opcional

Campo que será identificado a matrícula. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v4 ou superior.

CODCTR

Controle do RPS.

-

Opcional

Controle do RPS.

1000

Número da Linha.

1000

Obrigatório

Número da linha.

<Codigo>

Número do código da integração.

99

Obrigatório

Número do código de integração.

<Mensagem>

Mensagem de erro gerado pelo input.

RPS convertida com sucesso.

Obrigatório

Descrição da mensagem de integração

Exemplo de retorno de integração de RPS Convertida com sucesso

TXT:

0000;03062543000121;9312;NF;4;;;;9312;RPS_Id_9315_NF

1000;99;RPS convertida com sucesso

 

XML:

<?xml version="1.0" encoding="utf-8"?>

<IntegrationXml xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema ">

<param retorno="XML" />

<AtualizarNfse>

  <Dados>

    <param nome="NUMCGC" valor="06255692000103" />

    <param nome="NUMRPS" valor="80007" />

    <param nome="CODSNF" valor="NF" />

    <param nome="INDSUC" valor="4" />

    <param nome="NUMNFS" />

    <param nome="CODVRF" />

    <param nome="DATHOR" />

    <param nome="RPSCLI" valor="9313" />

    <param nome="RPSID" valor="RPS_Id_9315_NF" />

    <Mensagens>

      <MensagemRetorno>

        <Codigo>99</Codigo>

        <Mensagem>RPS convertida com sucesso.</Mensagem>

      </MensagemRetorno>

    </Mensagens>

    <MensagensLote />

    <MessagesBusiness />

  </Dados>

</AtualizarNfse>

Integração de Retorno de RPS com erros (Web Service)

Preenchimento da Nomenclatura de Retorno de Envio com Erro.

Campo

Descrição

Exemplo Preenchimento

Estado

Observação

[JOBID]

Número do JobId.

1

Opcional

Número do JobId.

[NUMRPS]

Número do RPS

4

Opcional

Número do RPS

[SERIE]

Série do RPS

NF

Opcional

Série do RPS

[TIPO]

Tipo do RPS.

1

Opcional

Tipo de envio do RPS.

[CNPJ]

CNPJ do Prestador de serviço.

12345678901234

Opcional

CNPJ do Prestador de Serviço.

[DATA]

Data de emissão da NFS-e

22/03/2016

Opcional

Data de Emissão da NFS-e.

[HORA]

Hora da Emissão da NFS-e

10:48:01

Opcional

Hora da Emissão da NFS-e.

Exemplo de Preenchimento da Nomenclatura

TXT:

<NUMRPS>_<SERIE>_<TIPO>_ERRO.txt

4_NF_1_ERRO.txt

 

XML:

<NUMRPS>_<SERIE>_<TIPO>_ERRO.xml

4_NF_1_ERRO.xml

 

Integração de Retorno de Envio com Erros (Web Service)

Campo

Descrição

Exemplo Preenchimento

Estado

Observação

0000

Número da Linha.

0000

Obrigatório

Número da linha.

NUMCGC

CNPJ do Prestador de Serviço.

12345678901234

Obrigatório

CNPJ do Prestador de Serviço

NUMRPS

Número do RPS.

4

Obrigatório

Número do RPS.

CODSNF

Número de série do RPS.

NF

Obrigatório

Série do RPS

INDSUC

Status do sucesso de retorno.

2

Obrigatório

Status:

2 – Rejeitada.

3 – Arquivo mal Formatado.

NUMNFS

Número da NFS-e

-

Opcional

Não será retornado informação para este campo.

CODVRF

Número do Código de Verificação da NFS-e

-

Opcional

Não será retornado informação para este campo.

DATHOR

Data e Hora de emissão da NFS-e.

-

Opcional

Não será retornado informação para este campo.

RPSCLI

Número do RPS original.

9310

Opcional

Número do documento original enviado pelo cliente. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v4 ou superior.

RPSID

Número da Matricula.

RPS_Id_9310_NF

Opcional

Campo que será identificado a matrícula. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll seja a v4 ou superior.

CODCTR

Controle do RPS.

-

Opcional

Controle do RPS.

1000

Número da Linha.

1000

Obrigatório

Número da linha.

<Codigo>

Número do código da integração.

00

Obrigatório

Número do código de integração.

<Mensagem>

Mensagem de erro gerado pelo input.

Mensagem de erro gerado pelo input.

Obrigatório

Descrição da mensagem de integração

<Correcao>

Mensagem de correção do erro gerado pelo input.

Mensagem de correção do erro gerado pelo input.

Obrigatório

Correção da mensagem de integração.

2000

Número da Linha.

2000

Opcional

Número da linha. É retornada está linha apenas para o layout 5.00 do NFS-e.

<Code>

Número do código da integração.

200

Opcional

Códigos de Integração:

200 – Erro de Conversão;

201 – Documento reenviado pelo ERP;

203 – Documento em processamento

204 – Documento já cancelado;

999 – Rejeição genérica da prefeitura.

<Mensage>

Mensagem de erro gerado pelo input.

Mensagem de erro gerado pelo input.

Opcional

Será apresentado em uma mensagem genérica o erro que foi retornado pelo Web Service ou pela aplicação.

Exemplo de retorno de integração de Envio com ERRO

TXT:

000012345678901234; ;9319;NF44;2;;;;5053;0123_RPS_QUAL

1000;E30;Item da lista de serviço inexistente;Consulte a legislação vigente para saber o item da lista de serviço que deverá ser informado neste campo.

2000;999; Rejeição genérica da prefeitura - Mensagem: Número da NFS-e inexistente na base de dados para o prestador de serviço pesquisado - Correção: Informe o número correto da NFS-e..

 

XML:

<?xml version="1.0" encoding="utf-8"?>

<IntegrationXml xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema ">

 <param retorno="XML"/>

 <AtualizarNfse>

            <Dados>

              <param nome="NUMCGC" valor="12345678901234"/>

              <param nome="NUMRPS" valor="4"/>

              <param nome="CODSNF" valor="NF"/>

              <param nome="INDSUC" valor="2"/>

                           <param nome="RPSCLI" valor="5053"/>

                           <param nome="RPSID" valor="0123_RPS_QUAL"/>

                                <Mensagens>

                 <MensagemRetorno>

                             <Codigo> E998</Codigo>

                 <Mensagem> Número do lote RPS inválido </Mensagem>

                 <Correcao> Numero do lote já enviado ou fora do ão</Correcao>

                 </MensagemRetorno>

                     </Mensagens>

                              <MensagensLote/>

                 <MessagesBusiness>

                            <MessageBusiness>

                          <Code>999</Code>

                         <Message>Rejeição genérica da prefeitura - Mensagem: Número da NFS-e inexistente na base de dados para o prestador de serviço pesquisado - Correção: Informe o número correto da NFS-e.</Message>

                      </MessageBusiness>

                       </MessagesBusiness>

               </Dados>

 </AtualizarNFSe>

</IntegrationXml>

Integração de Retorno de Autorização de NFS-e

Preenchimento da Nomenclatura de retorno de autorização de NFS-e.

Campo

Descrição

Exemplo Preenchimento

Estado

Observação

[NUMNFSE]

Número da NFS-e

1355

Opcional

Número da NFS-e.

[JOBID]

Número do JobId.

1

Opcional

Número do JobId.

[NUMRPS]

Número da RPS

4

Opcional

Número da RPS

[SERIE]

Série da RPS

NF

Opcional

Série da RPS

[TIPO]

Tipo da RPS.

1

Opcional

Tipo de envio da RPS.

[CNPJ]

CNPJ do Prestador de serviço.

12345678901234

Opcional

CNPJ do Prestador de Serviço.

[DATA]

Data de emissão da NFS-e

22/03/2016

Opcional

Data de Emissão da NFS-e.

[HORA]

Hora da Emissão da NFS-e

10:48:01

Opcional

Hora da Emissão da NFS-e.

Exemplo de Preenchimento da Nomenclatura

TXT:

<NUMRPS>_<SERIE>_<TIPO>_ENVI.txt

4_NF_1_ERRO.txt

 

XML:

<NUMRPS>_<SERIE>_<TIPO>_ENVI.xml

4_NF_1_ERRO.xml

 

Integração de Retorno de Envio Autorizado (Web Service)

Campo

Descrição

Exemplo Preenchimento

Estado

Observação

0000

Número da Linha.

0000

Obrigatório

Número da linha.

NUMCGC

CNPJ do Prestador de Serviço.

12345678901234

Obrigatório

CNPJ do Prestador de Serviço

NUMRPS

Número da RPS.

4

Obrigatório

Número da RPS.

CODSNF

Número de série da RPS.

NF

Obrigatório

Série da RPS

INDSUC

Status do sucesso de retorno.

1

Obrigatório

Status:

1 - Autorizada

NUMNFS

Número da NFS-e

1355

Obrigatório

Não será retornado informação para este campo.

CODVRF

Número do Codigo de Verificação da NFS-e

IGEAXO9KE

Obrigatório

Não será retornado informação para este campo.

DATHOR

Data e Hora de emissão da NFS-e.

2012-11-29T13:51:53

Obrigatório

Não será retornado informação para este campo.

RPSCLI

Número do RPS original.

9310

Opcional

Número do documento original enviado pelo cliente. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v4 ou superior.

RPSID

Número da Matricula.

RPS_Id_9310_NF

Opcional

Campo que será identificado a matrícula. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v4 ou superior.

CODCTR

Controle do RPS.

-

Opcional

Controle do RPS.

Exemplo de retorno de integração de autorização de NFS-e

TXT:

0000;12345678000121;9319;NF;1;9938;e1bb8ba3df4d4a3e669d6d2e51a7249;20/10/2014 12:00:00;5054;0123_RPS_QUAL

 

XML:

<?xml version="1.0" encoding="utf-8"?>

<IntegrationXml xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema ">

<param retorno="XML" />

<AtualizarNfse>

  <Dados>

    <param nome="NUMCGC" valor="12345678901234" />

    <param nome="NUMRPS" valor="4" />

    <param nome="CODSNF" valor="NF" />

    <param nome="INDSUC" valor="1" />

    <param nome="NUMNFS" valor="1355" />

    <param nome="CODVRF" valor="IGEAXO9KE" />

    <param nome="DATHOR" valor="2012-11-29T13:51:53" />

    <param nome="RPSCLI" valor="5053" />

    <param nome="RPSID" valor="0123_RPS_QUAL" />

    <Mensagens />

    <MensagensLote />

    <MessagesBusiness />

  </Dados>

</AtualizarNfse>

</IntegrationXml>

Integração de Retorno de Cancelamento Rejeitado

Preenchimento da Nomenclatura de retorno de Cancelamento Rejeitado.

Campo

Descrição

Exemplo Preenchimento

Estado

Observação

[NUMNFSE]

Número da NFS-e

1355

Opcional

Número da NFS-e.

[JOBID]

Número do JobId.

1

Opcional

Número do JobId.

[NUMRPS]

Número do RPS

4

Opcional

Número do RPS

[SERIE]

Série do RPS

NF

Opcional

Série do RPS

[TIPO]

Tipo do RPS.

1

Opcional

Tipo de envio do RPS.

[CNPJ]

CNPJ do Prestador de serviço.

12345678901234

Opcional

CNPJ do Prestador de Serviço.

[DATA]

Data de emissão da NFS-e

22/03/2016

Opcional

Data de Emissão da NFS-e.

[HORA]

Hora da Emissão da NFS-e

10:48:01

Opcional

Hora da Emissão da NFS-e.

Exemplo de Preenchimento da Nomenclatura

TXT:

<NUMNFS>CANC.txt

1355_CANC.txt

 

XML:

<NUMNFS>CANC_CANC.xml

1355_CANC.xml

 

Integração de Retorno de Envio com Erros (Web Service)

Campo

Descrição

Exemplo Preenchimento

Estado

Observação

0000

Número da Linha.

0000

Obrigatório

Número da linha.

NUMCGC

CNPJ do Prestador de Serviço.

12345678901234

Obrigatório

CNPJ do Prestador de Serviço

NUMRPS

Número do RPS.

4

Obrigatório

Número do RPS.

CODSNF

Número de série do RPS.

NF

Obrigatório

Série do RPS

INDSUC

Status do sucesso de retorno.

2

Obrigatório

Status:

2 – Rejeitada.

NUMNFS

Número da NFS-e

1355

Obrigatório

Não será retornado informação para este campo.

CODVRF

Número do Código de Verificação da NFS-e

IGEAXO9KE

Obrigatório

Não será retornado informação para este campo.

DATHOR

Data e Hora de emissão da NFS-e.

2012-11-29T13:51:53

Obrigatório

Não será retornado informação para este campo.

RPSCLI

Número do RPS original.

9310

Opcional

Número do documento original enviado pelo cliente. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v4 ou superior.

RPSID

Número da Matricula.

RPS_Id_9310_NF

Opcional

Campo que será identificado a matrícula. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v4 ou superior.

CODCTR

Controle do RPS.

-

Opcional

Controle do RPS.

CDSRPS

Série do RPS

Im01

Opcional

Série original do RPS. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v6.

1000

Número da Linha.

1000

Obrigatório

Número da linha.

<Codigo>

Número do código da integração.

E45

Obrigatório

Número do código de integração.

<Mensagem>

Mensagem de erro gerado pelo Web Service.

Mensagem de erro gerado pelo Web Service.

Obrigatório

Descrição da mensagem de integração

<Correcao>

Mensagem de correção do erro gerado pelo Web Service.

Mensagem de correção do erro gerado pelo Web Service.

Obrigatório

Correção da Mesagem de integração.

2000

Número da Linha.

2000

Opcional

Número da linha. Será retornado está linha apenas para o layout 5.00 do NFS-e.

<Code>

Número do código da integração.

E45

Opcional

Códigos de Integração:

200 – Erro de Conversão;

201 – Documento reenviado pelo ERP;

203 – Documento em processamento

204 – Documento já cancelado;

999 – Rejeição genérica da prefeitura..

<Mensage>

Mensagem de erro gerado pelo Web Service.

Mensagem de erro gerado pelo Web Service.

Opcional

Descrição da mensagem de integração

Exemplo de retorno de integração de cancelamento rejeitado.

TXT:

0000;06255692000103;16;CANC;2;204075;;;Im01

1000;E45;CNPJ não encontrado na base de dados;Confira o numero do CNPJ informado. Caso esteja correto, o prestador não está inscrito no município.

 

XML:

<?xml version="1.0" encoding="utf-8"?>

<IntegrationXml xmlns:xsd="http://www.w3.org/2001/XMLSchema " xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

 <param retorno="XML" />

 <AtualizarNfse>

   <Dados>

     <param nome="NUMCGC" valor="06255692000103" />

     <param nome="NUMRPS" valor="3" />

     <param nome="CODSNF" valor="CANC" />

     <param nome="INDSUC" valor="2" />

     <param nome="NUMNFS" valor="203775" />

     <param nome="CODVRF" valor="" />

     <param nome="DATHOR" valor="" />

       <param nome="RPSCLI" valor="9310" />

        <param nome="RPSID" valor="RPS_Id_9310_NF" />

     <param nome="CDSRPS" valor="Im01" />

     <Mensagens>

     <MensagemRetorno>

         <Codigo>00</Codigo>

         <Mensagem>Documento: 'C:\Tools\Input\Lages-SC\4.00\XML\Canc_6232016_35340 PM_canc.xml' já está cancelado.</Mensagem>

       </MensagemRetorno>

     </Mensagens>

     <MensagensLote />

     <MessagesBusiness />

   </Dados>

 </AtualizarNfse>

</IntegrationXml>

Integração de Retorno de Cancelamento Autorizado de NFS-e

Preenchimento da Nomenclatura de retorno de cancelamento autorizado.

Campo

Descrição

Exemplo Preenchimento

Estado

Observação

[NUMNFSE]

Número da NFS-e

1355

Opcional

Número da NFS-e.

[JOBID]

Número do JobId.

1

Opcional

Número do JobId.

[NUMRPS]

Número do RPS

4

Opcional

Número do RPS

[SERIE]

Série do RPS

NF

Opcional

Série do RPS

[TIPO]

Tipo do RPS.

1

Opcional

Tipo de envio do RPS.

[CNPJ]

CNPJ do Prestador de serviço.

12345678901234

Opcional

CNPJ do Prestador de Serviço.

[DATA]

Data de emissão da NFS-e

22/03/2016

Opcional

Data de Emissão da NFS-e.

[HORA]

Hora da Emissão da NFS-e

10:48:01

Opcional

Hora da Emissão da NFS-e.

Exemplo de Preenchimento da Nomenclatura

TXT:

<NUMNFS>CANC.txt

1355_CANC.txt

 

XML:

<NUMNFS>CANC_CANC.xml

1355_CANC.xml

 

Integração de Retorno de Envio Cancelamento Autorizado (Web Service)

Campo

Descrição

Exemplo Preenchimento

Estado

Observação

0000

Número da Linha.

0000

Obrigatório

Número da linha.

NUMCGC

CNPJ do Prestador de Serviço.

12345678901234

Obrigatório

CNPJ do Prestador de Serviço

NUMRPS

Número do RPS.

4

Obrigatório

Número do RPS.

CODSNF

Número de série do RPS.

NF

Obrigatório

Série do RPS

INDSUC

Status do sucesso de retorno.

1

Obrigatório

Status:

1 - Cancelamento.

NUMNFS

Número da NFS-e

1355

Obrigatório

Não será retornado informação para este campo.

CODVRF

Número do Código de Verificação da NFS-e

IGEAXO9KE

Opcional

Não será retornado informação para este campo.

DATHOR

Data e Hora de emissão da NFS-e.

2012-11-29T13:51:53

Opcional

Não será retornado informação para este campo.

RPSCLI

Número do RPS original.

9310

Opcional

Número do documento original enviado pelo cliente. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v4 ou superior.

RPSID

Número da Matricula.

RPS_Id_9310_NF

Opcional

Campo que será identificado a matrícula. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v4 ou superior.

CODCTR

Controle do RPS.

-

Opcional

Controle do RPS.

CDSRPS

Série do RPS

TCold

Opcional

Série original do RPS. É retornado o campo se a opção retornar "valor original" na integração estiver habilitada e a versão da dll for a v6.

Exemplo de retorno de integração de cancelamento autorização de NFS-e

TXT:

0000;06255692000103;17;CANC;1;204083;;;TCold

 

XML:

<?xml version="1.0" encoding="utf-8"?>

<IntegrationXml xmlns:xsd="http://www.w3.org/2001/XMLSchema " xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

 <param retorno="XML" />

 <AtualizarNfse>

   <Dados>

     <param nome="NUMCGC" valor="06255692000103" />

     <param nome="NUMRPS" valor="8" />

     <param nome="CODSNF" valor="CANC" />

     <param nome="INDSUC" valor="1" />

     <param nome="NUMNFS" valor="203534" />

     <param nome="CODVRF" valor="" />

     <param nome="DATHOR" valor="2016-06-23T00:00:00" />

      <param nome="RPSCLI" valor="9310" />

      <param nome="RPSID" valor="RPS_Id_9310_NF" />

    <param nome="CDSRPS" valor="TCold" />

     <Mensagens />

     <MensagensLote />

     <MessagesBusiness />

   </Dados>

 </AtualizarNfse>

</IntegrationXml>

IMPORTANTE

Os valores do arquivo de retorno são preenchidos pela Prefeitura, que retorna estes dados após uma consulta realizada junto ao Web Service.

{{component-feedback-article}}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.