Anterior Próximo

Navegação:  Manuais Web Services > Manual de Integração NDDigital  NFS-e Web Service > Schemas e Processos de Envio de RPS > Consultar Status do Processamento da RPS

Retorno da Consulta de Status do Processamento do RPS

NFSe_p20001_m210_103.xsd

A mensagem de retorno deste processo, retornará a mensagem contendo os dados de status do processo solicitado onde a tag <CrossTalkHeader> assim como os demais processos não contém alteração de estrutura, a única diferença entre a tag de envio e de retorno para esta tag é a adição dos campos <ResponseCode> e <ResponseCodeMessage> que apresentam o status do processo da mensagem (se ela foi aceita ou não pelo Web Service).

A tag <CrossTalkBody> trará as informações da nota vinculada ao GUID pesquisado, conforme descrição no quadro abaixo.

 

A01 Raiz - TAG Raiz da mensagem Cross Talk

 

 

 

 

 

 

 

#

ID

Campo

Descrição

Elemento

Pai

Tipo

Ob.

Tam.

Dec.

Observação

 

Raiz

<CrossTalk_Message>

TAG Raiz da Mensagem

G

-

-

S

-

-

Tag Raiz da mensagem

 

 

 

 

 

 

 

 

 

 

 

B01 – Grupo CrossTalk Header

 

 

 

 

 

 

 

#

ID

Campo

Descrição

Elemento

Pai

Tipo

Ob.

Tam.

Dec.

Observação

2

B01

<CrossTalk_Header>

Grupo de informações da mensagem

G

A01

-

S

-

-

Grupo de informações do processo que será executado.

3

B02

<ResponseCode>

Código de resposta do processo.

E

B01

N

S

4

-

O Código do retorno será apresentado neste campo, e a descrição no campo abaixo (ReponseCodeMessage).

 

200 - Processamento realizado com sucesso

500 - Falha de Schema

501 – XML mal formado

510 – Duplicidade de GUID

511 – GUID invalido.

520 – JobKey Inexistente

522 – Job sem conexão de entrada via banco da de dados

523 – CNPJ do Prestador informado no ENTERPRISEID difere do cadastrado no Job

530 – Processo informado inexistente

999 – Erro não Catalogado (Exceções Genéricas/Banco de Dados)

4

B03

<ResponseCodeMessage>

Mensagem de resposta do processo.

E

B01

C

S

200

-

Mensagem referente aos códigos acima.

5

B02

<ProcessCode>

Código do processo de envio de RPS.

E

B01

N

S

5

-

Para o Envio de RPS informar o valor: 20001

6

B03

<MessageType>

Tipo de operação que será realizada.

E

B01

N

S

3

-

Retornará o mesmo valor 210.

210 – Resposta do WS

7

B04

<ExchangePattern>

Tipo de mensagem que será realizada.

E

B01

N

S

1

-

Retornará o mesmo valor informado para o campo na mensagem enviada no item Erro! Fonte de referência não encontrada. deste Manual.

8

B05

<SourceId>

Identificador de envio do ERP.

E

B01

N

N

30

-

Retornará o mesmo valor informado para o campo na mensagem enviada no item Erro! Fonte de referência não encontrada. deste Manual.

9

B06

<GUID>

Idenficador Global Unique Identifier.

E

B01

C

S

36

-

Retornará o mesmo valor informado para o campo na mensagem enviada no item Erro! Fonte de referência não encontrada. deste Manual.

10

B07

<DateTime>

Data e hora de envio da mensagem.

E

B01

D

N

-

-

Retornará o mesmo valor informado para o campo na mensagem enviada no item Erro! Fonte de referência não encontrada. deste Manual.

11

B08

<EnterpriseId>

CNPJ do prestador de serviço.

E

B01

N

S

14

-

Retornará o mesmo valor informado para o campo na mensagem enviada no item Erro! Fonte de referência não encontrada. deste Manual.

12

B09

<Token>

Identificador único de emissão do ERP.

E

B01

C

S

50

-

Retornará o mesmo valor informado para o campo na mensagem enviada no item Erro! Fonte de referência não encontrada. deste Manual.

13

B10

<ContentType>

Tipo do Documento RPS enviado no Rawdata.

E

B01

C

N

8

-

Retornará o mesmo valor informado para o campo na mensagem enviada no item Erro! Fonte de referência não encontrada. deste Manual.

14

B11

<ContentEncoding>

Codificação do documento RPS enviado no Rawdata.

E

B01

C

S

10

-

Retornará o mesmo valor informado para o campo na mensagem enviada no item Erro! Fonte de referência não encontrada. deste Manual.

C01 – Grupo Cross Talk Body

 

 

 

 

 

 

 

#

ID

Campo

Descrição

Elemento

Pai

Tipo

Ob.

Tam.

Dec.

Observação

15

C01

<CrossTalk_Body>

Grupo de informações de identificação do RPS

G

A01

-

S

-

-

Grupo que contém a identificação do RPS

16

C02

<JobKey>

Valor do JobKey configurado no NFS-e Settings

E

C01

N

S

10

-

Retornará o mesmo valor informado para o campo na mensagem enviada no item Erro! Fonte de referência não encontrada. deste Manual.

17

C03

<RpsList>

Grupo de listas de RPS.

G

C01

-

S

-

-

Grupo de lista de RPS.

18

C04

<Rps>

Informações da RPS.

E

C03

 

S

-

-

Informações da RPS.

19

C05

<Number>

Número da RPS

A

C04

N

S

15

-

Retornará o mesmo valor informado para o campo na mensagem enviada no item Erro! Fonte de referência não encontrada. deste Manual.

20

C06

<Series>

Série da RPS

A

C04

C

S

5

-

Retornará o mesmo valor informado para o campo na mensagem enviada no item Erro! Fonte de referência não encontrada. deste Manual.

21

C07

<Kind>

Tipo da RPS.

A

C04

N

S

1

-

Retornará o mesmo valor informado para o campo na mensagem enviada no item Erro! Fonte de referência não encontrada. deste Manual.

22

C08

<Code>

Código de processo da RPS

E

C04

N

S

3

-

Código do processo da RPS:

Neste campo será apresentado apenas o Código, no campo abaixo, será apresentada a descrição do retorno.

 

100 – RPS convertida em NFS-e 200 – RPS com erros de negocio

300 – RPS não encontrada

400 – RPS em processamento

500 – RPS não convertida

23

C09

<Description>

Decrição do processo da RPS.

E

C04

C

S

200

-

Retorna a descrição conforme código do campo <Code>.

24

C10

<StatusList>

Grupo de lista do status da RPS.

G

C04

-

N

-

-

Lista de Status da RPS.

25

C11

<Status>

Status da RPS.

G

C10

-

N

-

-

Este campo poderá  ser repedido de acordo com a solicitação de integração de Status informada na mensagem de consultar Status do RPS.

26

C12

<Code>

Código do Status da RPS apresentado no NFS-e monitor

E

C11

N

S

5

-

Valores possíveis de retorno:

1 – Documento inserido

2 – Enviando documento

3 – Protocolo de consulta recebido

4 – Consultando o status do processamento da RPS

5 – RPS processada com sucesso

6 – Buscando NFS-e

7 – Documento RPS convertido em NFS-e com sucesso

8 – RPS do lote não foi encontrada na base do município

9 – Erro de negócio retornado do município

10 – RPS não consta na base de processamento da Sefaz

15 – Erros de negócio retornados pelo município processo de consulta

16 – Alertas retornados pelo município

17 – Imprimindo RPS/NFS-e

18 – Integrando retorno RPS/NFS-e

19 – Reenvio de RPS

20 – Gerenciando lote de RPS

21 – Enviando para Cold (Envio)

22 – Cold inserido com sucesso

23 – Cold não inserido (Erros)

27 – Enviando B2B

28 – Processo de envido do B2B finalizado

27

C13

<Description>

Descrição do Status do RPS apresentado no NFS-e Monitor.

E

C11

C

N

200

-

Descrição conforme retorno do código acima.

28

C14

<IntegrationList>

Grupo de Lista de Integrações.

G

C04

-

N

 

-

Grupo de lista de integração.

As integrações geradas pelo NFS-e Connector, serão apresentadas neste grupo.

29

C15

<Integration>

Retorno do tipo de integração retornada no atributo “Kind”.

E

C14

-

N

-

-

Retorna o tipo de integração retornada no atributo “kind”.

30

C16

<Kind>

Retorna o tipo de integração gerada pelo NFS-e connector.

A

C15

N

N

2

-

1 – NFS-e retornada

3 – Rps com erros      

4 – RPS convertida para layout município                    

31

C17

<ContentData>

Retorna o conteúdo da integração gerada pelo connector utilizando o modo CDATA.

E

C15

C

N

-

-

Retorna o conteúdo da integração gerada pelo connector utilizando o modo CDATA.

32

C18

<compacted>

Informa se a integração retornada no campo ContentData foi compactada.

A

C17

C

S

10

-

Valores possíveis de retorno:

false – quando a integração não foi compactada.

true- Quando a integração foi compactada.

33

C19

<type>

-

A

C17

-

 

-

-

-

34

C20

<ErrorList>

Grupo de lista de erros.

G

C04

-

N

-

-

Grupe de apresentada a lista de erros. O Grupo ErrorList, será aprsentado apenas quando o campo <Code> retornar o valor “200 -RPS com Erros”

35

C21

<Error>

Grupo de erro.

G

C20

-

S

-

-

Grupo que apresentará as informações de erros referente a conversão do arquivo RPS.

36

C22

<Code>

Código do erro de conversão.

E

C21

N

S

3

-

Poderá retornar o seguinte valore:

 

200 – Erro na validação (Negócio)

37

C23

<Description>

Descrição do erro de conversão

E

C21

C

S

200

-

Descrição do erro de conversão relacionado ao código acima.

38

C24

<CityCode>

Código de erro retornado do município.

E

C21

C

N

10

-

Código de erro retornado do município.

39

C25

<CityDescription>

Descrição do erro retornado do município.

E

C21

C

N

200

-

Descrição do Código retornado do município

Exemplo da Mensagem de Envio de Consulta de Status de RPS

<CrossTalk_Message>

 <CrossTalk_Header>

         <ProcessCode>20001</ProcessCode>

         <MessageType>103</MessageType>

         <ExchangePattern>1</ExchangePattern>

         <GUID>756f0d2d-ff23-460c-9323-2f6b2d0ba171</GUID>

         <DateTime>2012-01-17T09:30:47.1234567-02:00</DateTime>

         <EnterpriseId>12345678912345</EnterpriseId>

         <Token>1scd586rtreaw2154</Token>

         <ContentEncoding>UTF-8</ContentEncoding>

 </CrossTalk_Header>

 <CrossTalk_Body>

         <JobKey>100</JobKey>

         <Kind>1</Kind>

         <GUIDSend>756f0d2d-ff23-460c-9323-2f6b2d0ba171</GUIDSend>

         <RpsList>

                 <Rps Number="100" Kind="1" Series="NDD"/>

         </RpsList>

 </CrossTalk_Body>

</CrossTalk_Message>

Exemplo da Mensagem de retorno de Consulta de Status de RPS Rejeitada

<CrossTalk_Message>

 <CrossTalk_Header>

         <ResponseCode>200</ResponseCode>

         <ResponseCodeMessage>Processado com Sucesso</ResponseCodeMessage>

         <ProcessCode>20001</ProcessCode>

         <MessageType>210</MessageType>

         <ExchangePattern>1</ExchangePattern>

         <GUID>756f0d2d-ff23-460c-9323-2f6b2d0ba171</GUID>

         <DateTime>2012-01-17T09:30:47.1234567-02:00</DateTime>

         <EnterpriseId>12345678912345</EnterpriseId>

         <Token>1scd586rtreaw2154</Token>

         <ContentEncoding>utf-8</ContentEncoding>

 </CrossTalk_Header>

 <CrossTalk_Body>

         <JobKey>100</JobKey>

         <RpsList>

                 <Rps Number="200" Kind="1" Series="NDD">

                         <Code>200</Code>

                         <Description>Rps com erros</Description>

                         <ErrorList>

                                 <Error>

                                         <Code>200</Code>

                                         <Description>Erro de validação retornado pelo Municipio</Description>

                                         <CityCode>E001</CityCode>

                                         <CityDescription>Natureza de Operação fora do formato esperado</CityDescription>

                                 </Error>

                         </ErrorList>

                         <StatusList>

                                 <Status>

                                         <Code>9</Code>

                                         <Description>Erro de ngócio retornado do município</Description>

                                 </Status>

                         </StatusList>

                 </Rps>

         </RpsList>

 </CrossTalk_Body>

</CrossTalk_Message>