eformsConsultarColdExclusive

#

Pai

Campo

Descrição

Tipo

Obrigatório

Ocorrências

Tamanho

Observações

1

versao

Versão do schema.

C

S

1

4

Versão do schema.

2

autenticacao

Autenticação do usuário na base do e-Cold.

G

S

1

O acesso ao e-Cold fica restrito, portanto para que se possa consultá-lo é necessário que sejam passadas as informações de acesso e conexão.

3

2

usuario

Nome do usuário.

C

S

1

1..100

Nome do usuário, conforme cadastrado na base do e-Forms.

4

2

senha

Senha do usuário.

C

S

1

1..100

Senha do usuário, conforme cadastrado na base do e-Forms.

5

2

conexaoid

Identificador da conexão e-Cold.

N

S

1

1..14

Identificador dado a conexão e-Cold.

6

solicitacao

Define os formatos dos dados a serem retornados.

G

S

1

7

6

tipodocumento

Tipo de documento a ser retornado.

N

S

1

1

1 = Documento eletrônico de envio;

2 = Documento eletrônico de cancelamento.

8

6

formatosolicitacao

Formato da solicitação.

N

S

1

1

1 = Somente documento Xml;

2 = Somente PDF;

3 = Ambos.

9

6

formatodocumento

Formato do documento.

N

S

1

1

1 = Xml;

2 = Txt delimitado (não implementado ainda).

10

6

composicaodocumento

Composição do documento a ser retornado.

N

S

1

1

1 = Apenas documento de envio;

2 = Apenas autorização;

3 = Documento e autorização (b2b).

11

6

solicitante

Id do solicitante.

C

S

1

1..14

ID do solicitante que irá realizar a pesquisa, no caso o CNPJ.

12

6

considerar

Considerar notas.

C

S

1

1

1 = considera documentos pesquisados para futuros bloqueios;

2 = não considera.

13

expressao

Expressão de pesquisa na base de dados.

G

S

1

14

13

item

Item da expressão

G

S

1..n

Cada item de uma expressão pode assumir apenas um dos itens abaixo.

15

14

blocoinicial

Bloco inicial de uma expressão.

C

S

1

Identifica o início de um bloco ou sub-bloco de pesquisa, seria o mesmo que um sinal de abrir parênteses em uma expressão matemática. Exemplo: <blocoinicial>inicio</blocoinicial>.

16

14

blocofinal

Bloco de finalização de uma expressão.

C

S

1

Identifica o final de um bloco ou sub-bloco de pesquisa, seria o mesmo que um sinal de fechar parênteses em uma expressão matemática. Exemplo: <blocofinal>final</blocofinal>.

17

14

operacaologica

Identifica a operação lógica a ser executada.

N

S

1

1

Identifica uma operação lógica do produto, esta operação pode ser uma conotação booleana de E, OU ou de negação. Pode assumir os seguintes valores: 1 = E; 2 = OU; 3 = Negação. Exemplo: <operacaologica>1</operacaologica.>

18

14

campo

Campo filtro de pesquisa.

G

S

1

Os campos têm obrigatoriamente um nome e também valores de filtros. As duas possibilidades de filtro e de nome podem ser feitas através de valor ou intervalo de valores.

19

18

nome

Nome do campo de filtro.

C

N

1

1..n

Possíveis nomes de campos:
 
• Para NF-e
o SERIE – série da nota;
o NUMERONFE – número da nota;
o DATAEMISSAO – data de emissão da nota conforme  formato utilizado pelo SGBD;
o CNPJEMITENTE – CNPJ do emitente;
o CNPJDESTINATARIO – cnpj do destinatário;
o CPFDESTINATARIO - CPF do destinatário.
 
• Para CT-e
o SERIE – série do conhecimento;
o NUMEROCTE – número do conhecimento;
o DATAEMISSAO – data de emissão do conhecimento conforme o formato utilizado pelo SGBD;
o CNPJEMITENTE – CPF do emitente;
o CNPJREMETENTE – CNPJ do remetente
o CPFREMETENTE – CPF do remetente
o CNPJEXPEDIDOR – CNPJ do expedidor;
o CPFEXPEDIDOR – CPF do expedidor;
o CNPJRECEBEDOR – CNPJ do recebedor;
o CPFRECEBEDOR – CPF do recebedor;
o CNPJDESTINATARIO – CNPJ do destinatário;
o CPFDESTINATARIO – CPF do destinatário;
o CNPJTOMADOR – CNPJ do tomador do serviço;
o CPFTOMADOR – CPF do tomador do serviço.

• Para MDF-e

o SERIE – série do manifesto;

o NUMEROMDFE – número do manifesto;

o DATAEMISSAO – data de emissão do manifesto;

o CNPJEMITENTE – CPF do emitente.

• Para CT-eOS

o SERIE – série do conhecimento;

o NUMEROCTEOS – número do conhecimento;

o DATAEMISSAO – data de emissão do conhecimento conforme o formato utilizado pelo SGBD;

o CNPJEMITENTE – CPF do emitente;

o CNPJTOMADOR – CNPJ do tomador do serviço;

o CPFTOMADOR – CPF do tomador do serviço.

20

18

valor

Valor do filtro a ser aplicado.

G

S

1

1

O valor do filtro indica que será feita uma comparação direta. Exemplo SERIE = 1.

21

20

conteudo

Conteúdo do campo que será utilizado no filtro.

C

S

1

1..n

22

20

parcial

Define busca parcial sobre o campo.

N

N

1

1

Indica para campos alfanuméricos se o conteúdo é uma parte do todo. Se for 1 ele busca parcialmente, caso contrário, deve ser idêntico.

23

18

intervalo

Intervalo fechado de valores.

G

S

1

1

Intervalo fechado de valores a serem filtrados. Exemplo SERIE >= 1 E SERIE <= 1000.

24

23

inicial

Valor inicial do filtro.

C

S

1

1..n

Valor inicial do filtro.

25

23

final

Valor final do filtro.

C

S

1

1..n

Valor final do filtro.