--- title: "Consulta cobranças" method: GET path: "/api/Cobranca" tags: ["Cobranca"] --- # Consulta cobranças `GET /api/Cobranca` O método de cobrança é emitido conforme suas informações e gerada a cobrança para determinado cliente. Nele contém informações dos dados principais da cobrança, possui retentivas as quais são as formas e datas de notificação ao cliente, informações referente ao pagamento da cobrança e as os detalhes das notificações. ### Requisição | **Campo** | **Tipo** | **Descrição** | **Obrigatório** | |--|--|--|--| | DataInicial | Data | Data inicial da cobrança | Não | | DataFinal | Data | Data final da cobrança | Não | | DataEmissaoInicial | Data | Data inicial da emissão | Não | | DataEmissaoFinal | Data | Data final da emissão | Não | | DataPagamentoInicial | Data | Data inicial do pagamento | Não | | DataPagamentoFinal | Data | Data final do pagamento | Não | | ClientId | Texto | Id do cliente | Não | | DescricaoContains | Texto | Descrição total ou parcial, informada na nota fiscal | Não | | ClienteNomeContains | Texto | Nome do cliente total ou parcial, utilizado na nota fiscal | Não | | Tipo | Texto | Tipo da cobrança | Não | | Estado | Texto | Estado da cobrança | Não | | FormaPagamento | Texto| Forma de pagamento | Não | | Start | Número | Posição do início da consulta | Não | | Size | Número | Quantidade de itens retornados. Caso não seja informado, esse campo listará 10 dados por vez| Não | ### Resposta | **Campo** | **Tipo** | **Descrição** | |--|--|--| | Id | Numérico | Identificador único da cobrança | | IdentificadorSequencial | Numérico | Identificador sequencial da cobrança| | ClienteId | Numérico | 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 | | Criacao | Data | Data em que a cobrança foi gerada | | 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 | Numérico |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| ## Query parameters - `DataInicial` string, date-time - `DataFinal` string, date-time - `DataEmissaoInicial` string, date-time - `DataEmissaoFinal` string, date-time - `DataPagamentoInicial` string, date-time - `DataPagamentoFinal` string, date-time - `ClientId` string, uuid - `DescricaoContains` string - `ClienteNomeContains` string - `Tipo` 'Todos' | 'Avulsa' | 'Assinatura' | 'Link' | 'Carne' - `Estado` 'Todos' | 'Pendente' | 'Paga' | 'Inadimplente' | 'PendenteRegistro' | 'Cancelada' | 'Protestado' - `FormaPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta' | 'OpenFinance' - `Start` integer - `Size` integer ## Headers - `Aeskey` string, required ## Response `200` Clientes consultados com sucesso - BknBankCobrancasAPIModelsCobrancaResponse[] - `Criacao` string, date-time — Data de criação da cobrança - `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 - `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)