Consulta Cold (Guarda Eletrônica) por NFS-e

 

O Cold guarda os documentos de RPS e NFS-e eletrônica, através do Web Service é possível consultar os documentos armazenados nele, podendo retornar os seguintes documentos:

 

Xml de RPS;

Xml de NFS-e (formato retornado da prefeitura);

PDF de NFS-e;

Xml de Cancelamento (formato retornado da prefeitura).

 

No Web Service NFS-e, será disponível apenas consulta de um único documento por mensagem, no entanto o campo utilizado para este modelo de consulta será o <FixedFilter>, os campos <StandardFilter> e <MultipleFilter> estão disponíveis nos schemas, porém serão utilizados apenas em versões futuras para a realização de pesquisa por lotes. Para enviar uma mensagem de consulta cold não deverá ser enviado o parâmetro RawData, é necessário enviar uma mensagem utilizando a estrutura abaixo.

 

Crosstalk de Consulta Cold:

 

<CrossTalk_Message>

 <CrossTalk_Header>

         <ProcessCode>20003</ProcessCode>

         <MessageType>103</MessageType>

         <ExchangePattern>1</ExchangePattern>

         <GUID>b4064517-2c54-4f0b-97e1-65dcc1c904bb</GUID>

         <DateTime>2001-12-17T09:30:47.0Z</DateTime>

         <EnterpriseId>12345678912345</EnterpriseId>

         <Token>12341234</Token>

         <ContentType>text/csv</ContentType>

         <ContentEncoding>utf-8</ContentEncoding>

 </CrossTalk_Header>

 <CrossTalk_Body>

         <GroupId>Cold Filial 1</GroupId>

         <FixedFilter>

                 <ColdSearch XMLRps="true" XMLNFSe="true" PDFNFSe="false" XMLCancel="false">

                         <Authentication>

                                 <User>testes</User>

                                 <Password>1234!@#</Password>

                                 <ColdID>1</ColdID>

                         </Authentication>

                         <Document>

                                 <IMPrest>123456</IMPrest>

                                 <NFSe Number="1069" EmissionDate="2016-03-28" />

                         </Document>

                 </ColdSearch>

         </FixedFilter>

 </CrossTalk_Body>

</CrossTalk_Message>

 

Detalhamento do Crosstalk de Consulta Cold:

 

Pedido de Impressão de RPS pelo Web Service

NFSe_p20003_m103.xsd

#

ID

Campo

Descrição

Elemento

Pai

Tipo

Ob.

Tam.

Dec.

Observação

1

A01

<CrossTalk_Message>

TAG Raiz da mensagem.

G

-

-

S

-

-

Tag Raiz da mensagem.

2

B01

<CrossTalk_Header>

Grupo de informações da mensagem.

G

A01

-

S

-

-

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

3

B02

<ProcessCode>

Código do processo de envio de RPS.

E

B01

N

S

5

-

Para o Envio de RPS informar o valor: 20003.

4

B03

<MessageType>

Tipo de operação que será realizada.

E

B01

N

S

3

-

Informar o Valor: 103

5

B04

<ExchangePattern>

Tipo de mensagem que será realizada.

E

B01

N

S

1

-

Informar o valor: 1

6

B05

<SourceId>

Identificador de envio do ERP.

E

B01

N

N

30

-

Informar o código de controle de envio do ERP.

7

B06

<GUID>

Identificador Global Unique Identifier.

E

B01

C

S

36

-

Código Identificador da Mensagem no formato GUID.

Ex: 756f0d2d-ff23-460c-9323-2f6b2d0ba171

8

B07

<DateTime>

Data e hora de envio da mensagem.

E

B01

D

N

-

-

Modelo : AAAA-MM-DDTHH:MM:SS.MMMMMMM-02:00

Ex: 2011-10-15T10:29:18.8333928-02:00

9

B08

<EnterpriseId>

CNPJ do prestador de serviço.

E

B01

N

S

14

-

Informar CNPJ do prestador do serviço.

10

B09

<Token>

Identificador único de emissão do ERP.

E

B01

C

S

50

-

Informar código de identificação do software gerador de RPS.

11

B10

<ContentType>

Tipo do Documento RPS enviado no RawData

E

B01

C

N

8

-

Especificação do tipo de dado que a mensagem está formatada, como "text/xml".

12

B11

<ContentEncoding>

Codificação do documento RPS enviado no RawData.

E

B01

C

S

10

-

UTF-8

ASCII

Default

13

C01

<CrossTalk_Body>

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

G

A01

-

S

-

-

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

14

C02

<GrupoID>

Identificação da conexão Cold

E

C01

C

S

20

-

Texto livre para identificação da conexão cold solicitada.

15

C03

<StandardFilter>

 

Filtro de pesquisa utilizado para solicitação de documentos em lotes. Será Obrigatório apenas um dos seguintes grupos: <StandardFilter>, <MultipleFilter> ou <FixedFilter>.

G

C01

-

N

-

-

 

Enviar este grupo para solicitação de documentos em lotes.

 

OBS: Esta opção não esta disponível para a versão 4.5.1 do Web Service NFS-e.

16

C04

<FilterName>

Identificação do filtro.

E

C03

C

S

-

-

-

17

C05

<Fields>

Campos a serem filtrados

G

C03

-

S

-

-

Grupo de filtros de pesquisa.

18

C06

<Field>

 

Informações dos dados utilizados no filtro de pesquisa. Este campo poderá ser repedido quantas vezes forem necessárias.

E

C05

-

S

-

-

 

Informações dos dados utilizados no filtro de pesquisa. Este campo poderá ser repedido quantas vezes forem necessárias.

19

C07

<Name>

Nome do campo de filtro de pesquisa.

A

C06

C

S

-

-

Nome do campo utilizado no filtro de pesquisa.

20

C08

<Value>

Valor do campo de filtro de pesquisa.

 

C06

C

S

-

-

-

21

C09

<Operation>

Operação do campo com o valor.

A

C06

N

S

1

 

Informar o código de operação do campo com o valor dele.

 

0 - Igual

1  - Maior Igual

2 - Menor Igual

3 - Maior

4 – Menor

5 -  Diferente

6 -Conteúdo, somente para campos alfanuméricos, caso não seja informado será 0.

22

C10

<Connection>

-

A

C06

N

S

1

-

-

23

C11

<MultipleFilter>

 

Múltiplos filtros de pesquisa utilizados para solicitação de documentos em lotes. Será Obrigatório apenas um dos seguintes grupos: <StandardFilter>, <MultipleFilter> ou <FixedFilter>.

G

C01

-

N

-

-

Enviar este grupo para solicitação de documentos em lotes.

 

OBS: Esta opção não esta disponível para a versão do Web Service NFS-e.

24

C12

<Expression>

Expressão de pesquisa. Este campo poderá ser repetido quantas vezes forem necessárias.

G

C11

-

S

-

-

Grupo de expressão de pesquisa.

25

C13

<FilterName>

Nome do filtro

E

C12

C

S

15

-

Nome do filtro de pesquisa.

26

C14

<Fields>

Campos a serem filtrados

G

C12

-

S

-

-

Grupo de filtros de pesquisa.

27

C15

<Field>

 

Informações dos dados utilizados no filtro de pesquisa. Este campo poderá ser repedido quantas vezes forem necessárias.

E

C14

-

S

-

-

Informações dos dados utilizados no filtro de pesquisa. Este campo poderá ser repedido quantas vezes forem necessárias.

28

C16

<Name>

Nome do campo do filtro de pesquisa.

A

C15

C

S

-

-

Nome do campo utilizado no filtro de pesquisa.

29

C17

<Value>

Valor do campo do filtro de pesquisa.

A

C15

C

S

-

-

Valor do campo utilizado no filtro de pesquisa.

30

C18

<Operation>

 

Operação do campo com o valor dele.

A

C06

N

S

1

-

Informar o código de operação do campo com o valor dele.

 

0 - Igual

1  - Maior Igual

2 - Menor Igual

3 - Maior

4 – Menor

5 -  Diferente

6 – Conteúdo, somente para campos alfanuméricos, caso não seja informado será 0.

31

C19

<Connection>

-

A

C06

N

S

1

-

-

32

C20

<Connection>

-

E

C12

-

N

-

-

-

33

C21

<FxedFilter>

Filtro de pesquisa. . Será Obrigatório apenas um dos seguintes grupos: <StandardFilter>, <MultipleFilter> ou <FixedFilter>.

G

C01

-

S

-

-

Filtro de Pesquisa de documentos inseridos no Cold.

OBS: Esta opção é a única disponível nesta versão.

34

C22

<ColdSearch>

Expressão de pesquisa cold.

G

C21

-

S

-

-

-

35

C23

<XMLRps>

Opção de retorno do XML de RPS.

A

C22

C

S

5

-

Enviar os valores:

 

true = Para retornar o xml de RPS.

false = Para não retornar o xml de RPS.

36

C24

<XMLNFSe>

Opção de retorno do XML de NFSe.

A

C22

C

S

5

-

Enviar os valores:

 

true = Para retornar o xml de NFS-e.

false = Para não retornar o xml de NFS-e.

37

C25

<PDFNFSe>

Opção de retorno do PDF de NFSe.

A

C22

C

S

5

-

Enviar os valores:

 

true = Para retornar o PDF de NFS-e.

false = Para não retornar o PDF de NFS-e

38

C26

<XMLCancel>

Opção de retorno do XML de cancelamento.

A

C22

C

S

5

-

Enviar os valores:

 

true = Para retornar o xml de Cancelamento.

false = Para não retornar o xml de Cancelamento.

39

C27

<Authentication>

 

Grupo com as credenciais de autenticação do usuário cold.

G

C22

-

S

-

-

Grupo com as credenciais de autenticação do usuário cold.

40

C28

<User>

Usuário com permissão para consulta cold.

E

C27

C

S

20

-

Usuário com permissão para consulta cold.

41

C29

<Password>

Password do usuário com permissão de consulta cold.

E

C27

C

S

20

-

Password do usuário com permissão de consulta cold.

42

C30

<ColdID>

Identificador da conexão cold configurada no Connector Settings.

E

C27

N

S

4

-

Identificador da conexão cold configurada no Connector Settings.

43

C31

<Document>

 

Informações dos documentos que serão consultados.

G

C22

-

S

-

-

-

44

C32

<IMPrest>

Inscrição municipal do prestador do serviço.

E

C31

C

S

20

-

Inscrição Municipal do Prestador do serviço.

45

C33

<NFSe>

Deverá ser informado este campo caso a pesquisa seja realizada pelo número da RPS. Será obrigatório o envio de apenas uma das tags: <RPS> ou <NFSe>.

A

C31

-

S

-

-

Informações em atributos da RPS que será consultada. Quando informado este campo não deverá ser informado o campo <NFSe> (C33)

46

C34

<Number>

Informar o número da NFS-e que deverá ser consultada.

A

C33

N

S

15

-

Número da NFS-e que deverá ser consultada.

47

C35

<EmissionDate>

Informar a data de emissão da NFS-e que deverá ser consultada.

A

C33

D

S

-

-

Informar a data de emissão da NFS-e.

 

Ex: 2011-10-15T10:29:18.8333928-02:00

 

Retorno da Consulta Cold (Guarda Eletrônica) por NFS-e