v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
CobrancaBaixaManual

Calcula e realiza a baixa manual de uma cobrança

Esta API realiza o cálculo de uma cobrança e opcionalmente realiza sua baixa

Requisição:

CampoTipoDescriçãoObrigatório
CobrancaIdGUIDId do cobrançaSim
BaixaBooleanoIndica se deve baixar cobrança ou somente retornar valores atualizadosSim

Resposta:

CampoTipoDescrição
NovoVencimentoDataData do vencimento atual
ValorPrincipalNuméricoValor líquido da cobrança
ValorMultaJurosNuméricoValor da multa e juros acrescentados a cobrança
ValorPagoNuméricoValor pago pelo cliente
TipoDescontoNuméricoTipo de Desconto aplicado
ValorDescontoNuméricoValor de Desconto aplicado
TipoMultaNuméricoTipo de Multa aplicada
ValorMultaNuméricoValor de Multa aplicada
TipoJurosNuméricoTipo de Juros aplicado
ValorJurosNuméricoValor de Juros aplicado
DiasAtrasoNuméricoQuantidade de dias de atraso calculados entre hoje e o vencimento
post/api/v1/CobrancaBaixaManual

Query parameters

CobrancaIdstring required

Id do cobrança

Baixaboolean required

Indica se deve baixar cobrança ou somente retornar valores atualizados

Headers

Aeskeystring required

Response

Cobrança consultada/baixada com sucesso

NovoVencimentostring date-time

Vencimento atualizado da cobrança

ValorPrincipalnumber double

Valor principal atualizado da cobrança

ValorMultaJurosnumber double

Valor da multa/juros atualizado da cobrança

ValorPagonumber double

Valor pago/a pagar atualizado da cobrança

TipoDescontostring

Tipo da desconto no cobrança

ValorDescontonumber double

Valor do desconto atualizado da cobrança

TipoMultastring

Tipo da multa no cobrança

ValorMultanumber double

Valor da multa atualizado da cobrança

TipoJurosstring

Tipo da juros no cobrança

ValorJurosnumber double

Valor juros atualizado da cobrança

DiasEmAtrasointeger

Dias em atraso da cobrança