put https://pagamentos.meuk8.com.br/CobrancasAPI/api/Assinatura
Esta API permite que seja atualizado os dados na assinatura, por ID.
Requisão
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
Id | GUID | Identificador único da assinatura | Sim |
ClienteId | GUID | Identificador único do cliente | Não |
ClienteNome | Texto | Nome do cliente relacionado a assinatura, somente para retornar dados | Não |
Descricao | Texto | Breve descrição sobre a cobrança | Não |
Valor | Numérico | Valor da cobrança | Sim |
Periodicidade | Texto | Período o qual a cobrança será enviada ao cliente, podendo ser: Todos, mensal, semanal, quinzenal, bimestral, trimestral, semestral e anual | Sim |
DiasGeracaoCobranca | Numérico | Dias para gerar a cobrança de assinatura | Não |
IniciandoEm | Data | Data de início da assinatura | Sim |
FinalizandoEm | Data | Data de fim da assinatura | Não |
FormasPagamento | Texto | Forma de pagamento da cobrança podendo ser: Nenhum, Boleto, Cartao, Pix, Manual, Protesto, SaldoWebConta | Não |
ProdutoId | GUID | Identificador único do produto caso houver | Não (1) |
Multa | Numérico | Valor da multa caso haja algum tipo de atraso | Não |
JurosMes | Numérico | Porcentagem de juros ao mes após o vencimento | Não |
DescontoAteVencimento | Numérico | Desconto até a última data do vencimento da assinatura | Não |
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 | Não |
ClientePagamentosId | GUID | Id do cliente de pagamento | Não |
Valor | Numérico | Valor da assinatura | Não |
(1) - Quando o campo ProdutoId está preenchido a Multa, DescontoAteVencimento e Juros devem estar vazios!