Métodos
Esta interface disponibiliza os seguintes métodos:
Busca de documentos baseando-se no filtro. O código a ser informado é o código de um movimento e o processo deve indicar de onde esta movimentação pertence. Este método aceita requisições via WEB API.
DocumentoGED[] BuscarVinculosDocByOrigem(Login login, FiltroDocumentoGED filtro);
Gera um token que pode ser utilizado para realizar o download de documentos. O token possui duração de 1 (um) minuto. Este método aceita requisições via WEB API.
string BuscarTokenDocGED(Login login, string codigoDocumento, string nomeDocumento);
Realiza o download de um documento com base em um token. Este método aceita requisições via WEB API.
Stream DownloadFile(string token);
Realiza o upload de vários documentos para o Radar GED. O documento deve ser enviado através do NomeDocumento, informando o caminho e o nome do arquivo já existente. É obrigatório que seja enviado um vínculo, ao qual o documento será vinculado, que já deverá estar cadastrado no sistema Radar. Este método aceita requisições via WEB API.
void UploadDocumentos(Empresarial.Login login, Documento[] documentos);
Busca de Tipos de Documentos Digitais baseando-se no filtro. Quando o código for informado, irá buscar apenas o Tipo de Documento Digital com o respectivo código, ignorando demais informações enviadas no filtro. Para realizar busca de todos os processos informe no processo o valor “GD_PROCESSO_NENHUM”. Este método aceita requisições via WEB API.
TipoDocumentoDigital[] BuscarTiposDocumentosDigitais(Login login, FiltroTipoDocumentoDigital filtro);
Remove um vínculo existente em um documento existente no Cadastro de Documentos Digitais. void RemoverVinculoDocumento(Login login, RemoverVinculoDocumentoParam dados);
[BuscaRapida]
public DadosDocumentoGED[] BuscaRapida(Empresarial.Login login, FiltroBuscaRapida filtro);
Possibilita retornar os documentos digitais que possuem em seus atributos uma informação, (string) passada no filtro. Além da string de pesquisa o filtro possibilita informar uma data inicial e uma data final, além do tipo de data que pode ser emissão ou validade.
login - Informações de login. Um objeto composto pelos seguintes atributos: Usuario : string;
Senha : string; Base : string; Guid : string.
filtro - Filtro para a pesquisa. Um objeto composto pelos seguintes atributos:
Pesquisa : string - A informação que será buscada em todos os atributos dos documentos digitais armazenados;
TipoData : number - Objeto que representa o tipo de data que será filtrado pelos atributos DataInicial e DataFinal, podendo ser EMISSÃO (0) ou VALIDADE (1);
DataInicial : string - Data inicial da busca no formato ‘dd/MM/yyyy; DataFinal : string - Data final da busca no formato ‘dd/MM/yyyy.
Retorno:
Vetor composto pelos dados dos documentos retornados pela busca. TipoDocumento : string; Codigo : string; Descricao : string; NomeDocumento - string; DataEmissao : string; DataValidade : string; AcessoWeb : boolean. [BuscarDocumentosDigitais]
public DadosDocumentoGED[] BuscarDocumentosDigitais(Empresarial.Login login, FiltroDocumentoGED filtro);
Retorna os documentos digitais armazenados que atendem ao filtro informado. Parâmetros:
login - Informações de login. Um objeto composto pelos seguintes atributos: Usuario : string;
Senha : string; Base : string; Guid : string.
filtro - Filtro para a pesquisa. Um objeto composto pelos seguintes atributos:
DataEmissao : string - Data de emissão do documento digital no formato ‘dd/MM/yyyy’;
CodigoTipoDocumento : string - Código do registro de acordo com o cadastro de Tipos de Documentos Digitais.
Retorno: Vetor composto pelos dados dos documentos retornados pela busca. TipoDocumento : string; Codigo : string; Descricao : string; NomeDocumento : string; DataEmissao : string; DataValidade : string; AcessoWeb : boolean. [ExcluirDocumento]
Exclui um documento digital salvo. Parâmetros:
login - Informações de login. Um objeto composto pelos seguintes atributos: Usuario : string;
Senha : string; Base : string; Guid : string.
codigoDocumento - Código do documento que será excluído.
[BuscarVinculosDoc]
public VinculoDocumento[] BuscarVinculosDoc(Empresarial.Login login, string codigoDocumento); Retorna as informações de vínculo de um documento digital.
Parâmetros:
login - Informações de login. Um objeto composto pelos seguintes atributos: Usuario : string;
Senha : string; Base : string; Guid : string.
codigoDocumento - Código do documento buscado. Retorno:
Informação de vínculo do documento digital.
Processo : number - Processo vinculado. Ver Enumeração ProcessoGED. Codigo : string - Código, chave do vínculo.
Enumerações
Para as enumerações, o primeiro valor apresentado pode ser considerado o valor padrão quando associado a um campo nas classes.
Enumeração ProcessoGED
SOAP
JSON
GD_PROCESSO_NENHUM = -1
-1
GD_PROCESSO_FN_CRE_LANC = 2
2
GD_PROCESSO_FN_CRE_BX = 3
3
GD_PROCESSO_FN_CPA_LANC = 7
7
GD_PROCESSO_FN_CPA_BX = 8
8
GD_PROCESSO_CM_RE = 11
11
GD_PROCESSO_FN_TES = 13
13
GD_PROCESSO_GE_AST = 18
18
GD_PROCESSO_CM_OC = 23
23
GD_PROCESSO_CQ_RG = 27
27
GD_PROCESSO_CQ_MET = 29
29
GD_PROCESSO_CQ_CTRL = 30
30
GD_PROCESSO_CQ_RTC = 31
31
GD_PROCESSO_CQ_ACT = 33
33
GD_PROCESSO_CQ_AAC = 34
34
GD_PROCESSO_CQ_APA = 35
35
GD_PROCESSO_CQ_ROT = 36
36
GD_PROCESSO_CQ_OBJ = 37
37
GD_PROCESSO_CQ_DOC = 38
38
GD_PROCESSO_CQ_TPA = 43
43
GD_PROCESSO_CQ_ATR = 44
44
GD_PROCESSO_CQ_REQ = 45
45
GD_PROCESSO_CQ_TPC = 46
46
GD_PROCESSO_CQ_PRV = 47
47
GD_PROCESSO_CQ_NCO = 48
48
GD_PROCESSO_CQ_ACO = 49
49
GD_PROCESSO_CQ_ANC = 50
50
GD_PROCESSO_CQ_ART = 51
51
GD_PROCESSO_CQ_FSE = 52
52
GD_PROCESSO_CQ_RMQ = 58
58
GD_PROCESSO_FN_ADT = 62
62
Enumeração TipoCampoGED SOAP JSON
DiaMesAno = 1 1
MesAno = 2 2
Texto = 3 3
ValorNumericoDoisDecimais = 5 5 ValorNumericoQuatroDecimais = 6 6 ValorNumericoOitoDecimais = 7 7 ClienteFornecedor = 8 8 NumeroNotaFiscal = 9 9 ValorTotalNotaFiscal = 10 10 Filial = 11 11 Financeiro_DataVencimento = 12 12 Financeiro_DataEmissao = 13 13 DataEntradaSaida = 14 14 Financeiro_NumeroDocumento = 15 15 Financeiro_Documento = 16 16 Financeiro_ValorTitulo = 17 17 Financeiro_Historico = 18 18 Financeiro_Filial = 19 19 Financeiro_ContaBanco = 20 20 Financeiro_FormaPagamento = 21 21 Financeiro_NumeroCheque = 22 22 Financeiro_DataBaixa = 23 23 Financeiro_Disponibilidade = 24 24 Financeiro_ValorBaixado = 25 25 Financeiro_ValorRecebido = 26 26 Financeiro_NumeroRecibo = 27 27 NaturezaOperacao = 28 28 SituacaoServico = 29 29 Transportadora = 30 30 ValorTotalProduto = 31 31 ValorTotalServico = 32 32 Comercial_Vendedor = 33 33
Comercial_Representante = 34 34 Gerenciador_ProtocoloSaida_Destinatario = 35 35 Gerenciador_ProtocoloSaida_AosCuidadosDe = 36 36 Gerenciador_ProtocoloSaida_EntreguePara = 37 37 Gerenciador_ProtocoloSaida_DataEntrega = 38 38 Gerenciador_ProtocoloSaida_HoraEntrega = 39 39 Gerenciador_ProtocoloSaida_Preparador = 40 40 Gerenciador_ProtocoloSaida_Conferente = 41 41 Gerenciador_ProtocoloSaida_Entregador = 42 42 Gerenciador_Contrato_Cliente = 43 43 Gerenciador_Contrato_Numero = 44 44 Gerenciador_Contrato_Codigo = 45 45 Gerenciador_Contrato_Descricao = 46 46 Gerenciador_AtendimentoTecnico_Cliente = 47 47 Gerenciador_AtendimentoTecnico_Numero = 48 48 Gerenciador_AtendimentoTecnico_DataEmissao = 49 49 Gerenciador_ProtocoloEntrada_Cliente = 50 50 Gerenciador_ProtocoloEntrada_Portador = 51 51 Gerenciador_ProtocoloEntrada_EntregarPara = 52 52 Gerenciador_ProtocoloEntrada_RecebidoPor = 53 53 Gerenciador_AssistenciaTecnica_Cliente = 54 54 Gerenciador_AssistenciaTecnica_Equipamento = 55 55 Gerenciador_AcompanhamentoServico_Cliente = 56 56 Gerenciador_AcompanhamentoServico_Numero = 57 57 Financeiro_ContasReceber_NossoNumero = 58 58 Financeiro_ContasPagar_CodigoBarras = 59 59 Comercial_NotaFiscal_Chave = 60 60 Comercial_Pedido_Numero = 61 61 Comercial_Pedido_Codigo = 62 62
Comercial_Pedido_ValorTotal = 63 63 Compras_RegistroEntrada_Codigo = 64 64 Compras_ConhecimentoTransporte_Codigo = 65 65 Compras_ConhecimentoTransporte_NumeroFatura = 66 66 Financeiro_Tesouraria_ContaEntrada = 67 67 Financeiro_Tesouraria_ContaSaida = 68 68 Compras_GerenciamentoContrato_CodigoContrato = 69 69 Compras_GerenciamentoContrato_NumeroContrato = 70 70 Compras_GerenciamentoContrato_Referencia = 71 71 Estoque_RequisicaoInterna_Codigo = 72 72 Estoque_RequisicaoInterna_Numero = 73 73 Compras_Cotacao_Codigo = 74 74 Compras_Cotacao_Numero = 75 75 Rvi_ChaveAcesso = 76 76 Rvi_CodigoRVI = 77 77 Rvi_Emitente = 78 78 Rvi_Destinatario = 79 79 Compras_OrdemCompra_Numero = 80 80 Compras_OrdemCompra_Codigo = 81 81 Compras_OrdemCompra_DataEmissao = 82 82 Compras_OrdemCompra_Fornecedor = 83 83 Compras_OrdemCompra_Comprador = 84 84 Fiscal_NaturezaOperacao = 85 85 Fiscal_ModeloDocumento = 86 86 Fiscal_Serie = 87 87 Fiscal_NumeroNota = 88 88 Fiscal_DataEntrada = 89 89 Fiscal_DataEmissao = 90 90 Fiscal_ValorTotal = 91 91
Comercial_AgendamentoVisita_Numero = 92 92 Comercial_AgendamentoVisita_Cliente = 93 93 Comercial_AgendamentoVisita_SituacaoVisita = 94 94 Comercial_AgendamentoVisita_AtendidoPor = 95 95 Comercial_AgendamentoVisita_Contato = 96 96 Comercial_AgendamentoVisita_SituacaoVenda = 97 97 Comercial_AgendamentoVisita_ValorVenda = 98 98 Compras_SolicitacaoCompra_Codigo = 99 99 Compras_SolicitacaoCompra_Requisitante = 100 100 Compras_SolicitacaoCompra_Departamento = 101 101 Compras_SolicitacaoCompra_Comprador = 102 102 Orcamento_ContaGerencial 103 Orcamento_ContaContabil 104 Orcamento_MesAno 105 InfoComplementar 106
Classes
A seguir serão apresentadas as classes contidas nesta interface.
Classe Documento
1 CodigoTipoDocumento String Código do registro de acordo com o cadastro de Tipos de Documentos Digitais 2 NomeDocumento String Nome do documento já existente,
juntamente com o caminho que deseja integrar no GED
3 Base64String String Dados do arquivo no formado texto Base64
4 CodigoFilial String Código da filial do Registro de Documento Digital
5 DataEmissao String Data de emissão (no formato
‘dd/MM/yyyy’) do Registro de Documento Digital
6 Descricao String Descrição do Registro de Documento Digital
7 Vinculos VinculoDocumento[] Lista de vínculos do Registro de Documento Digital
Classe VinculoDocumento
1 Processo ProcessoGED Tipo de processo
2 Codigo String Código\Chave do processo
Classe FiltroDocumentoGED
1 Codigo String Código do registro vinculado ao GED
2
Processos ProcessoGED
Processo ao qual está vinculado o registro
3
SubProcessos ProcessoGED[]
Sub-Processos que estão vinculados ao registro
4
BuscarCamposGED Bool
Especifica se deve buscar as informações complementares do documento
Classe DocumentoGED
1 Codigo String Código do documento
2 DataEmissao string Data de emissão do documento 3 Descricao String Descrição do documento
4 Nome String Nome do documento
5 TipoDocumento TipoDocumentoDigital Informações sobre o tipo do documento
6
CamposGED CampoDocumentoGED[]
Lista de campos personalizados, esta informação só será preenchida caso no filtro seja enviado "BuscarCamposGED" como "true"
Classe TipoDocumentoDigital
2
Nome String Nome do Tipo de Documento Digital3
Campos CampoDocumentoGED[]
Lista de campos personalizados, cadastrados na aba "Critérios Busca"
Classe CampoDocumentoGED
1 Tipo TipoCampoGED Tipo do valor do campo
2
Valor String Valor do campo3
Nome String
Nome de exibição do campo (Somente para leitura)
4
Obrigatorio Bool
Especifíca se é uma informação obrigatória para a inclusão de um documento digital (Somenta para leitura)
5
CodigoInfoComplementar String
Código do Grupo utilizado pelo campo “Info. Complementar”. (Somente para leitura).
Classe VinculoDocumentoGED
1 Processo ProcessoGED Processo ao qual o código pertente
2
Codigo String Código do registroClasse UploadDocumentoGED
1 Base64String String
Arquivo em uma string em formato Base64
2
NomeArquivo String Nome do arquivo3
CodigoTipoDocumento String Código do Tipo de Documento Digital4
DataEmissao String Data de emissão do documento5
DataValidade String Data de validade do documento6
CodigoLocalArquivamento String Código do Local de Arquivamento7
CodigosUsuarios String[]
Lista de códigos de usuário que podem acessar o documento
8
CodigoFilial String Código da filial10
AcessoWeb Bool
Indica se o documento pode ser acessado pelo Radar Web
11
NumeroLocalizacao String Número de localização do documento12
AutoIncrementarNumeroLocalizacao Bool
Indica se o NumeroLocalizacao deve ser gerado pelo sistema de acordo com a propriedade do Radar GED
13
VersaoInicialDocumento String Versão inicial do documento14
Descricao String Descrição do documento15
Vinculo VinculoDocumentoGED
Informações do registro ao qual o documento será vinculado
16
CamposGED CampoDocumentoGED[]
Informações complementares de acordo com o Tipo de Documento Digital
Classe FiltroTipoDocumentoDigital
1 Codigo String
Código do Tipo de Documento Digital (Caso esta informação seja enviada, as outras serão ignoradas)
2
Processo ProcessoGED
Processo do Radar Empresarial, para que este campo não seja considerado no filtro, informar
GD_PROCESSO_NENHUM (-1)
Classe RemoverVinculoDocumentoParam 1 CodigoDocumento String
Código do Documento que possui o vínculo a ser removido