O TCGI permite a geração dos Relatórios de Ficha Financeira e Informe de Pagamentos via API para facilitar a integração com outros produtos.
Seguem os exemplos de geração para:
Verbo GET: http://localhost:8051/api/imb/v1/reports/[COLIGADA]/[TIPO_RELATORIO]/[NUMERO_VENDA]
Parâmetro: Nenhum
Tipo de Relatório: FF
Número Venda: 10022
Exemplo: http://localhost:8051/api/imb/v1/reports/1/FF/10022
Ao utilizar a API abaixo, o sistema irá considerar os relatórios parametrizados na Etapa 1 de Relatórios, do Portal do Cliente, sendo que o relatório da Ficha Financeira em especial, irá considerar a opção Considerar Deságio ao Gerar a Ficha Financeira no Portal e no App:
| Título | API para Geração de Ficha Financeira |
|---|---|
| Endpoint | http://localhost:8051/api/imb/v1/reports/[COLIGADA]/[TIPO_RELATORIO]/[NUMERO_VENDA] |
| Verbo | Get |
Parameters | no parameters |
| Descrição | Api para solicitar aprovação de proposta de venda quando a mesma foi reprovada pela validação. Ao solicitar a aprovação da proposta o sistema enviára um e-mail para o supervisor do corretor solicitadando a sua aprovação, desde que o parâmetro "Permite Forçar Proposta" esteja marcado. Para o envio do e-mail os campos dos parâmetros do TCGI → Portal do Imóvel→ Porposta de Venda devem ser preenchidos Baixe aqui o modelo do corpo do e-mail |
Parâmetros do TCGI |
|
No Body |
No Response |
Tipos de Relatório:
RELATÓRIO DE FICHA FINANCEIRA:
Verbo GET: http://localhost:8051/api/imb/v1/reports/1/[TIPO_RELATORIO]/[NUMERO_VENDA]
Parâmetro: Nenhum
Tipo de Relatório: FF
Número Venda: 10022
Exemplo: http://localhost:8051/api/imb/v1/reports/1/FF/10022
Geração da Ficha Financeira na interface do RM:
Ao solicitar este relatório via API, é necessário passar na URL do Verbo o Tipo de Relatório FF e o Número da Venda:
http://localhost:8051/api/imb/v1/reports/1/FF/10022
Pegamos o retorno desta API e colamos na ferramenta do site https://base64.guru/converter/decode/pdf para validarmos o relatório gerado:
Os relatórios são idênticos.
RELATÓRIO DE INFORME DE PAGAMENTOS:
Verbo GET: http://localhost:8051/api/imb/v1/reports/1/[TIPO_RELATORIO]/[NUMERO_VENDA]?[ANOBASE=####]
Parâmetro: ANOBASE=####
Tipo de Relatório: IP
Número Venda: 10022
Exemplo: http://localhost:8051/api/imb/v1/reports/1/IP/10022?ANOBASE=2022
Geramos este relatório no RM:
Validamos o retorno da API no site de decodificação para PDFs:
Novamente, os relatórios gerados foram idênticos.
