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 | Número | Posição do início da consulta | Não |
| Size | Número | Quantidade de itens retornados | Não |
Resposta:
| Campo | Tipo | Descrição |
|---|---|---|
| Id | GUID | Identificador único |
| IdentificadorSequencial | Número | 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 |
| Estado | Texto | Estado em que a cobrança está |
| FormasPagamento | Texto | Forma de pagamento |
| ProdutoId | GUID | Identificador do produto da cobrança |
| Multa | Numérico | Valor da multa aplicada sob o valor da cobrança |
| MultaCorrecao | Texto | Tipo da multa a ser aplicada |
| JurosMes | Numérico | Valor dos juros aplicados por mês |
| 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 | Instrução 1 |
| Instrucao2 | Texto | Instrução 2 |
| Instrucao3 | Texto | Instrução 3 |
| Instrucao4 | Texto | Instrução 4 |
| DadosPagamento | Objeto | Informações sobre o pagamento |
| NotificacaoCobrancaDias | Número | 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 |
| PrimeiraTentativaHabilitada | Booleano | Verifica se a primeira tentativa de notificação foi ativada |
| PrimeiraTentativaDias | Número | 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 | Número | 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 | Número | 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 | Número | Dias para o cliente ser notificado sobre a cobrança |
| QuartaTentativaEMail | Booleano | Verifica se o cliente será cobrado via Email |
| QuartaTentativaSMS | Booleano | Verifica se o cliente será cobrado via SMS |
| QuintaTentativaHabilitada | Booleano | Verifica se a quinta tentativa de notificação foi ativada |
| QuintaTentativaDias | Número | Dias para o cliente ser notificado sobre a cobrança |
| QuintaTentativaEMail | Booleano | Verifica se o cliente será cobrado via Email |
| QuintaTentativaSMS | Booleano | Verifica se o cliente será cobrado via SMS |
| SextaTentativaHabilitada | Booleano | Verifica se a sexta tentativa de notificação foi ativada |
| SextaTentativaDias | Número | Dias para o cliente ser notificado sobre a cobrança |
| SextaTentativaEMail | Booleano | Verifica se o cliente será cobrado via Email |
| SextaTentativaSMS | Booleano | Verifica se o cliente será cobrado via SMS |
| SetimaTentativaHabilitada | Booleano | Verifica se a sétima tentativa de notificação foi ativada |
| SetimaTentativaDias | Número | Dias para o cliente ser notificado sobre a cobrança |
| SetimaTentativaEMail | Booleano | Verifica se o cliente será cobrado via Email |
| SetimaTentativaSMS | Booleano | Verifica se o cliente será cobrado via SMS |
| OitavaTentativaHabilitada | Booleano | Verifica se a oitava tentativa de notificação foi ativada |
| OitavaTentativaDias | Número | Dias para o cliente ser notificado sobre a cobrança |
| OitavaTentativaEMail | Booleano | Verifica se o cliente será cobrado via Email |
| OitavaTentativaSMS | Booleano | Verifica se o cliente será cobrado via SMS |
| NonaTentativaHabilitada | Booleano | Verifica se a nona tentativa de notificação foi ativada |
| NonaTentativaDias | Número | Dias para o cliente ser notificado sobre a cobrança |
| NonaTentativaEMail | Booleano | Verifica se o cliente será cobrado via Email |
| NonaTentativaSMS | Booleano | Verifica se o cliente será cobrado via SMS |
| DecimaTentativaHabilitada | Booleano | Verifica se a décima tentativa de notificação foi ativada |
| DecimaTentativaDias | Número | Dias para o cliente ser notificado sobre a cobrança |
| DecimaTentativaEMail | Booleano | Verifica se o cliente será cobrado via Email |
| DecimaTentativaSMS | Booleano | Verifica se o cliente será cobrado via SMS |
| ImgBase64 | Texto | Base64 da cobrança |
| NumeroOperacao | Texto | Número da operação |
| SplitValores | Array | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas MeuK8, a partir do código de cliente e do valor respectivo |
| ClientePagamentosId | GUID | Identificador único do cliente |
| NotaFiscal | Texto | Número da nota fiscal da cobrança |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…