Documentação Geral
API – API Online (on demand) – Busca de cenário
API Online (on demand) – Busca de cenário
Por Fernanda Penhorate
A API online, também conhecida como on demand, não necessita que exista um cenário para calcular uma operação, pois com os parâmetros recebidos na chamada ela busca regras, considerando que é um cálculo que acontece “real time” e os dados são suficientes para busca de regras.
Todavia, existem particularidades que podem interferir no retorno tributário, como por exemplo: no caso de cenários já criados em nossas bases com o campo “config produto adicional” preenchido, é adicionado o ID indicado nele na configuração do produto no cálculo, e quando é realizado o cálculo via API, não observa essa informação, consequentemente não adicionando no cálculo esse ID adicional.
Para resolver isso criamos na API um novo campo “busca_cenario”, que, preenchido com o valor ‘1’ antes de calcular a operação com os dados recebidos na chamada, buscará na Base Centralizada se existe um cenário com os parâmetros recebidos.
Se houver e o campo “config produto adicional” contiver a indicação de um ID Produto, este será considerado na configuração do produto, para complementar a configuração da operação.
Caso o novo campo não seja enviado com nenhum valor nesse campo, o cálculo da API continuará buscando a partir dos dados da chamada, sem busca de cenários na base centralizada.
Assim, conseguimos trazer resultados mais específicos para as diversas operações de nossos clientes e parceiros.
Online API (on demand) – Scenario search
By Fernanda Penhorate
The Online API, also known as on demand, doesn’t need an operation scenario to exist in order to perform the calculation, because it can look for rules based on the parameters received from the request call, considering that it’s a calculation that happens in real time, and the data provided is enough to search the tax rules.
However, there are particular situations that may interfere with the tax return, as for example: in case where the existing scenario in our base has the field “config produto adicional” filled, which adds a product ID to the configuration of the calculated product, when the API performs the calculation it does not observe this information, consequentially not adding the additional product ID and thus not returning the accurate return.
To solve this problem, we created a new field in the API called “busca_cenario” that, when filled with the value ‘1’ before performing the calculation, will look up an existing scenario in the Centralized Base with the received parameters from the request call.
If it finds a scenario, and it has the “confic produto adicional” field filled with a product ID, this will be considered in the product configuration, to complement the operation.
If the new “busca_adicional” field is not sent with any value in the request call, the API calculation will continue to look up information based on the request call data, without looking at scenarios from the Centralized Base.
This way, we can bring more specific results to the various operations from our clients and partners.
Versão do documento: 74 | Publicação: 9/20/2024 |