get https://pagamentos.meuk8.com.br/CobrancasAPI/api/Cobranca
O método de cobrança é emitido conforme suas informações e gerada a cobrança para determinado cliente. Nele contém informações dos dados principais da cobrança, possui retentivas as quais são as formas e datas de notificação ao cliente, informações referente ao pagamento da cobrança e as os detalhes das notificações.
Requisição
| Campo | Tipo | Descrição |
|---|---|---|
| dataInicial | Data | Data inicial da cobrança |
| dataFinal | Data | Data final da cobrança |
| dataEmissaoInicial | Data | Data inicial da emissão |
| dataEmissaoFinal | Data | Data final da emissão |
| clientId | Texto | Id do cliente |
| descricaoContains | Texto | Descrição total ou parcial, informada na nota fiscal |
| clienteNomeContains | Texto | Nome do cliente total ou parcial, utilizado na nota fiscal |
| tipo | Texto | Tipo da cobrança |
| estado | Texto | Estado da cobrança |
| formaPagamento | Texto | Forma de pagamento, podendo ser = Nenhum, Boleto, Cartão, Pix, Manual, Protesto, SaldoWebConta, OpenFinance |
| start | Número | Posição do início da consulta |
| size | Número | Quantidade de itens retornados |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Id | Numérico | Identificador único da cobrança |
| IdentificadorSequencial | Numérico | Identificador sequencial da cobrança |
| ClienteId | Numérico | Identificador único do cliente |
| ClienteNome | Texto | Nome do cliente relacionado a cobrança |
| Descricao | Texto | Descrição com mais detalhes sobre a cobrança |
| Valor | Data | Valor a ser pago na cobrança |
| Criacao | Data | Data em que a cobrança foi gerada |
| Vencimento | Data | Data de vencimento da cobrança |
| NaoReceberDepoisDe | Data | Data definida para o cliente não receber a cobrança após ela |
| Tipo | Texto | Tipo da cobrança, avulsa ou assinatura |
| Estado | Texto | Situação da cobrança, paga, não paga, vencida e etc… |
| FormasPagamento | Texto | Formas de pagamento da cobrança, pix, cartão, boleto e etc… |
| ProdutoId | Numérico | Identificador único do produto(forma simplificada da cobrança) |
| Multa | Numérico | Valor da multa a ser aplicado na cobrança |
| MultaCorrecao | Numérico | Tipo da multa a ser aplicada, podendo ser= Percentual, Valor, Diário |
| JurosMes | Numérico | Juros mensais aplicados sobre o valor da cobrança |
| JurosCorrecao | Numérico | Tipo do juros a ser aplicado, podendo ser= Percentual, Valor, Diário |
| DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento |
| DescontoCorrecao | Numérico | Tipo do desconto a ser aplicado, podendo ser= Percentual, Valor, Diário |
| DadosPagamento | Texto | Situação sobre os dados do pagamento da cobrança |
| NotificacaoCobrancaDias | Numérico | Dias antes do vencimento da cobrança para enviar a notificação |
| NotificacaoCobrancaEmail | Boleano | Se esta opção estiver marcada o cliente receberá uma notificação via e-mail |
| NotificacaoCobrancaSMS | Boleano | Se esta opção estiver marcada o cliente receberá uma notificação via SMS |
| NotificacaoCobrancaCartaImpressa | Boleano | Se esta opção estiver marcada o cliente receberá uma notificação via carta |
| PrimeiraTentativaHabilitada | Boleano | Primeira tentativa de notificação com os dias vencidos |
| PrimeiraTentativaDias | Numérico | Número de dias vencidos |
| PrimeiraTentativaEmail | Boleano | Primeira tentativa de notificação com os dias vencidos via e-mail |
| PrimeiraTentativaSMS | Boleano | Primeira tentativa de notificação com os dias vencidos via SMS |
| SegundaTentativaHabilitada | Boleano | Segunda tentativa de notificação com os dias vencidos |
| SegundaTentativaDias | Numérico | Número de dias vencidos |
| SegundaTentativaEmail | Boleano | Segunda tentativa de notificação com os dias vencidos via e-mail |
| SegundaTentativaSMS | Boleano | Segunda tentativa de notificação com os dias vencidos via SMS |
| TerceiraTentativaHabilitada | Boleano | Terceira tentativa de notificação com os dias vencidos |
| TerceiraTentativaDias | Numérico | Número de dias vencidos |
| TerceiraTentativaEmail | Boleano | Terceira tentativa de notificação com os dias vencidos via e-mail |
| TerceiraTentativaSMS | Boleano | Terceira tentativa de notificação com os dias vencidos via SMS |
| QuartaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
| QuartaTentativaDias | Numérico | Número de dias vencidos |
| QuartaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| QuartaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| QuintaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
| QuintaTentativaDias | Numérico | Número de dias vencidos |
| QuintaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| QuintaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| SextaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
| SextaTentativaDias | Numérico | Número de dias vencidos |
| SextaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| SextaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| SetimaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
| SetimaTentativaDias | Numérico | Número de dias vencidos |
| SetimaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| SetimaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| OitavaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
| OitavaTentativaDias | Numérico | Número de dias vencidos |
| OitavaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| OitavaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| NonaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
| NonaTentativaDias | Numérico | Número de dias vencidos |
| NonaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| NonaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| DecimaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
| DecimaTentativaDias | Numérico | Número de dias vencidos |
| DecimaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| DecimaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| imgBase64 | Imagem | Imagem |
| NumeroOperacao | Numérico | Número referente a operação da cobrança |
| SplitValores | Array | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do K8Bank, a partir do código de cliente e do valor respectivo |
| ClientePagamentosId | Texto | Id do cliente do pagamento |
| Pagamento | - | - |
| Id | Texto | Id do pagamento |
| Situacao | Texto | Situação do pagamento, podendo ser = pendente, pago, atrasado |
| DataPagamento | Texto | Data do pagamento |
| FormaPagamento | Texto | Forma de pagamento, podendo ser = Nenhuma, Boleto, Cartao, Pix, Manual, Protesto, SaldoWebConta |
| DadosPagamento | Texto | Dados do pagamento |
| ValorPago | Número | Valor pago de pagamento |
| ValorPrincipal | Número | Valor principal de pagamento |
| ValorMultaJuros | Número | Valor multa/juros de pagamento |
| NumeroPagamento | Texto | Número do pagamento |
| ValorTaxas | Número | Valor das taxas de pagamento |
| ValorLiquido | Número | Valor líquido de pagamento |
| DataDisponibilizacao | Texto | Data de disponibilização pagamento |
| ReembolsadoAoCliente | Boleano | Indicação de reembolsado ao cliente do pagamento |
| Antecipado | Boleano | Indicativo se o pagamento foi antecipado |
| SplitCobrancaRequest | - | - |
| ClientePagamentosId | Texto | Id do cliente do pagamento |
| Valor | Número | Valor da cobrança |