get https://pagamentos.k8bank.com.br/CobrancasAPI/api/Assinatura
Esta API permite realizar consultas das assinaturas em massa por descrição, cliente e periodicidade.
Requisição
| Campo | Tipo | Descrição |
|---|---|---|
| descricaoContains | Texto | descrição da assinatura, aceita consulta parcial |
| clienteNomeContains | Texto | nome do cliente da assinatura, aceita consulta parcial |
| periodicidade | texto | periodicidade da assinatura |
| start | Número | Posição do início da consulta |
| size | Número | Quantidade de itens retornados |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Id | Númerico | Identificador único da assinatura |
| ClienteId | Númerico | Identificador único do cliente |
| ClienteNome | Texto | Nome do cliente que será realizada a cobrança |
| Descricao | Texto | Breve descrição sobre a cobrança |
| Valor | Númerico | Valor da cobrança |
| Criacao | Data | Data em que a cobrança foi criada |
| Periodicidade | Texto | Período o qual a cobrança será enviada ao cliente |
| DiasGeracaoCobranca | Númerico | Tempo destinado a geração da cobrança |
| IniciandoEm | Data | Tempo o qual ela vai começar a ser enviada ao cliente |
| FinalizandoEm | Data | Tempo o qual ela não vai mais ser enviada ao cliente |
| FormasPagamento | Texto | Forma de pagamento da cobrança |
| ProdutoId | Númerico | Identificador único do produto caso houver |
| Multa | Númerico | Valor da multa caso haja algum tipo de atraso |
| JurosMes | Númerico | Porcentagem de juros ao mes após o vencimento |
| DescontoAteVencimento | Númerico | Desconto até a última data do vencimento da assinatura |
| SplitValores | Array | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do K8Bank, a partir do código de cliente e do valor respectivo |
| ClientePagamentosId | Texto | Id do cliente de pagamento |
| Valor | Número | Valor da assinatura |