Cobmais WebService SOAP interface description
Index
- Get Token
- Salvar Cliente
- Contratos Distribuídos
- Contratos Distribuídos por Data
- Devolver Contrato
- Devolver Contrato Motivo
- Devolver Contrato Por Pagamento Direto
- Devolver Contrato Por Pagamentos
- Devolver Contrato Por Devolução Parcial
- Reabrir Contrato
- Incluir Acordo [Descontinuado]
- Salvar Acordo
- Pagar Acordo
- Pagar Acordo Por Parcela
- Quebrar Acordo
- Estornar Pagamento
- Incluir Boletos
- Incluir SPC
- Remover SPC
- Incluir Evento
- Suspender Cobrança
- Reativar Cobrança
- Incluir Contrato
- Consultar Clientes
- Consultar Cliente Discador
- Consultar Contratos
- Consultar Acordos
- Consultar Acordos em Andamento por CPF/CNPJ
- Consultar Acordos Finalizados por CPF/CNPJ
- Consultar Quebra Acordos
- Consultar Eventos
- Consultar Pagamentos
- Consultar Pagamentos Renegociação
- Consultar Boletos
- Consultar Nosso Numero
- Críticas do WebService
- Consultar Boletos Originais
- Consultar Atualização Cadastral
- Alteração de Número de Acordo
- Alteração Número Parcela de Acordo
- Enviar o Codigo de Acesso ao Cobchat
Métodos
Get Token
GetToken (Usuario, Senha)
Método responsável por realizar a autenticação do usuário e senha informado, e retorna o Token com sua respectiva Data de Expiração necessários para utilizar os demais métodos.
Parâmetros:
-
string
Usuario
Usuário cadastrado no Cobmais
-
string
Senha
Senha cadastrada no Cobmais
Retorno do tipo AutenticacaoResponse.
Salvar Cliente
SalvarCliente (ChaveCliente, TipoPessoa, CpfCnpj, NomeCliente, PessoaFisica, PessoaJuridica, Telefones, Enderecos, Emails, Contratos, DadosAdicionaisCliente, Referencias Token )
O método é responsável por validar os dados do Cliente informados e caso não exista um cliente com a Chave informada inclui um novo cliente no Cobmais, caso já exista atualiza dos dados cliente.
Parâmetros:
-
string(100)
ChaveCliente*
Codigo do Cliente na aplicação
-
EnumTipoPessoa
TipoPessoa
Identificação da pessoa se ela é fisica ou juridica
-
string(14)
CpfCnpj
Tamanho 11 para CPF e 14 para CNPJ, alinhados com zeros a esquerda
-
string(100)
NomeCliente*
Nome do Cliente que será inserido no Cobmais
-
PessoaFisicaRequest
PessoaFisica
Se for pessoa física ,informar dados instanciando sua classe
-
PessoaJuridicaRequest
PessoaJuridica
Se for pessoa jurídica ,informar dados instanciando sua classe
-
List‹TelefoneRequest›
Telefones
Lista com Todos os Telefones, sendo necessario instanciar a sua classe e preencher seus atributos
-
List‹EnderecoRequest›
Enderecos
Lista com Todos os Enderecos, sendo necessario instanciar a sua classe e preencher seus atributos
-
List‹EmailRequest›
Emails
Lista com Todos os Emails, sendo necessario instanciar a sua classe e preencher seus atributos
-
List‹ContratoRequest›
Contratos*
Lista com Todos os Contratos, sendo necessario instanciar a sua classe e preencher seus atributos
-
DadosAdicionaisRequest
DadosAdicionaisCliente
Objeto com os Dados Adicionais do Cliente, sendo necessario instanciar a sua classe e preencher seus atributos
-
List‹ReferenciaRequest›
Referencias
Lista com Todos as Referências, sendo necessario instanciar a sua classe e preencher seus atributos
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Consultar Clientes
ConsultarClientes (Clientes, Token)
Método que realizar a consulta dos dados cadastrais dos Clientes e seus contratos informados com base na sua Chave de Identificação.
Parâmetros:
-
List‹string›
Clientes
Lista de Clientes que os identifica na aplicação integrada ao Cobmais
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹ClienteResponse›.
Consultar Cliente Discador
ConsultarClienteDiscador (CPF/CNPJ, Token)
Método que realiza a consulta dos dados cadastrais do Cliente e seus contratos informados, retornando também sua Chave de Indentificaçao(IdNegociacao) para integraçao com o Discador.
Parâmetros:
-
string
CPFCNPJ
CPF/CNPJ do cliente
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo ClienteDiscadorResponse.
Contratos Distribuídos
ContratosDistribuidos ( Token )
O método é responsável por retornar os contratos distribuídos.
Parâmetros:
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹ContratosDistribuidosResponse›.
Contratos Distribuídos por Data
ContratosDistribuidosPorData ( DataInicial, DataFinal, Token )
O método é responsável por retornar os contratos distribuídos entre um intervalo de datas informado.
Parâmetros:
-
string
DataInicial
Data inicial para pesquisa
-
string
DataFinal
Data final para pesquisa
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹ContratosDistribuidosResponse›.
Devolver Contrato
DevolverContrato ( ChaveCliente, Contrato, Parcelas, Motivo, Observacao, Token )
O método é responsável por validar os dados informados e realizar a devolução de um contrato, podendo devolver o contrato por inteiro, sendo assim nao sendo necessário informar suas parcelas ou de apenas algumas parcelas.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Número de identificação do contrato
-
List‹ParcelaRequest›
Parcelas
Lista de Parcelas que serão devolvidas
-
EnumMotivoDevolucao
Motivo
Identificação do Motivo da devolução
-
string
Observacao
Informações sobre a Devolução
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Devolver Contrato Motivo
DevolverContratoMotivo ( ChaveCliente, Contrato, Parcelas, DescricaoMotivo, Observacao, DataDevolucao, Token )
O método é responsável por validar os dados informados e realizar a devolução de um contrato, podendo devolver o contrato por inteiro, sendo assim nao sendo necessário informar suas parcelas ou de apenas algumas parcelas.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Número de identificação do contrato
-
List‹ParcelaRequest›
Parcelas
Lista de Parcelas que serão devolvidas
-
string
DescricaoMotivo
Nome Exato do Motivo da devolução, cadastrado no cobmais
-
string
Observacao
Informações sobre a Devolução
-
string
DataDevolucao
Data da Devolucao(se não informar, gravará a Data Atual)
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Devolver Contrato Por Pagamento Direto
DevolverContratoPorPagamentoDireto ( ChaveCliente, Contrato, Parcelas, DataPagamento, ValorPagamento, Observacao, Token )
O método é responsável por validar os dados informados e realizar a devolução de um contrato, pelo motivo PAGAMENTO DIRETO, informando a Data e Valor pagos. Esse método realiza baixa apenas de Parcelas Originais.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Número de identificação do contrato
-
List‹ParcelaRequest›
Parcelas
Lista de Parcelas ORGINAIS que serão devolvidas
-
string
DataPagamento
Data do pagamento
-
string
ValorPagamento
Valor do pagamento
-
string
Observacao
Informações sobre a Devolução
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Devolver Contrato Por Pagamento Direto
DevolverContratoPorPagamentos ( ChaveCliente, Contrato, PagamentoDiretoRequest, Token )
O método é responsável por validar os dados informados e realizar a devolução de parcelas de um contrato pelo motivo PAGAMENTO DIRETO, informando a Data e Valores pagos. Esse método realiza baixa apenas de Parcelas Originais.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Número de identificação do contrato
-
List‹PagamentoDiretoRequest›
Pagamentos
Lista de Pagamentos
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Devolver Parcelas Por Devoluções Parciais
DevolverContratoPorDevolucoesParciais ( ChaveCliente, Contrato, DevolucaoParcialRequest, Token )
O método é responsável por validar os dados informados e realizar a devolução de parcelas de um contrato pelo motivo DEVOLUÇÃO PARCIAL, informando a Data e Valores a devolver. Esse método realiza a devolução apenas de Parcelas Originais.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Número de identificação do contrato
-
List‹DevolucaoParcialRequest›
Devolução Parcial
Lista de Devolução
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Reabrir Contrato
ReabrirContrato ( ChaveCliente, Contrato, Parcelas, Observacao, Token )
O método é responsável por validar os dados informados e realizar a reabertura de um contrato devolvido, podendo reabrir o contrato por inteiro, sendo assim nao sendo necessário informar suas parcelas ou de apenas algumas parcelas.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Número de identificação do contrato
-
List‹ParcelaRequest›
Parcelas
Lista de Parcelas que serão reabertas
-
string
Observacao
Informações adicionais sobre a Reabertura
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Pagar Acordo
PagarAcordo ( ChaveCliente, Contrato, Parcela, DataVencimento, ValorParcela, DataPagamento, ValorPagamento, NumeroAcordo, Token)
O método é responsável por validar os dados informados e realizar o pagamento de uma parcela pertencente a um acordo no Cobmais
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Número de identificação do contrato(caso o acordo envolver mais que um contrato, enviar um dos contratos)
-
string(10)
Parcela
Número de Parcela do Acordo. Caso for um acordo a vista, seu valor por padrão será 1
-
DateTime
DataVencimento
Data de Vencimento da Parcela.
-
decimal
ValorParcela
Valor da Parcela do Acordo que foi gerado.
-
DateTime
DataPagamento
Data de Pagamento do acordo
-
decimal
ValorPagamento
Valor original do Pagamento, se for um acordo parcelado informar o valor que foi pago na parcela
-
string
NumeroAcordo
Número do Acordo(opcional)
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Pagar Acordo
PagarAcordoPorParcela ( ChaveCliente, Contrato, Parcela, DataPagamento, ValorPagamento, NumeroAcordo, Token)
O método é responsável por validar os dados informados e realizar o pagamento de uma parcela pertencente a um acordo no Cobmais, utilizando apenas o Número da Parcela como parâmetro.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Número de identificação do contrato
-
string(10)
Parcela
Número de Parcela do Acordo ou Caso for um acordo a vista, poderá ser enviado o número da Parcela Original ou 1 caso seja um pagamento de várias parcelas originais.
-
DateTime
DataPagamento
Data de Pagamento do acordo
-
decimal
ValorPagamento
Valor original do Pagamento, se for um acordo parcelado informar o valor que foi pago na parcela
-
string
NumeroAcordo
Número do Acordo(opcional)
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Quebrar Acordo
QuebrarAcordo ( ChaveCliente, NumeroAcordo, Observacao, Token)
O método é responsável por validar os dados informados e realizar a quebra de um acordo no Cobmais
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
int
NumeroAcordo
Número de identificação do acordo
-
string
Observacao
Informaçoes adicionais da quebra de acordo
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Estornar Pagamento
EstornarPagamento ( ChaveCliente, Contrato, Parcela, DataVencimento, ValorParcela, DataPagamento, ValorPagamento, NumeroAcordo, Token)
O método é responsável por validar os dados informados e estornar um pagamento de uma parcela no Cobmais
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Número de identificação do contrato(caso o acordo envolver mais que um contrato, enviar um dos contratos)
-
string(10)
Parcela
Número de Parcela do Acordo. Caso for um acordo a vista, seu valor por padrão será 1
-
DateTime
DataVencimento
Data de Vencimento da Parcela
-
decimal
ValorParcela
Valor da Parcela do Acordo que foi gerado
-
DateTime
DataPagamento
Data de Pagamento do acordo
-
decimal
ValorPagamento
Valor original do Pagamento, se for um acordo parcelado informar o valor que foi pago na parcela
-
string
NumeroAcordo
Número do Acordo(opcional)
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Incluir Boleto
IncluirBoletos (Banco, Carteira, CodigoCedente, Agencia, ContaCorrente, Boletos, Token )
O método é responsável por validar os dados do Boleto informados e incluir as informações no Cobmais
Parâmetros:
-
string
Banco
Codigo do Banco
-
string
Carteira
Codigo da Carteira
-
string
CodigoCedente
Codigo do Cedente do Credor
-
string
Agencia
Codigo da Agencia sem dígito
-
string
ContaCorrente
Numero da Conta Corrente que será emitido o boleto sem dígito
-
List‹BoletoRequest›
Boletos
Lista com os Boletos que serão incluidos na base Cobmais, sendo necessario instanciar a sua classe e preencher seus atributos
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Incluir SPC
IncluirSPC (ChaveCliente, Contrato, DataInclusao, TipoSPC, Token )
O método é responsável por incluir a SPC ao contrato no Cobmais
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Numero do Contrato
-
DateTime
DataInclusao
Data em que foi incluído o SPC para o cliente
-
EnumTipoSPC
Tipo SPC
Identifica o Tipo de SPC
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Remover SPC
RemoverSPC (ChaveCliente, Contrato, DataExclusao, TipoSPC, Token )
O método é responsável por remover a SPC do contrato no Cobmais
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Numero do Contrato
-
DateTime
DataExclusao
Data em que foi excluido o SPC para o cliente
-
EnumTipoSPC
Tipo SPC
Identifica o Tipo de SPC
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Incluir Evento
IncluirEvento (ChaveCliente, TipoEvento, DataInclusao, Descricao, Contrato, Token )
O método é responsável por incluir um evento ao contrato ou para todos os contratos do cliente no Cobmais. Ao informar o contrato o evento será apenas para aquele contrato e cliente.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
DateTime
DataInclusao
Data em que foi incluído o evento para o cliente
-
string
Tipo Evento
Nome do Tipo de Evento Cadastrado
-
string
Descricao
Descricao do Evento
-
string
Contrato
Numero do Contrato
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Salvar Acordo
salvarAcordo (SalvarAcordo, Token)
O método é responsável por salvar um acordo no Cobmais. O acordo será enquadrado na campanha e faixa de maior prioridade seguindo as mesmas regras da telecobrança. Porém, toda a composição do acordo (Juros, Multa, HO, desconto em principal e taxa de parcelamento) serão considerados apenas os enviados por meio deste método. O enquadramento em uma campanha será usado para calcular o repasse e receita do acordo.
Parâmetros:
-
SalvarAcordoRequest
Acordo
Informações do acordo
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Incluir Acordo [Descontinuado]
IncluirAcordo (ChaveCliente, Acordo, Token )
O método é responsável por incluir um acordo no Cobmais.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
AcordoRequest
Acordo
Informações do acordo
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Suspender Cobrança
SuspenderCobranca (ChaveCliente, Contrato, MotivoSuspensao, Observacao, Token )
O método é responsável por suspender uma cobrança no Cobmais.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Numero do Contrato
-
string
MotivoSuspensao
O motivo que levou o contrato a ser suspenso.Cadastrar no Cobmais
-
string
Observacao
Informações adicionais da suspensao
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Reativar Cobrança
ReativarCobranca (ChaveCliente, Contrato, Observacao, Token )
O método é responsável por reativar uma cobrança suspensa no Cobmais.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
string
Contrato
Numero do Contrato
-
string
Observacao
Informações adicionais da reativaçao
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Incluir Contrato
IncluirContrato (ChaveCliente, ContratosOriginais, Contrato, Token )
O método é responsável por incluir, atualizar um contrato ou realizar uma renegociação gerando um contrato novo no Cobmais.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
List‹string›
ContratosOriginais
Contratos Originais se forem de uma renegociação
-
ContratoRequest
Contrato
Informações do Contrato, sendo necessario instanciar a sua classe e preencher seus atributos
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Consultar Acordos
ConsultarAcordos ( DataInicial, DataFinal, Token)
Método que realizará a consulta dos Acordos com base no período informado.
Parâmetros:
-
DateTime
DataInicial
Data de Inicio da pesquisa
-
DateTime
DataFinal
Data Final da pesquisa
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹ClienteAcordoResponse›.
Consultar Acordos em Andamento por CPF/CNPJ
ConsultarAcordosEmAndamentoPorCPFCNPJ ( CPF_CNPJ, Token)
Método que realizará a consulta dos acordos em andamento com base no CPF/CNPJ informado.
Parâmetros:
-
string
CPF_CNPJ
CPF/CNPJ do cliente a ser consultado
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹ClienteAcordoResponse›.
Consultar Acordos Finalizados por CPF/CNPJ
ConsultarAcordosFinalizadosPorCPFCNPJ ( CPF_CNPJ, Token)
Método que realizará a consulta de acordos finalizados com base no CPF/CNPJ informado.
Parâmetros:
-
string
CPF_CNPJ
CPF/CNPJ do cliente a ser consultado
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹ClienteAcordoResponse›.
Consultar Quebra Acordos
ConsultarQuebraAcordos ( DataInicial, DataFinal, Token)
Método que realizará a consulta da Quebra dos Acordos com base no período informado.
Parâmetros:
-
DateTime
DataInicial
Data de Inicio da pesquisa
-
DateTime
DataFinal
Data Final da pesquisa
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹AcordoQuebraResponse›.
Consultar Eventos
ConsultarEventos ( DataInicial, DataFinal, TipoEvento, GrupoEvento, Token)
Método que realizará a consulta dos Eventos com base no período informado e no seu tipo de Evento ou apenas pelo período, se o tipo de Evento nao for informado.
Parâmetros:
-
DateTime
DataInicial
Data de Inicio da pesquisa
-
DateTime
DataFinal
Data Final da pesquisa
-
string
TipoEvento
Nome do evento
-
string
GrupoEvento
Grupo de eventos configurados no cobmais
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹EventoClienteResponse›.
Consultar Contratos
ConsultarContratos ( Contratos, ChaveCliente, Token)
Método que realizar a consulta dos dados de cobrança(Acordos,Eventos) do Contrato com base nos Numeros de Contrato informados.
Parâmetros:
-
List‹string›
Contratos
Lista de numeros de contrato
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹ContratoResponse›.
Consultar Pagamentos
ConsultarPagamentos ( DataInicial, DataFinal, Token)
Método que realizará a consulta dos Pagamentos com base no período informado.
Parâmetros:
-
DateTime
DataInicial
Data de Inicio da pesquisa
-
DateTime
DataFinal
Data Final da pesquisa
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹PagamentoResponse›.
Consultar Pagamentos
ConsultarPagamentosRenegociacao ( DataInicial, DataFinal, Token)
Método que realizará a consulta dos Pagamentos de acordos que geraram contratos de Renegociação com base no período informado.
Parâmetros:
-
DateTime
DataInicial
Data de Inicio da pesquisa
-
DateTime
DataFinal
Data Final da pesquisa
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹PagamentoRenegResponse›.
Consultar Boletos
ConsultarBoletos ( DataInicial, DataFinal, Token)
Método que realizará a consulta dos Boletos com base no período informado.
Parâmetros:
-
DateTime
DataInicial
Data de Inicio da pesquisa
-
DateTime
DataFinal
Data Final da pesquisa
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹BoletoResponse›.
Consultar Nosso Numero
ConsultarNossoNumero (Banco, Agencia, Conta, NossoNumero, Token)
Método que realizará a consulta pelo nosso numero informado e retornará todos os dados do acordo efetivado e do boleto gerado.
Parâmetros:
-
string
Banco
Codigo do Banco
-
string
Agencia
Codigo da Agencia
-
string
Conta
Numero da Conta que será emitido o boleto
-
string
NossoNumero
Nosso Numero sequencial que foi gerado o boleto
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo NossoNumeroResponse.
Consultar Boletos Originais
ConsultarBoletosOriginais ( ChaveCliente, CpfCnpj, Token)
Método que realizará a consulta dos Boletos com base na Chave do Cliente ou o CpfCnpj se a mensma não for informada. Podendo ser boletos de parcelas originais(enviadas pelo registro 25 de importação) ou boletos de parcelamento(Acordos no cobmais).
Parâmetros:
-
string
ChaveCliente
Chave de identificação do Cliente no Cobmais
-
string
CpfCnpj
CpfCnpj cadastrado no Cobmais
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹BoletoOriginalResponse›.
Consultar Atualização Cadastral
ConsultarAtualizacaoCadastral ( DataInicial, DataFinal, booEndereco, booTelefone, booEmail, TipoOrigem, Token)
Método que realizará a consulta dos dados cadastrais dos Clientes com base no período de inserção ou atualização dos clientes.
Parâmetros:
-
DateTime
DataInicial
Data de Inicio da pesquisa
-
DateTime
DataFinal
Data Final da pesquisa
-
bool
booEndereco
Retorno(true ou false) para os Endereços
-
bool
booTelefone
Retorno(true ou false) para os Telefones
-
bool
booEmail
Retorno(true ou false) para os Emails
-
EnumTipoOrigem
TipoOrigem
Identifica o Tipo de Origem
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹ClienteCadastralResponse›.
Alteração de Número de Acordo
AlterarNumeroAcordo (ChaveCliente, NumeroAcordo, NovoNumero, Token)
Método responsável por localizar um acordo informado e substituir seu número pelo novo número informado. Caso o acordo localizado seja de renegociação, localiza o contrato gerado pelo acordo e altera o número do mesmo pelo novo número do acordo.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
int
NumeroAcordo
Número do acordo a ser substituído
-
string
NovoNumero
Novo número a ser incluído
-
string
Token
Chave de autenticação gerada pelo WebService
Retorna true caso não ocorra nenhuma crítica ou erro.
Alteração Número Parcela de Acordo
AlterarNumeroParcelaAcordo (ChaveCliente, IdAcordo, Parcelas, Token)
Método responsável por localizar parcela de um acordo informado e substituir seu número pelo novo número informado.
Parâmetros:
-
string
ChaveCliente
Codigo do Cliente na aplicação
-
long
IdAcordo
Número do acordo em que será alterado o número da parcela.
-
List‹AlterarNumeroParcelaAcordoRequest›
Parcelas
Lista com o número da parcela antigo e novo numero.
-
string
Token
Chave de autenticação gerada pelo WebService
Retorno do tipo List‹AlterarNumeroParcelaAcordoResponse›.