TOTVS Gestão de Receita Recorrente

Árvore de páginas

Na plataforma do GRR – Gestão de Receita Recorrente, disponibilizamos serviços de controle para incluir, alterar ou excluir uma medição de um produto ou serviço de uma subscrição. Estas medições são enviadas para plataforma de acordo a sua data de utilização para serem consideradas na geração da fatura referente ao mês utilizado. Após a geração da fatura a mesma é liberada para o fluxo de cobrança.

Devemos seguir alguns pré requisitos:

  • Possuir Clientes;
  • Possuir Plano;
  • Possuir Itens;
  • Possuir Subscrição;

Como é fluxo de Medição na Plataforma GRR ?

A leitura de medição é realizada logo após o procedimento de Subscription Usage (Medição da subscrição), disponível na documentação do Swagger mediante parametrização dos Itens do produto para atender a todos os Tipos de Cálculos. A medição é válida para subscrições em aberto e após emissão da fatura não será possível considerar novas medições com data de utilização de faturas fechada.

A seguir será demonstrado um exemplo de medição, mas antes devemos acessar e autenticar no Swagger, para saber mais sobre procedimento de autenticação, clique no link "Gerando Token e autenticando no Swagger".

Devemos seguir os seguintes passos:

  1. Ter realizado os procedimentos dos pré requisitos mencionado acima;
  2. Localizar a subscrição que será realizado o procedimento de medição;

Passo 2. Com o Id armazenado no momento da Subscrição, utilize o mesmo para realizar a pesquisa no GET do endpoint SubscriptinUsage.

Response disponibilizado na execução do Swagger. Armazene as informações pois elas serão utilizadas na publicação da medição.

Publicação do ajuste conforme modelo de payload disponibilizado na documentação do Swagger

Passo 3.  No POST do endpoint SubscripionUsage, realize o preenchimento do payload conforme documentação do Swagger.

Preenchimento do Payload

{
  "subscriptionId": "284bed4b-5a75-43d8-9a68-9b6a7d313180", -→ Id gerado pela Subscrição.
  "subscriptionItemId": "284bed4b-5a75-43d8-9a68-9b6a7d313180", -→ Item da Subscrição.
  "itemIntegrationId": "T1|D MG 01|011001", -→ Integration ID do Item.
  "itemId": "284bed4b-5a75-43d8-9a68-9b6a7d313180", -→ ID do Item armazenado no momento da criação do item.
  "usageDate": "2023-02-01", -→ Data deve pertence ao período da cobrança. Caso seja diferente, uma mensagem de erro será apresentada.
  "quantity": 10.5, -→ Valor da medição

Abaixo são preenchimentos para o range de metadata e integrações com o Protheus ou Terceiros.

  "metadata": [
    {
      "alias": "string",
      "name": "string",
      "key": "string",
      "value": "string"
    }
  ],
  "integrationId": "284bed4b-5a75-43d8-9a68-9b6a7d313180",
  "source": "Nome da Rotina",
  "origin": "Protheus"
}

Response quando executado com sucesso.

Recorrência

A medição é processada durante a geração da fatura agendado pelo Job de Faturas cadastrado no JobScheduller, Maiores informações sobre o JobScheduller clique aqui.

  • Sem rótulos