Definições do Simulador
A API foi desenvolvida para indicar o melhor custo de aquisição na operação de compra, considerando as diversas combinações de fornecedores e destinatários e comparando com o valor já conhecido por uma compra de fornecedor habitual.
E, na mesma chamada, formar a operação de saída, considerando que os destinatários da operação de compra passam a ser os remetentes nessa operação, será incluída a margem de lucro, o frete, se houver, embutindo todos os tributos da operação e formando assim o Preço de Venda.
A API é dividida em 4 blocos de informações:
- cabeçalho
- produto
- compradores
- fornecedores novos
Cabeçalho:
Deve ser enviado a data de cálculo que será simulação a operação, e alguma "marcação" no genérico, caso houver.
Produto:
A simulação é sempre feita para 1 produtos apenas por chamada.
Compradores:
No bloco "Compradores" será inserido os dados do "fornecedor" (também denominado "fornecedor habitual"), o "comprador" e o "cliente".
O campo "cliente" poderá ser simulada somente com 1 registro.
O campo "compradores" pode ser simulada com até 20 registos por chamada.
As informações relativas ao "fornecedor" não é obrigatório preencher, desde que seja enviado dados de "fornecedores novos", ao menos 1 registro.
Fornecedores Novos:
Os dados do bloco "fornecedores novos" não são obrigatórios, desde que as informações do "fornecedor habitual" contido no bloco "compradores" seja enviado.
Se for enviados dados, serão simuladas as compras com cada um dos "compradores" enviados.
Por exemplo: se forem enviados 5 compradores, e 10 fornecedores novos, será simulada 10 chamadas de compras entre os "fornecedores novos" x "compradores", resultando em 50 simulações de compras para esse caso.
Além disso, a cada fornecedor novo informado deverá ser indicado o valor da operação (gross ou net, conforme o caso) para cada um dos "compradores", pois cada negociação entre fornecedores e compradores podem ter valores diferentes.
Exemplo prático:
Mas é importante ressaltar que a simulação também pode ser feita de uma única operação, e nesse caso como retorno será informado o "custo de aquisição" e "preço de venda" de uma unica operação, sem os "fornecedores novo" o objetivo a API é apenas formar preço de operações habitualmente praticadas.
A API é assincrona e funciona com um conjunto de 4 endpoints, conforme indicado em "acessos", e cada um tem o seguinte propósito:
- Enviar os dados para simulação (endpoint "solicitação");
- Consultar o status do protocolo, ou seja, enviar o ID protocolo para acompanhar se o resultado ja está pronto (endpoint "status do protocolo");
- Retorno da simulação, neste retorno é apresentado o resultado principal das operações, ou seja "custo de aquisição" das operações de compra, e "preço de venda" da operação de venda (endpoint "retorno");
- Consulta de todo cálculo tributário das operações simuladas (endpoint "detalhamento tributário). A consulta nesse endpoint é através do "sessionID" retornado na API de "retorno".