Documentação das APIs

Lista cobranças no caixa de baixas manuais e efetua fechamento

Esta API permite listar as cobranças no caixa de baixas manuais e efetuar o fechamento da mesma.

Requisição:

CampoTipoDescrição
IdNuméricoIdentificador único
IdentificadorSequencialNuméricoIdentificador Sequencial
ClienteIdNuméricoIdentificador único do cliente
ClienteNomeTextoNome do cliente
DescricaoTextoDescrição da cobrança
ValorNuméricoValor liquido da cobrança
CriacaoDataData de criação da cobrança
VencimentoDataData de vencimento da cobrança
NaoReceberDepoisDeDataData para não receber a cobrança depois da mesma
TipoTextoAssinatura ou Avulsa
EstadoTextoSituação da cobrança, paga/ a pagar e etc…
FormasPagamentoTextoForma de pagamento da cobrança, pix/cartão/boleto e etc…
ProdutoIdNuméricoIdentificador do produto feito para a cobrança
MultaNuméricoMulta aplicada a cobrança
MultaCorrecaoNuméricoJurosMes
NuméricoJuros aplicados no valor da cobrança por mêsJurosCorrecao
NuméricoDescontoAteVencimentoNumérico
Desconto aplicado até o vencimento da cobrançaDescontoCorrecaoNumérico
IdNuméricoIdentificador do pagamento
SituacaoTextoSituação da cobrança, paga/ a pagar e etc…
DataPagamentoDataData do pagamento
FormaPagamentoTextoForma de pagamento: pix/cartão /boleto
DadosPagamentoTextoDados do pagamento, ex: “Baixa manual”
ValorPagoNuméricoValor a ser pago na cobrança
ValorPrincipalNuméricoValor principal da cobrança, bruto
ValorMultaJurosNuméricoValor da multa + juros aplicados
NumeroPagamentoNuméricoIdentificador do pagamento
ValorTaxasNuméricoValor das taxas aplicadas sobre a cobrança
ValorLiquidoNuméricoValor líquido da cobrança
DataDisponibilizacaoDataData em que a cobrança fica disponível a pagar
ReembolsadoAoClienteBoleanoVerifica se o cliente será reembolsado de alguma forma
AntecipadoBoleanoVerifica se terá antecipação dos valores
NotificacaoCobrancaDiasNuméricoDias para o cliente ser notificado sobre a cobrança
NotificacaoCobrancaEmailBoleanoVerifica se o cliente será cobrado via e-mail
NotificacaoCobrancaSMSBoleanoVerifica se o cliente será cobrado via SMS
NotificacaoCobrancaCartaImpressaBoleanoVerifica se o cliente será cobrado via Carta Impressa
PrimeiraTentativaHabilitadaBoleanoVerifica se obteve uma tentativa de contato
PrimeiraTentativaDiasNuméricoDias para o cliente ser notificado sobre a cobrança
PrimeiraTentativaEmailBoleanoVerifica se o cliente será cobrado via e-mail
PrimeiraTentativaSMSBoleanoVerifica se o cliente será cobrado via SMS
SegundaTentativaHabilitadaBoleanoVerifica se obteve uma tentativa de contato
SegundaTentativaDiasNuméricoDias para o cliente ser notificado sobre a cobrança
SegundaTentativaEmailBoleanoVerifica se o cliente será cobrado via e-mail
SegundaTentativaSMSBoleanoVerifica se o cliente será cobrado via SMS
TerceiraTentativaHabilitadaBoleanoVerifica se obteve uma tentativa de contato
TerceiraTentativaDiasNuméricoDias para o cliente ser notificado sobre a cobrança
TerceiraTentativaEmailBoleanoVerifica se o cliente será cobrado via e-mail
TerceiraTentativaSMSBoleanoVerifica se o cliente será cobrado via SMS
QuartaTentativaHabilitadaBoleanoVerifica se obteve uma tentativa de contato
QuartaTentativaDiasNuméricoDias para o cliente ser notificado sobre a cobrança
QuartaTentativaEmailBoleanoVerifica se o cliente será cobrado via e-mail
QuartaTentativaSMSBoleanoVerifica se o cliente será cobrado via SMS
imgBase64ImagemImagem
NumeroOperacaoNuméricoNúmero de toda a operação realiza
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!