--- title: "Consulta Cobranças por ClienteId" method: GET path: "/api/CobrancaPorClienteId" tags: ["CobrancaPorClienteId"] --- # Consulta Cobranças por ClienteId `GET /api/CobrancaPorClienteId` ## Request - Base URL: `https://pagamentos.meuk8.com.br/CobrancasAPI` - URL: `https://pagamentos.meuk8.com.br/CobrancasAPI/api/CobrancaPorClienteId` - Auth: OAuth 2 - Password - Token URL: `/CobrancasAPI/token` scopes: `BknBankCobrancasAPI` 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 | ## 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 - `Criacao` string, date-time: Data de criaçã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: Valor - `MultaCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento': Forma de correcao da multa (percentual ou valor) - `JurosMes` number, double: Valor - `JurosCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento': Forma de correcao dos juros (percentual ou valor) - `DescontoAteVencimento` number, double: Valor - `DescontoCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento': Forma de correcao do desconto (percentual ou valor) - `Desconto2` number, double: Valor - `DescontoCorrecao2` 'Percentual' | 'Valor' | 'Diario' | 'Isento': Forma de correcao do desconto (percentual ou valor) - `DataDesconto2` string, date-time: O desconto será valido até essa data - `Desconto3` number, double: Valor - `DescontoCorrecao3` 'Percentual' | 'Valor' | 'Diario' | 'Isento': Forma de correcao do desconto (percentual ou valor) - `DataDesconto3` string, date-time: O desconto será valido até essa data - `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 - `CanalPagamento` integer - `MeioPagamento` integer - `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 Sétima tentativa em atraso - `SetimaTentativaDias` integer: Dias Sétima tentativa em atraso - `SetimaTentativaEMail` boolean: Email da Sétima tentativa em atraso - `SetimaTentativaSMS` boolean: SMS da Sétima 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 Décima tentativa em atraso - `DecimaTentativaDias` integer: Dias Décima tentativa em atraso - `DecimaTentativaEMail` boolean: Email da Décima tentativa em atraso - `DecimaTentativaSMS` boolean: SMS da Décima 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.dev/meuk8/apis/k8-fintech-cobran-as.md) - [All operations](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/llms.txt) - [OpenAPI document](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/revisions/4b96dba8717a?raw)