01. DADOS GERAIS
| Produto: | |
|---|
| Segmento: | |
|---|
| Módulo: | Financeiro - APIs Minhas Operações |
|---|
| Função: |
|---|
Consulta de total a pagar
02. SITUAÇÃO/REQUISITO
Desenvolver APIs para consulta de informações dos dashboards do financeiro para o produto "Minhas Operações".
03. SOLUÇÃO
Documentação Swagger da API: apitotvsmoda.bhan.com.br/api/totvsmoda/analytics/v2/swagger/index.html
...
| Totvs custom tabs box |
|---|
| tabs | Total a Pagar, Total a Receber, Prazo Médio Recebimento, Prazo Médio Pagamento, Saldo de Conta Corrente, Cartões em Atraso por Operadora, Total a Pagar e a Receber Quinzenal, Valor Aberto por Documento, Valor Recebido por Documento, Ranking de Clientes, Ranking de Fornecedores, DRF |
|---|
| ids | passo1,passo2,passo3,passo4,passo5,passo6,passo7,passo8,passo9,passo10,passo11,passo12 |
|---|
|
| Totvs custom tabs box items |
|---|
| default | yes |
|---|
| referencia | passo1 |
|---|
| 
Imagem 1 - Na imagem acima, temos o retorno da consulta da API referente ao endpoint "total-payable/search".
| Totvs custom tabs box |
|---|
| tabs | value_week,value_month,value_total |
|---|
| ids | result1,result2,result3 |
|---|
| | Totvs custom tabs box items |
|---|
| default | yes |
|---|
| referencia | result1 |
|---|
| 
Imagem 2.1 - Na imagem acima, temos o filtro de duplicatas da semana (08/07/2023 - 14/07/2023).
Imagem 2.2 - Na imagem acima, temos o resultado da consulta no componente FCPFL009 listando os títulos em aberto conforme o filtro realizado no componente FCPFF001. |
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | result2 |
|---|
| 
Imagem 3.1 - Na imagem acima, temos o filtro de duplicatas do mês (01/07/2023 - 31/07/2023).
Imagem 3.2 - Na imagem acima, temos o resultado da consulta no componente FCPFL009 listando os títulos em aberto conforme o filtro realizado no componente FCPFF001. |
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | result3 |
|---|
| 
Imagem 4.1 - Na imagem acima, temos o filtro de duplicatas sem filtro de vencimento, ou seja, todas as duplicatas em aberto.
Imagem 4.2 - Na imagem acima, temos o resultado da consulta no componente FCPFL009 listando os títulos em aberto conforme o filtro realizado no componente FCPFF001. |
|
|
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | passo2 |
|---|
| 
Imagem 1 - Na imagem acima, temos o retorno da consulta da API referente ao endpoint "total-receivable/search".
| Totvs custom tabs box |
|---|
| tabs | value_week,value_month,value_total |
|---|
| ids | p1,p2,p3 |
|---|
| | Totvs custom tabs box items |
|---|
| 
Imagem 2.1 - Filtro utilizado para se buscar as faturas com vencimento na semana (08/07/2023 ~ 14/07/2023).
Imagem 2.2 - Demonstração do resultado da consulta das faturas no FCRFL046 que estão com valor em aberto, sendo utilizado o filtro anterior do FCRFF004. |
| Totvs custom tabs box items |
|---|
| 
Imagem 3.1 - Na imagem acima, temos o filtro para se buscar as faturas com vencimento no mês (01/07/2023 ~ 31/07/2023).
Imagem 3.2 - No FCRFL046 temos o resultado das faturas em aberto cujo vencimento se encontra no mês 07 de 2023 (01/07/2023 ~ 31/07/2023), sendo considerado o filtro do FISFF004 utilizado acima. |
| Totvs custom tabs box items |
|---|
| 
Imagem 4.1 - Filtro utilizado para se buscar todas as faturas em aberto na empresa 1, não tendo informado nenhum período de vencimento.
Imagem 4.2 - Conforme apresentado na imagem acima, temos o valor resultado do filtro FCRFF004 para se buscar o valor de todas as faturas em aberto da empresa 1. |
|
|
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | passo3 |
|---|
| 
Imagem 1 - Na imagem acima, temos o retorno da consulta da API referente ao endpoint "average-receipt-period/search", que é o valor do prazo média de recebimento, temos 4 fatura sendo 2 com prazo médio de 0 dias, 1 com prazo de 23 dias e outra com prazo de 5 dias, somando as 4 faturas e dividindo ira dar o prazo médio de 7 dias, Formula: (data de liquidação - data de emissão).
Imagem 2 - Acima vemos uma fatura com 0 dias de prazo de recebimento.
Imagem 3 - Acima vemos uma fatura com 5 dias de prazo de recebimento.
Imagem 4 - Acima vemos uma fatura com 23 dias de prazo de recebimento.
Imagem 5 - Acima vemos uma fatura com 0 dias de prazo de recebimento. |
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | passo4 |
|---|
| 
Imagem 1 - Demonstração do retorno da consulta da API referente ao endpoint "average-payment-period/search" para consulta de prazo médio de pagamento. Formula: (data de liquidação - data de chegada).
Imagem 2 - Demonstração das duplicatas encontradas ao acionar a consulta. Observa-se destacado data chegada e data de liquidação envolvidas no cálculo. Primeira duplicata: data liquidação 13/07 - data chegada 03/07 = 10 dias Segunda duplicata: data liquidação 03/07 - data chegada 03/07 = 0 dias Terceira duplicata: data liquidação 03/07 - data chegada 03/07 = 0 dias Soma-se os dias, 10+0+0, divide pela quantidade de duplicatas(3), resulta em 3(valor truncado). |
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | passo5 |
|---|
| 
Imagem 1 - Demonstração do retorno da consulta da API referente ao endpoint "account-balance/search" para consulta do saldo conciliado das contas do tipo "Banco".
Imagem 2 - Demonstração do componente FCCFL004 com destaque para o saldo conciliado do dia 04/07/2023 da primeira conta listada no retorno da Imagem 1. |
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | passo6 |
|---|
|  Image Added
Imagem 1 - Demonstração do retorno da consulta da API referente ao endpoint "overdue-cards/search" para consulta de cartões em atraso por operadora.
 Image Added
Imagem 2 - Demonstração do componente FCCFL046 com destaque para operadora em destaque na Imagem 1.
|
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | passo7 |
|---|
|  Image Added
Imagem 1 - Demonstração do retorno da consulta da API referente ao endpoint "biweekly/search" para consulta do total dos valores a pagar e a receber referente ao período de quinze dias. Obs.: Type_field definirá o tipo sendo 1 valores a receber e 2 valores a pagar.
 Image Added
Imagem 2 - Filtro utilizado para se buscar as duplicatas em aberta com vencimento no período de 20/07/2023 à 04/08/2023.
 Image Added
Imagem 3 - Acima podemos ver as duplicatas que irão vencer dentro do período estipulado no filtro do FCPFF001.
 Image Added
Imagem 4 - Demonstração das configurações de filtro para se buscar as faturas em aberto, que possuem a data de vencimento entre os dias 20/07/2023 à 04/08/2023.
 Image Added
Imagem 5 - Conforme a imagem acima, podemos ver que foram trazidas 5 faturas que irão vencer conforme o período estipulado no filtro FCRFF004. |
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | passo8 |
|---|
|  Image Added
Imagem 1 - Demonstração do retorno da consulta da API referente ao endpoint "open-amount-document" para consulta do valor aberto por documento.
 Image Added
Imagem 2 - Neste exemplo usamos o componente FCRFL046 para demonstrar o valor em aberto do documento "Cheque". |
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | passo9 |
|---|
|  Image Added
Imagem 1 - Demonstração do retorno da consulta da API referente ao endpoint "amount-received-document" para consulta do valor recebido por documento.
 Image Added
Imagem 2 - Neste exemplo usamos o componente FCRFL046 para demonstrar o valor recebido do documento "Credev". |
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | passo10 |
|---|
|  Image Added
Imagem 1 - Demonstração da consulta do valor de clientes com maiores valores.
 Image Added
Imagem 2 - Demonstração do retorno da consulta da API referente ao endpoint "ranking-customer-biggers" para consulta do valor dos 5 maiores clientes.
 Image Added
Imagem 3 - Demonstração da consulta do valor de clientes com maior atraso.
 Image Added
Imagem 4 - Demonstração do retorno da consulta da API referente ao endpoint "ranking-customer-debtors" para consulta do valor recebido atrasado dos 5 maiores clientes.
|
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | passo11 |
|---|
|  Image Added
Imagem 1 - Demonstração do retorno da consulta da API referente ao endpoint "ranking-supplier-biggers" para consulta do valor dos 5 maiores fornecedores.
 Image Added
Imagem 2 - Consulta no componente FCPFL028 referente ao mesmo período "Dt. chegada" da consulta realizada via API, considerando apenas duplicatas com o tipo de previsão "Real".
 Image Added
Imagem 3 - Demonstração do retorno da consulta da API referente ao endpoint "ranking-supplier-debtors" para consulta do valor dos 5 fornecedores mais devedores.
 Image Added
Imagem 4 - Consulta do componente FCPFL028 listando os 5 fornecedores mais devedores. |
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | passo12 |
|---|
|  Image Added
Imagem 1 - Demonstração do retorno da consulta da API referente ao endpoint "financial-income-statement" para consulta da DRF no regime de caixa, para exemplificar iremos pegar os valores de receita total de vendas.
 Image Added
Imagem 2 - Consulta no componente FCRFL046 referente ao mesmo período e no regime de caixa da consulta realizada via API.
 Image Added
Imagem 3 - Demonstração do retorno da consulta da API referente ao endpoint "financial-income-statement" para consulta da DRF no regime de competência, para exemplificar iremos pegar os valores de receita total de vendas.
 Image Added
Imagem 4 - Consulta no componente FCRFL046 referente ao mesmo período e no regime de competência da consulta realizada via API. |
|
04. DEMAIS INFORMAÇÕES
