v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBCobranca
Consulta cobranças
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 |
get/api/Cobranca
Query parameters
DataInicialstring date-time
Data inicial a consultar
DataFinalstring date-time
Data final a consultar
DataEmissaoInicialstring date-time
Data de inicio da emissão
DataEmissaoFinalstring date-time
Data final da emissão
DataPagamentoInicialstring date-time
Data de inicio do pagamento
DataPagamentoFinalstring date-time
Data de final do pagamento
ClientIdstring uuid
Id do cliente
DescricaoContainsstring
Descrição da cobrança, aceita consulta parcial
ClienteNomeContainsstring
Nome do cliente da cobrança, aceita consulta parcial
Tipo'Todos' | 'Avulsa' | 'Assinatura' | 'Link' | 'Carne'
Tipo da cobrança
Estado'Todos' | 'Pendente' | 'Paga' | 'Inadimplente' | 'PendenteRegistro' | 'Cancelada' | 'Protestado'
Estado da cobrança
FormaPagamento'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta' | 'OpenFinance'
Forma de pagamento
Startinteger
Inicio da consulta
Sizeinteger
Tamanho da consulta
Headers
Aeskeystring required
Response
Clientes consultados com sucesso
Example response
[
{
"ClienteId": "00000000-0000-0000-0000-000000000000",
"ProdutoId": "00000000-0000-0000-0000-000000000000",
"DadosPagamento": {
"TransacaoId": "00000000-0000-0000-0000-000000000000",
"CobrancaId": "00000000-0000-0000-0000-000000000000"
},
"SplitValores": [
{
"ClientePagamentosId": "00000000-0000-0000-0000-000000000000"
}
],
"ClientePagamentosId": "00000000-0000-0000-0000-000000000000"
}
]