Documentação das APIs

Consulta Cobranças por ClienteId

Esta API permite consultar cobranças através do ClienteId.

Requisição:

CampoTipoDescrição
IdNuméricoIdentificador único
IdentificadorSequencialNuméricoIdentificador sequencial
ClienteIdNuméricoIdentificador do cliente
ClienteNomeTextoNome do cliente
DescricaoTextoDescrição sobre a cobrança
ValorNuméricoValor da cobrança
CriacaoDataData da criação da cobrança
VencimentoDataData do vencimento da cobrança
NaoReceberDepoisDeDataData para não receber mais o pagamento da cobrança
TipoTextoTipo da cobrança, assinatura ou avulsa.
EstadoTextoEstado em que a cobrança está, pendente, paga e etc…
FormasPagamentoTextoForma de pagamento, pix, boleto, cartão etc…
ProdutoIdNuméricoIdentificador do produto da cobrança
MultaNuméricoValor da multa aplicada sob o valor da cobrança
MultaCorrecaoNuméricoValor da multa correção
JurosMesNuméricoValor dos juros aplicados por mês
JurosCorrecaoNuméricoValor dos juros correção
DescontoAteVencimentoNuméricoDesconto aplicado até a data do vencimento
DecontoCorrecaoNuméricoValor do desconto sob a cobrança
DadosPagamentoNuméricoInformações sobre o pagamento
NotificacaoCobrancaDiasNuméricoDias para o cliente ser notificado
NotificacaoCobrancaEmailBoleanoVerifica se a notificação será via Email
NotificacaoCobrancaSMSBoleanoVerifica se a notificação será via SMS
NotificacaoCobrancaCartaImpressaBoleanoVerifica se a notificação será via Carta Impressa
PrimeiraTentativaHabilitadaBoleanoVerifica se a primeira tentativa de notificação foi ativada
PrimeiraTentativaDiasNuméricoDias para o cliente ser notificado sobre a cobrança
PrimeiraTentativaEmailBoleanoVerifica se o cliente será cobrado via Email
PrimeiraTentativaSMSBoleanoVerifica se o cliente será cobrado via SMS
SegundaTentativaHabilitadaBoleanoVerifica se a segunda tentativa de notificação foi ativada
SegundaTentativaDiasNuméricoDias para o cliente ser notificado sobre a cobrança
SegundaTentativaEmailBoleanoVerifica se o cliente será cobrado via Email
SegundaTentativaSMSBoleanoVerifica se o cliente será cobrado via SMS
TerceiraTentativaHabilitadaBoleanoVerifica se a terceira tentativa de notificação foi ativada
TerceiraTentativaDiasNuméricoDias para o cliente ser notificado sobre a cobrança
TerceiraTentativaEmailBoleanoVerifica se o cliente será cobrado via Email
TerceiraTentativaSMSBoleanoVerifica se o cliente será cobrado via SMS
QuartaTentativaHabilitadaBoleanoVerifica se a quarta tentativa de notificação foi ativada
QuartaTentativaDiasNuméricoDias para o cliente ser notificado sobre a cobrança
QuartaTentativaEmailBoleanoVerifica se o cliente será cobrado via Email
QuartaTentativaSMSBoleanoVerifica se o cliente será cobrado via SMS
imgBase64ImagemImagem
NumeroOperacaoNuméricoNúmero da operação
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!