TOTVS Gestão de Receita Recorrente

Árvore de páginas

Versões comparadas

Versão antiga 8

changes.mady.by.user Renato Hideo Kawakubo

Gravado em

comparado com

Nova versão 9

changes.mady.by.user Renato Hideo Kawakubo

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Medição, a plataforma do GRR – Gestão de Receita Recorrente disponibiliza os serviços para manipulação dos registros de utilização relacionados a uma fatura do GRR. Considere o registro de utilização para cálculo e geração da fatura para permitir que os registros de utilização sejam mencionados somente em faturas abertas.

Em suma, o processo de medição é a atividade que controla tudo o que foi produzido na plataforma. Sempre observando o que aconteceu no decorrer do mês antes da cobrança recorrente. Depois que é realizado a leitura dessa medição, é liberado a emissão da fatura percorrendo o fluxo de cobrança recorrente.

Devemos seguir alguns pré requisitos:

  • Possuir Customers;
  • Possuir Plano;
  • Possuir Itens;
  • 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, após emissão da fatura não será possível realizar a leitura de uma 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;
  3. Publicar o ajuste conforme modelo de payload disponibilizado na documentação do Swagger.


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.

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

Dica
titlePreenchimento 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.

  "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.

Nota
titleRecorrência

A medição será calculado após execução do JobScheduller, quando percorrer o período da agenda realizada pelo administrador do sistema. Maiores informações sobre o JobScheduller clique aqui.