get
https://pagamentos.meuk8.com.br/CobrancasAPI/api/Cobranca/
Esta API permite a consulta de cobranças através do ID.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Id | GUID | Identificador da Cobrança | Sim |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Criacao | Data | Data em que a cobrança foi gerada |
| Id | GUID | Identificador único da cobrança |
| IdentificadorSequencial | Numérico | Identificador sequencial da cobrança |
| ClienteId | GUID | 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 |
| 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 |
| Estado | Texto | Situação da cobrança |
| FormasPagamento | Texto | Formas de pagamento da cobrança |
| ProdutoId | GUID | Identificador único do produto(forma simplificada da cobrança) |
| Multa | Numérico | Valor da multa a ser aplicado na cobrança |
| MultaCorrecao | Texto | Tipo da multa a ser aplicada |
| JurosMes | Numérico | Juros mensais aplicados sobre o valor da cobrança |
| JurosCorrecao | Texto | Tipo do juros a ser aplicado |
| DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento |
| DescontoCorrecao | Texto | Tipo do desconto a ser aplicado |
| Instrucao1 | Texto | Deve ser utilizado para adicionar informações adicionais destinadas ao usuário final |
| Instrucao2 | Texto | Deve ser utilizado para adicionar informações adicionais destinadas ao usuário final |
| Instrucao3 | Texto | Deve ser utilizado para adicionar informações adicionais destinadas ao usuário final |
| Instrucao4 | Texto | Deve ser utilizado para adicionar informações adicionais destinadas ao usuário final |
| DadosPagamento | Objeto | Situação sobre os dados do pagamento da cobrança, contendo ID, situação, Data/Forma/Dados do pagamento, Valor Pago/Principal/ Multa Juros/ Taxa/ Líquido, Número Pagamento, Data da disponibilização, Reembolso ao Cliente e Antecipado |
| NotificacaoCobrancaDias | Numérico | Dias antes do vencimento da cobrança para enviar a notificação |
| NotificacaoCobrancaEmail | Booleano | Se esta opção estiver marcada, o cliente receberá uma notificação via e-mail |
| NotificacaoCobrancaSMS | Booleano | Se esta opção estiver marcada, o cliente receberá uma notificação via SMS |
| NotificacaoCobrancaCartaImpressa | Booleano | Se esta opção estiver marcada, o cliente receberá uma notificação via carta |
| PrimeiraTentativaHabilitada | Booleano | Primeira tentativa de notificação com os dias vencidos |
| PrimeiraTentativaDias | Numérico | Número de dias vencidos |
| PrimeiraTentativaEmail | Booleano | Primeira tentativa de notificação com os dias vencidos via e-mail |
| PrimeiraTentativaSMS | Booleano | Primeira tentativa de notificação com os dias vencidos via SMS |
| SegundaTentativaHabilitada | Booleano | Segunda tentativa de notificação com os dias vencidos |
| SegundaTentativaDias | Numérico | Número de dias vencidos |
| SegundaTentativaEmail | Booleano | Segunda tentativa de notificação com os dias vencidos via e-mail |
| SegundaTentativaSMS | Booleano | Segunda tentativa de notificação com os dias vencidos via SMS |
| TerceiraTentativaHabilitada | Booleano | Terceira tentativa de notificação com os dias vencidos |
| TerceiraTentativaDias | Numérico | Número de dias vencidos |
| TerceiraTentativaEmail | Booleano | Terceira tentativa de notificação com os dias vencidos via e-mail |
| TerceiraTentativaSMS | Booleano | Terceira tentativa de notificação com os dias vencidos via SMS |
| QuartaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| QuartaTentativaDias | Numérico | Número de dias vencidos |
| QuartaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| QuartaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| QuintaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| QuintaTentativaDias | Numérico | Número de dias vencidos |
| QuintaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| QuintaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| SextaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| SextaTentativaDias | Numérico | Número de dias vencidos |
| SextaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| SextaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| SetimaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| SetimaTentativaDias | Numérico | Número de dias vencidos |
| SetimaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| SetimaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| OitavaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| OitavaTentativaDias | Numérico | Número de dias vencidos |
| OitavaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| OitavaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| NonaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| NonaTentativaDias | Numérico | Número de dias vencidos |
| NonaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| NonaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| DecimaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| DecimaTentativaDias | Numérico | Número de dias vencidos |
| DecimaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| DecimaTentativaSMS | Booleano | 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 K8 Fintech, a partir do código de cliente e do valor respectivo |
| ClientePagamentosId | Texto | Id do cliente do pagamento |
| NotaFiscal | Texto | Nota fiscal da cobrança |