--- title: "Consulta Cobranças por ClienteId" method: GET path: "/api/CobrancaPorClienteId" tags: ["CobrancaPorClienteId"] --- # Consulta Cobranças por ClienteId `GET /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 | | 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 | | DecontoCorrecao | Texto |Tipo do desconto a ser aplicado | | 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 meuK8, a partir do código de cliente e do valor respectivo | ## Query parameters - `ClienteId` string, required - `Start` integer - `Size` integer ## Headers - `Aeskey` string, required ## Response `200` Cobranças consultadas com sucesso - BknBankCobrancasAPIModelsCobranca[] - `Id` string — Id da cobrança - `IdentificadorSequencial` integer — Identificador numérico da cobrança, não pode ser re-configurado - `ClienteId` string, uuid — Id do cliente relacionado a cobrança - `ClienteNome` string — Nome do cliente relacionado a cobrança, somente para retornar dados - `Descricao` string — Descrição da cobrança - `Valor` number, double — Valor da cobrança - `Vencimento` string, date-time — Data de vencimento da cobrança - `NaoReceberDepoisDe` string, date-time — Data para não aceitar pagamento da cobrança - `Estado` 'Todos' | 'Pendente' | 'Paga' | 'Inadimplente' | 'PendenteRegistro' | 'Cancelada' — Estado da cobrança - `FormasPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta' — Formas de pagamento da cobrança - `ProdutoId` string, uuid — Id do produto relacionado a cobrança - `Multa` number, double — Multa percentual da cobrança - `MultaCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento' — Forma de correcao da multa (percentual ou valor) - `JurosMes` number, double — Juros mensal percentual da cobrança - `JurosCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento' — Forma de correcao dos juros (percentual ou valor) - `DescontoAteVencimento` number, double — Desconto percentual até o vencimento da cobrança - `DescontoCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento' — Forma de correcao do desconto (percentual ou valor) - `Instrucao1` string — Instrucao1 em texto - `Instrucao2` string — Instrucao2 em texto - `Instrucao3` string — Instrucao3 em texto - `Instrucao4` string — Instrucao4 em texto - `DadosPagamento` BknBankCobrancasAPIModelsPagamento — Modelo de Pagamento - `Id` string — Id do pagamento - `Situacao` 'pendente' | 'pago' | 'atrasado' — Situação do pagamento - `DataPagamento` string, date-time — Data do pagamento - `FormaPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta' — Forma de pagamento - `DadosPagamento` string — Dados do pagamento - `ValorPago` number, double — Valor pago de pagamento - `ValorPrincipal` number, double — Valor principal de pagamento - `ValorMultaJuros` number, double — Valor multa/juros de pagamento - `NumeroPagamento` string — Número do pagamento - `ValorTaxas` number, double — Valor das taxas de pagamento - `ValorLiquido` number, double — Valor líquido de pagamento - `DataDisponibilizacao` string, date-time — Data de disponibilização pagamento - `ReembolsadoAoCliente` boolean — Indicação de reembolsado ao cliente do pagamento - `Antecipado` boolean — Indicativo se o pagamento foi antecipado - `TransacaoId` string, uuid — Id da Transacao relacionada a este pagamento - `CobrancaId` string, uuid — Id da Cobrança relacionada a este pagamento - `NotificacaoCobrancaDias` integer — Dias antes do vencimento para notificar - `NotificacaoCobrancaEMail` boolean — Notificação via EMail - `NotificacaoCobrancaSMS` boolean — Notificação via SMS - `PrimeiraTentativaHabilitada` boolean — Habilitado primeira tentativa em atraso - `PrimeiraTentativaDias` integer — Dias primeira tentativa em atraso - `PrimeiraTentativaEMail` boolean — Email da primeira tentativa em atraso - `PrimeiraTentativaSMS` boolean — SMS da primeira tentativa em atraso - `SegundaTentativaHabilitada` boolean — Habilitado segunda tentativa em atraso - `SegundaTentativaDias` integer — Dias segunda tentativa em atraso - `SegundaTentativaEMail` boolean — Email da segunda tentativa em atraso - `SegundaTentativaSMS` boolean — SMS da segunda tentativa em atraso - `TerceiraTentativaHabilitada` boolean — Habilitado terceira tentativa em atraso - `TerceiraTentativaDias` integer — Dias terceira tentativa em atraso - `TerceiraTentativaEMail` boolean — Email da terceira tentativa em atraso - `TerceiraTentativaSMS` boolean — SMS da terceira tentativa em atraso - `QuartaTentativaHabilitada` boolean — Habilitado quarta tentativa em atraso - `QuartaTentativaDias` integer — Dias quarta tentativa em atraso - `QuartaTentativaEMail` boolean — Email da quarta tentativa em atraso - `QuartaTentativaSMS` boolean — SMS da quarta tentativa em atraso - `QuintaTentativaHabilitada` boolean — Habilitado Quinta tentativa em atraso - `QuintaTentativaDias` integer — Dias Quinta tentativa em atraso - `QuintaTentativaEMail` boolean — Email da Quinta tentativa em atraso - `QuintaTentativaSMS` boolean — SMS da Quinta tentativa em atraso - `SextaTentativaHabilitada` boolean — Habilitado Sexta tentativa em atraso - `SextaTentativaDias` integer — Dias Sexta tentativa em atraso - `SextaTentativaEMail` boolean — Email da Sexta tentativa em atraso - `SextaTentativaSMS` boolean — SMS da Sexta tentativa em atraso - `SetimaTentativaHabilitada` boolean — Habilitado Setima tentativa em atraso - `SetimaTentativaDias` integer — Dias Setima tentativa em atraso - `SetimaTentativaEMail` boolean — Email da Setima tentativa em atraso - `SetimaTentativaSMS` boolean — SMS da Setima tentativa em atraso - `OitavaTentativaHabilitada` boolean — Habilitado Oitava tentativa em atraso - `OitavaTentativaDias` integer — Dias Oitava tentativa em atraso - `OitavaTentativaEMail` boolean — Email da Oitava tentativa em atraso - `OitavaTentativaSMS` boolean — SMS da Oitava tentativa em atraso - `NonaTentativaHabilitada` boolean — Habilitado Nona tentativa em atraso - `NonaTentativaDias` integer — Dias Nona tentativa em atraso - `NonaTentativaEMail` boolean — Email da Nona tentativa em atraso - `NonaTentativaSMS` boolean — SMS da Nona tentativa em atraso - `DecimaTentativaHabilitada` boolean — Habilitado Decima tentativa em atraso - `DecimaTentativaDias` integer — Dias Decima tentativa em atraso - `DecimaTentativaEMail` boolean — Email da Decima tentativa em atraso - `DecimaTentativaSMS` boolean — SMS da Decima tentativa em atraso - `ImgBase64` string - `NumeroOperacao` string - `SplitValores` BknBankCobrancasAPIModelsSplitCobrancaRequest[] — Definição do split - `ClientePagamentosId` string, uuid — Id da produto associado ao split - `Valor` number, double — Valor nominal de credito para o participante - `ClientePagamentosId` string, uuid - `NotaFiscal` string ## Other responses - `401` — Não há permissão para acessar este cliente - `404` — Não existe o cliente por Id - `500` — Erro efetuando a consulta --- [API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/revisions/14db4977f490/schema)