get https://pagamentos.meuk8.com.br/CobrancasAPI/api/CobrancaPorClienteId
Esta API permite consultar cobranças através do ClienteId.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| ClienteId | GUID | Id do cliente da cobrança. | Sim |
| Start | Numérico | Posição do início da consulta | Não |
| Size | Numérico | Quantidade de itens retornados | Não |
Resposta:
| Campo | Tipo | Descrição |
|---|---|---|
| Id | GUID | Identificador único |
| IdentificadorSequencial | Numérico | Identificador sequencial |
| ClienteId | GUID | Identificador do cliente |
| ClienteNome | Texto | Nome do cliente |
| Descricao | Texto | Descrição sobre a cobrança |
| Valor | Numérico | Valor da cobrança |
| Criacao | Data | Data da criação da cobrança |
| Vencimento | Data | Data do vencimento da cobrança |
| NaoReceberDepoisDe | Data | Data para não receber mais o pagamento da cobrança |
| Tipo | Texto | Tipo da cobrança, assinatura ou avulsa. |
| Estado | Texto | Estado em que a cobrança está, pendente, paga e etc… |
| FormasPagamento | Texto | Forma de pagamento, pix, boleto, cartão etc… |
| ProdutoId | GUID | Identificador do produto da cobrança |
| Multa | Numérico | Valor da multa aplicada sob o valor da cobrança |
| MultaCorrecao | Numérico | Valor da multa correção |
| JurosMes | Numérico | Valor dos juros aplicados por mês |
| JurosCorrecao | Numérico | Valor dos juros correção |
| DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento |
| DecontoCorrecao | Numérico | Valor do desconto sob a cobrança |
| DadosPagamento | Objeto | Informações sobre o pagamento |
| NotificacaoCobrancaDias | Numérico | Dias para o cliente ser notificado |
| NotificacaoCobrancaEmail | Booleano | Verifica se a notificação será via Email |
| NotificacaoCobrancaSMS | Booleano | Verifica se a notificação será via SMS |
| NotificacaoCobrancaCartaImpressa | Booleano | Verifica se a notificação será via Carta Impressa |
| PrimeiraTentativaHabilitada | Booleano | Verifica se a primeira tentativa de notificação foi ativada |
| PrimeiraTentativaDias | Numérico | Dias para o cliente ser notificado sobre a cobrança |
| PrimeiraTentativaEmail | Booleano | Verifica se o cliente será cobrado via Email |
| PrimeiraTentativaSMS | Booleano | Verifica se o cliente será cobrado via SMS |
| SegundaTentativaHabilitada | Booleano | Verifica se a segunda tentativa de notificação foi ativada |
| SegundaTentativaDias | Numérico | Dias para o cliente ser notificado sobre a cobrança |
| SegundaTentativaEmail | Booleano | Verifica se o cliente será cobrado via Email |
| SegundaTentativaSMS | Booleano | Verifica se o cliente será cobrado via SMS |
| TerceiraTentativaHabilitada | Booleano | Verifica se a terceira tentativa de notificação foi ativada |
| TerceiraTentativaDias | Numérico | Dias para o cliente ser notificado sobre a cobrança |
| TerceiraTentativaEmail | Booleano | Verifica se o cliente será cobrado via Email |
| TerceiraTentativaSMS | Booleano | Verifica se o cliente será cobrado via SMS |
| QuartaTentativaHabilitada | Booleano | Verifica se a quarta tentativa de notificação foi ativada |
| QuartaTentativaDias | Numérico | Dias para o cliente ser notificado sobe a cobrança |
| QuartaTentativaEmail | Booleano | Verifica se o cliente será cobrado via Email |
| QuartaTentativaSMS | Booleano | Verifica se o cliente será cobrado via SMS |
| ImgBase64 | Imagem | Imagem |
| NumeroOperacao | Numérico | Número da operação |
| 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 |