v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

Assinatura

Consulta Assinaturas

Esta API permite realizar consultas das assinaturas em massa por descrição, cliente e periodicidade.

Requisição

Campo	Tipo	Descrição	Obrigatório
DescricaoContains	Texto	Descrição da assinatura, aceita consulta parcial	Não
ClienteNomeContains	Texto	Nome do cliente da assinatura, aceita consulta parcial	Não
Periodicidade	Texto	Periodicidade da assinatura	Não
Start	Número	Posição do início da consulta	Não
Size	Número	Quantidade de itens retornados	Não

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	Numérico	Valor da cobrança
Periodicidade	Texto	Período o qual a cobrança será enviada ao cliente
DiasGeracaoCobranca	Numérico	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	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	Texto	Id do cliente de pagamento
Valor	Número	Valor da assinatura

get/api/Assinatura

Query parameters

DescricaoContainsstring

Descrição da assinatura, aceita consulta parcial

ClienteNomeContainsstring

Nome do cliente da assinatura, aceita consulta parcial

Periodicidade da assinatura

Startinteger

Inicio da consulta

Sizeinteger

Tamanho da consulta

Headers

Aeskeystring required

Response

Assinaturas consultadas com sucesso

Criacaostring date-time

Data de criação da assinatura

Idstring

Id da assinatura

ClienteIdstring uuid

Id do cliente relacionado a assinatura

ClienteNomestring

Nome do cliente relacionado a assinatura, somente para retornar dados

Descricaostring required

Descrição da assinatura

Valornumber double

Valor da assinatura

Periodicidade da assinatura

DiasGeracaoCobrancainteger

Dias para gerar a cobrança de assinatura

IniciandoEmstring date-time

Data de início da assinatura

FinalizandoEmstring date-time

Data de fim da assinatura

Formas de pagamento da assinatura

ProdutoIdstring uuid

Id do produto da assinatura

Multanumber double

Multa percentual da assinatura

JurosMesnumber double

Juros percentual ao mês da assinatura

DescontoAteVencimentonumber double

Desconto percentual para pagamento até o vencimento da assinatura

AutoEmiteFormaPagamentoboolean

Example response

[
  {
    "ClienteId": "00000000-0000-0000-0000-000000000000",
    "ProdutoId": "00000000-0000-0000-0000-000000000000",
    "SplitValores": [
      {
        "ClientePagamentosId": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
]