v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBAssinatura
Consulta a assinatura por id
Esta API permite realizar consultas por ID.
Requisão
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Id | GUID | Identificador da assinatura | Sim |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Criacao | Data | Data em que a cobrança foi criada |
| Id | GUID | Identificador único da assinatura |
| ClienteId | GUID | 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 |
| Periodicidade | Texto | Período o qual a cobrança será enviada ao cliente |
| DiasGeracaoCobranca | Numérico | Dias para gerar a cobrança de assinatura |
| IniciandoEm | Data | Data de início da assinatura |
| FinalizandoEm | Data | Data de fim da assinatura |
| FormasPagamento | Texto | Forma de pagamento da cobrança |
| ProdutoId | GUID | Identificador único do produto caso houver |
| Multa | Numérico | Valor da multa caso haja algum tipo de atraso |
| JurosMes | Numérico | Porcentagem de juros ao mes após o vencimento |
| DescontoAteVencimento | Numérico | 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 meuK8, a partir do código de cliente e do valor respectivo |
| ClientePagamentosId | GUID | Id do cliente de pagamento |
| Valor | Número | Valor da assinatura |
get/api/Assinatura/{Id}
Path parameters
Idstring required
Id da assinatura
Headers
Aeskeystring required
Response
Assinatura consultada
Example response
{
"ClienteId": "00000000-0000-0000-0000-000000000000",
"ProdutoId": "00000000-0000-0000-0000-000000000000",
"SplitValores": [
{
"ClientePagamentosId": "00000000-0000-0000-0000-000000000000"
}
]
}