Métodos
Esta interface disponibiliza os seguintes métodos:
Busca de título a pagar baseando-se no filtro. Somente será retornado o Detalhamento do título caso no filtro esteja definida a variável “BuscarDetalhes”, caso contrário esta informação virá vazia. O filtro por data será aplicado na data de vencimento do título. Este método aceita requisições via WEB API.
TituloPagar[] BuscarTitulos(Login login, FiltroTitulosPagar filtro);
Altera o estado da autorização de pagamento dos títulos a pagar informados, definindo a assinatura deles para o valor informado em “Acao”. Este valor será aplicado somente para a assinatura do usuário enviado em “login”. Este método aceita requisições via WEB API.
Void AlterarAutorizacaoPagamento(Login login, AlterarAutorizacaoPagamentoParam dados);
Busca as informações referentes a posição financeiro do cliente informado no filtro. Este método aceita requisições via WEB API.
PosicaoFinanceira BuscarPosicaoFinanceira(Login login, FiltroPosicaoFinanceira filtro);
Busca as informações referentes ao saldo bancário das contas bancárias de acordo com o filtro. Este método aceita requisições via WEB API.
SaldoContaBancaria[] BuscarSaldoContasBancarias(Login login, FiltroSaldoContasBancarias filtro);
Faz a gravação de um lançamento de contas a receber ou pagar. Este método aceita requisições via WEB API.
LancamentoContaReceberPagar GravarLancamentoContaReceberPagar (Login login, LancamentoContaReceberPagar nformaçõe);
Faz a gravação de uma lista de lançamentos de contas a receber ou pagar. O método retorna uma lista dos objetos gravados, caso algum registro esteja inválido para a gravação, o mesmo não será gravado e no seu respectivo retorno conterá uma lista com o nome “RadarWebDotNetWCFFault” contendo os erros gerados por eles. Este método aceita requisições via WEB API.
LancamentoContaReceberPagar [] GravarLancamentosContasReceberPagar (Login login, LancamentoContaReceberPagar[] nformações);
Busca as informações referentes ao saldo a receber dos clientes conforme registros de contas a receber. Este método aceita requisições via WEB API.
TotalizacaoContaReceber[] BuscarTotalizacoesContasReceber(Login login, FiltroTotalizacaoContaReceber filtro);
Busca as informações referentes ao saldo a pagar aos fornecedores conforme registros de contas a pagar. Este método aceita requisições via WEB API.
TotalizacaoContaPagar[] BuscarTotalizacoesContasPagar(Login login, FiltroTotalizacaoContaPagar filtro);
Busca um resumo da quantidade de títulos a pagar registrados na base de dados de acordo com o filtro. Este método aceita requisições via WEB API.
ResumoMovimentacoesTitulosPagar BuscarResumoMovimentacoesTitulosPagar(Login login, FiltroResumoMovimentacoesTitulosPagar filtro);
Busca as informações referentes aos títulos de contas a pagar e receber de acordo com o filtro. Este método aceita requisições via WEB API.
LancamentoContaReceberPagar[] BuscarLancamentosContaReceberPagar(Login login, FiltroLancamentoContaReceberPagar filtro)
Busca as informações referentes as baixas de títulos de contas a pagar e receber de acordo com o filtro. Este método aceita requisições via WEB API.
BaixaContaReceberPagar[] BuscarBaixasContaReceberPagar(Empresarial.Login login, FiltroBaixaContaReceberPagar filtro)
Gera tokens que podem ser utilizados para realizar o download de boletos de cobrança. Os tokens possuem duração de 1 (um) minuto. Este método aceita requisições via WEB API.
String[ ] BuscarTokenBoleto(Empresarial.Login login, FiltroCobrancaContaReceber filtro);
Realiza o download de um documento com base em um token. Este método aceita requisições via WEB API.
Stream DownloadBoleto(string token);
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 TipoAutorizacaoTituloPagar SOAP JSON
NENHUM = 0 0 PENDENTES = 1 1 AUTORIZADOS = 2 2 MINHA_AUTORIZACAO_PENDENTE = 4 4 VETADOS = 8 8 MINHA_AUTORIZACAO_EFETUADA = 16 16 MINHA_AUTORIZACAO_VETADA = 32 32
Enumeração SituacaoAutorizacao SOAP JSON
AUTORIZADO = 1 1 AUTORIZADO_NO_VENCIMENTO = 2 2 AUTORIZADO_NA_DATA_INFORMADA = 3 3
VETADO = 4 4
Enumeração
StatusGravacaoLancamentoContaReceberPagar SOAP JSON
SUCESSO = 0 0
ERRO = 1 1
Enumeração TipoContaReceberPagar SOAP JSON
RECEBER = 0 0
PAGAR = 1 1
TODOS = 2 2
Enumeração TipoDataFiltroContaReceberPagar SOAP JSON
EMISSAO = 0 0
VENCIMENTO = 1 1
Enumeração TipoPeriodoTotalizacaoContaReceberPagar SOAP JSON
EMISSAO = 0 0
VENCIMENTO = 1 1
Enumeração TipoNaturezaTotalizacaoContaReceberPagar SOAP JSON
TODOS = 0 0
EFETIVOS = 1 1
PREVISOES = 2 2
Enumeração SituacaoTituloContaReceberPagar SOAP JSON
TODOS = 0 0
EM_ABERTO = 1 1
VENCIDO = 2 2
RECEBIDO_PAGO = 3 3
Classes
A seguir serão apresentadas as classes contidas nesta interface.
Classe FiltroTitulosPagar
1 Codigo String
Código do Título a Pagar para Filtro de Título
2
DataInicial String
Busca somente os títulos com data de vencimento a partir da Data (no formato ‘dd/MM/yyyy’) informada
3
DataFinal String
Busca somente os títulos com data de vencimento inferior a Data (no formato ‘dd/MM/yyyy’) informada
4
Cedente String
Código do Cedente para Filtro de Título
5
Tipo TipoAutorizacaoTituloPagar
Tipo da situação de autorização de pagamento do título
6
BuscarDetalhes Bool
Indicação de aquisição dos detalhes referentes ao títulos retornados
7 ControlePaginacao ControlePaginacao Informações da pagina desejada 8
BuscarInformacaoGED Bool
Indicação de aquisição da informação “PossuiDocumentoGED”
Classe TituloPagar
1 Codigo String Código do Título a Pagar
2
DataEmissao String
Data de Emissão do Título (no formato ‘dd/MM/yyyy’)
3
SituacaoAutorizacao SituacaoAutorizacao
Situação da autorização de pagamento do título
4 CodigoFornecedor String Código do Fornecedor 5 NomeFornecedor String Nome do Fornecedor 6
DataVencimento String
Data de Vencimento do Título (no formato ‘dd/MM/yyyy’)
7
Documento String Número de Documento do Título
8 Valor Decimal Valor do Título
9
Detalhes DetalhesTituloPagar
Detalhes do título a pagar, esta
informação só será preenchida caso no filtro seja enviado “BuscarDetalhes” como “true”
10
PossuiDocumentoGED Bool
Indicação que o título possui
documentos vinculados no GED, esta informação só será preenchida caso no filtro seja enviado
“BuscarInformacaoGED” como “true” Classe DetalhesTituloPagar
1 DataVencimentoEfetivo String
Data de Vencimento Efetivo do Título (no formato ‘dd/MM/yyyy’)
2
ContasGerencial Conta[] Lista de Contas Gerencial do título
3
DataTerminoDesconto String
Data de Término do Desconto do Título (no formato ‘dd/MM/yyyy’)
4 ValorMulta Decimal Valor da multa do título 5
CobrancaApresentada Bool
Indica se já foi apresentada cobrança do título
6
TipoCobranca TipoCobranca
Informações do Tipo de Cobrança do título
7 Filial Filial Informações da Filial do Título
8
ContasContabil Conta[] Lista de Contas Contábil do título
9 Historico String Histórico do título
10 ValorDesconto Decimal Valor de desconto de título 11 ValorDiarioJuros Decimal Valor diário de juros do título 12
DataInicioMulta String
Data de Início da Multa do Título (no formato ‘dd/MM/yyyy’)
13
Portador Portador Informações do Portador do título
14
FormaPagamento FormaPagamento
Informações da Forma de Pagamento do título
15
Autorizacoes AutorizacaoPagamentoTitulo[]
Lista de assinaturas de autorização do título
Classe AutorizacaoPagamentoTitulo
1 Usuario Usuario
Informações do usuário responsável pela assinatura da autorização
2
DataAssinatura String
Data da assinatura da autorização (no formato ‘dd/MM/yyyy’)
3
HoraAssinatura String
Hora da assinatura da autorização (no formato ‘hh:mm’)
4
SituacaoAutorizacao SituacaoAutorizacao Situação da autorização da assinatura
5
DataAutorizar String
Data para autorização da assinatura (no formato ‘dd/MM/yyyy’)
Classe AlterarAutorizacaoPagamentoParam 1 Codigos String[]
Lista de códigos dos títulos que devem se alterados
2
Acao SituacaoAutorizacao
Situação de autorização para qual será alterada os títulos
3
DataAutorizacao String
Data para autorização da assinatura (no formato ‘dd/MM/yyyy’), só será utilizado caso a ‘Acao’ seja
AUTORIZADO_NA_DATA_INFORMADA Classe FiltroPosicaoFinanceira
1 Codigo String Código da conta.
2
DataInicial String
Busca somente os valores relacionados aos movimentos
efetuados a partir da Data (no formato ‘dd/MM/yyyy’) informada
3
DataFinal String
Busca somente os valores relacionados aos movimentos efetuados antes da Data (no formato ‘dd/MM/yyyy’) informada
4
ConsiderarFiliais Bool
Indicação para o sistema considerar todas as filiais com o mesmo CNPJ da empresa
5
ConsiderarEmpresas Bool
Indicação que o tratamento do crédito será feito de acordo com o campo “Empresa Grupo” no cadastro de clientes
6
ConsiderarTitulos Bool
Indicação que o sistema irá considerar os dados dos títulos substituídos ao invés dos dados substitutos
7
ConsiderarData Bool
Indicação que o sistema utilizará a data de baixa para realizar os cálculos de atraso.
Classe PosicaoFinanceira
1 CnpjCpf String CNPJ/CPF da conta
2 InscricaoEstadual String Inscrição estadual da conta 3 Contato String Nome do contato da conta
4 Telefone String Telefone da conta
5 Email String E-mail do contato da conta 6 CodigoConta String Código da conta
7 NomeConta String Nome da conta
8 Categoria1Legenda String Nome da categoria 1 da conta 9 Categoria2Legenda String Nome da categoria 2 da conta 10 Categoria3Legenda String Nome da categoria 3 da conta 11
Categoria1Descricao String Descrição da categoria 1 da conta
12
13
Categoria3Descricao String Descrição da categoria 3 da conta
14 Endereco String Endereço da conta
15 EnderecoNumero String Número do endereço da conta 16
EnderecoComplemento String Complemento do endereço da conta
17 Bairro String Bairro da conta
18 Municipio String Município da conta
19 UF String UF da conta
20 CEP String CEP da conta
21
DataLimite String Data limite para o crédito da conta
22
ValorCreditoUtilizado Decimal Valor de crédito utilizado da conta
23
ValorAdiantamentos Decimal Valor de adiantamentos da conta
24 ValorPedidos Decimal Valor dos pedidos da conta 25
ValorChequesPreDatados Decimal
Valor dos cheques pré datados da conta
26
ValorCreditoDisponivel Decimal Valor de crédito disponível da conta
27
VendaBloqueada Bool
Indica se a conta está autorizada ou bloqueada para venda.
28 ValorSaldoAVencer Decimal Valor de saldo a vencer da conta
29 ValorMaiorAcumulo Decimal Valor maior acumulo da conta 30 DataMaiorAcumulo String Data do maior acumulo da conta 31
PrazoMedioFaturamento Uint
Prazo médio do faturamento da conta (em dias)
32 ValorSaldoVencido Decimal Valor do saldo vencido da conta 33
MediaAtraso Uint Média de atraso da conta (em dias)
34
MediaAtrasoPonderada Uint
Média de atraso ponderada da conta (em dias)
35
ValorIndiceAtrasoPonderado Decimal
Valor do índice de atraso ponderado da conta (em %)
36 ValorMaiorAtraso Decimal Valor maior atraso da conta 37
QtdeMaiorAtraso Uint
Quantidade de dias do maior atraso da conta
38
ValorChequesDevolvidos Decimal Valor dos cheques devolvidos da conta
39
QtdeBaixasPorInadimplencia Uint
Quantidade de baixas por inadimplência da conta
40
ValorBaixasPorInadimplencia Decimal
Valor total das baixas por inadimplência da conta
41 ValorLimiteSerasa Decimal Valor limite Serasa da conta 42 DescricaoSituacao String Situação da conta
43 DataSituacao String Data da situação da conta 44 ValorMaiorFatura Decimal Valor da maior fatura da conta 45 DataMaiorFatura String Data da maior fatura da conta 46 ValorUltimaFatura Decimal Valor da última fatura da conta
47 DataUltimaFatura String Data da última fatura da conta 48
FrequenciaMediaCompra Uint
Frequência média de compra da conta (em dias)
49
ValorMedioDeCompra Decimal Valor média de compras da conta
50 ValorTotalDeCompras Decimal Valor total de compras da conta
51
DataTotalDeCompras String
Data da última compra efetuado por esta conta no período do filtro
52 ValorMaiorRisco Decimal Valor maior risco da conta 53 DataMaiorRisco String Data de maior risco da conta 54
ValorAcumuloCompras180Dias Decimal
Valor acumulado das compras da conta nos últimos 180 dias do período informado no filtro
55
ValorComprasNoMes Decimal
Valor das compras da conta no último mês do período informado no filtro
56 ValorLimite Decimal Valor Limite da conta 57 DataClienteDesde String Data de cadastro do cliente
Classe FiltroSaldoContasBancarias
1 DataInicial String
Busca somente os valores relacionados aos movimentos
efetuados a partir da Data (no formato ‘dd/MM/yyyy’) informada
2
DataFinal String
Busca somente os valores relacionados aos movimentos efetuados antes da Data (no formato ‘dd/MM/yyyy’) informada
3
IncluirContasInativas Bool
Indicação de informações de contas marcadas como “Inativas”
Classe SaldoContaBancaria
1 Codigo String Código da conta
2 Classificacao String Classificação da conta 3 ContaCorrente String Número da conta corrente 4 NomeFantasia String Nome Fantasia da conta
5 Nome String Nome da conta
6 NumeroBanco String Número do banco da conta 7 NumeroAgencia String Número da agência da conta 8
Entrada Decimal Valor das entradas para esta conta
9 IsContaTitulo Bool Indicação se é uma conta título 10 Limite Decimal Valor limite para esta conta
11 Saida Decimal Valor das saídas para esta conta 12 SaldoDisponivel Decimal Saldo disponível para esta conta 13 SaldoInicial Decimal Saldo inicial para esta conta 14 SaldoTotal Decimal Saldo total para esta conta
Classe FiltroLancamentoContaReceberPagar
1 Tipo TipoContaReceberPagar Informação do tipo de conta do título 2 CodigoInicial String
Código Inicial do Título para Filtro de Título
3 CodigoFinal String
Código Final do Título para Filtro de Título
4 CodigoSacadoCedente String
Código do Sacado/Cedente para Filtro de Título
5 CPF_CNPJ_SacadoCedente String
CPF ou CNPJ do Sacado/Cedente do título
6 DataInicial String
Busca somente os títulos com data de emissão/vencimento a partir da Data (no formato ‘dd/MM/yyyy’) informada
7 DataFinal String
Busca somente os títulos com data de emissão/vencimento inferior a Data (no formato ‘dd/MM/yyyy’) informada 8 TipoData TipoDataFiltroContaReceberPagar Informação do tipo de data do filtro
9 SituacaoTitulo SituacaoTituloContaReceberPagar
Situação dos títulos que serão filtrados, podendo ser: Em Aberto, Vencidos, Recebidos/Pagos ou todos. Classe LancamentoContaReceberPagar
1 Tipo TipoContaReceberPagar Informação do tipo de conta do título
2 Codigo String Código do título
3 CodigoFilial String Código da filial
4
DataEmissao String
Data de emissão do título (no formato ‘dd/MM/yyyy’)
5
DataVencimento String
Data de vencimento do título (no formato ‘dd/MM/yyyy’)
6
Receber_PagarEm String
Data de Receber/Pagar Em do título (no formato ‘dd/MM/yyyy’)
7
CodigoClienteSacado String
Código do cliente (este campo só será utilizado caso o campo
“CPF_CNPJ_ClienteSacado” está inválido.
9 NumeroDocumento String Número do documento 10 CodigoDocumento String Código do documento
11 ValorTitulo String Valor do título
12 ComplementoHistorico String Complemento do histórico
13 NossoNumero String “Nosso Número”
14 CodigoGradeContabil String Código da grade contábil 15 CodigoPortador String Código do portador
16 CodigoTipoCobranca String Código do tipo de cobrança
17 ValorJuros String Valor de juros do título 18 ValorMulta String Valor da multa do título 19 ValorDesconto String Valor de desconto do título 20
Rateios RateioEmpresarial[]
Lista dos rateios do título (as nformações contidas em
“RateiosGerenciais” serão ignoradas)
21
RadarWebDotNetWCFFault RadarWebDotNetWCFFault[]
Lista de retorno de inconsistências na gravação (usado somente para retorno de erros).
Classe FiltroBaixaContaReceberPagar
1 Tipo TipoContaReceberPagar Informação do tipo de conta do título 2 CodigoInicial String
Código Inicial do Título para Filtro de Baixa
3 CodigoFinal String
Código Final do Título para Filtro de Baixa
4 CodigoSacadoCedente String
Código do Sacado/Cedente para Filtro de Baixa
5 CPF_CNPJ_SacadoCedente String
CPF ou CNPJ do Sacado/Cedente do título
6 DataInicial String
Busca somente os títulos com data de emissão/vencimento a partir da Data (no formato ‘dd/MM/yyyy’) informada
7 DataFinal String
Busca somente os títulos com data de emissão/vencimento inferior a Data (no formato ‘dd/MM/yyyy’) informada 8 TipoData TipoDataFiltroContaReceberPagar Informação do tipo de data do filtro 9 BuscarSubstituicoes Bool
Determina se deve buscar as substituições.
Classe SubstituicaoBaixaContaReceberPagar
1 Codigo String Chave da substituição
2 TipoDocumento String Tipo de documento da substituição 3 NumeroDocumento String
Numero do documento da substituição
Classe BaixaContaReceberPagar
1 Tipo TipoContaReceberPagar Informação do tipo de conta do título 2 FormaPagamento FormaPagamento
Informações da Forma de Pagamento do título
‘dd/MM/yyyy’)
4 ValorBaixado String Valor baixado
5 ValorJuros String
Valor de juros baixados (recebidos/pagos) 6 ValorMulta String
Valor de multa baixada (recebida/pago)
7 ValorDesconto String
Valor desconto baixado (concedido/obtido)
8 Outros3 String Valor Outros3 da baixa
9 Outros4 String Valor Outros4 da baixa
10 CodigoBanco String Codigo do banco da baixa
11 Total String Valor total da baixa
12 Substituicao SubstituicaoBaixaContaReceberPagar[] Lista com os dados das substituições Classe FiltroTotalizacaoContaReceber
1 DataInicial String
Busca somente os valores relacionados aos movimentos
efetuados a partir da Data (no formato ‘dd/MM/yyyy’) informada
2
DataFinal String
Busca somente os valores relacionados aos movimentos efetuados antes da Data (no formato 'dd/MM/yyyy') informada
3
TipoPeriodo TipoPeriodoTotalizacaoContaReceberPagar
Tipo do período a ser considerado para a pesquisa
4
TipoNatureza
TipoNaturezaTotalizacaoContaReceberPaga r
Tipo da natureza a ser considerada para a pesquisa
5
CodigosClientes String[]
Lista com o código dos clientes a serem considerados na pesquisa Classe TotalizacaoContaReceber
1 Total String Valor total a receber do cliente
2 CodigoCliente String Código do cliente
3 NomeCliente String Nome do cliente
Classe FiltroTotalizacaoContaPagar
1 DataInicial String
Busca somente os valores relacionados aos movimentos
efetuados a partir da Data (no formato 'dd/MM/yyyy') informada
2
DataFinal String
Busca somente os valores relacionados aos movimentos efetuados antes da Data (no formato 'dd/MM/yyyy') informada
3
TipoPeriodo TipoPeriodoTotalizacaoContaReceberPagar
Tipo do período a ser considerado para a pesquisa
4
TipoNatureza
TipoNaturezaTotalizacaoContaReceberPaga r
Tipo da natureza a ser considerada para a pesquisa
5
CodigosFornecedores String[]
Lista com o código dos fornecedores a serem considerados na pesquisa Classe TotalizacaoContaPagar
1 Total String Valor total a pagar ao fornecedor
2 CodigoFornecedor String Código do fornecedor
3 NomeFornecedor String Nome do fornecedor
Classe FiltroResumoMovimentacoesTitulosPagar
1 CodigoFilial String Código da filial Classe ResumoMovimentacoesTitulosPagar
1
QuantidadeTitulosPendentesMinh a
Autorizacao String
Quantidade de título a pagar com status de autorização "Pendente de minha autorização"
2 QuantidadeTitulosPendentesMinh
a
AutorizacaoAVencerHoje String
Quantidade de títulos a pagar com status de autorização "Pendente de minha autorização" e que posssui a data de vencimento igual a data atual
3 QuantidadeTitulosPendentesMinh
a
AutorizacaoVencidos String
Quantidade de título a pagar com status de autorização "Pendente de minha autorização" e que posssui a data de vencimento inferior a data atual
Classe FiltroCobrancaContaReceber
1 NumeroDocumento String Número do título. 2 CPF_CNPJ_ClienteSacado String CPF/CNPJ do cliente
3
CodigoClienteSacado String Código do cliente (este campo só será utilizado caso o campo
"CPF_CNPJ_ClienteSacado" está inválido.
4 Vencidos Bool Especifica se deve ser retornado boletos vencidos.