Documentação Geral

Vale a pena relembrar


     

    Vale a pena relembrar

    API Acompanhamento da regra

    Por Pedro Silva

     

    A API Acompanhamento da regra tem como função permitir o acompanhamento desde a criação até a entrega da regra. Com isso os parceiros e clientes tem um grande ganho, pois caso haja necessidade de algum ajuste ou correção, será possível identificar sem ter que aguardar até o final do tempo de processamento da regra.

    A consulta ao status da regra é realizada em 2 etapas, primeiro você deve realizar a criação da consulta, após a criação da consulta a API vai retornar uma mensagem com o ID da consulta. Com esse ID, você consegue realizar a chamada para consultar o status desta regra.

    Como realizar a criação da consulta?

    1. A autenticação da API é realizada através do Bearer Token, utilizando o usuário e senha fornecidos pela Systax.

     

     

    1. Após a autenticação, para realizar a criação da consulta devemos informar o ID do cenário, código do produto, origem do produto e data de referência que a consulta está sendo feita. Realizada a chamada corretamente, a API vai retornar uma mensagem de sucesso com um id_consulta.

     

     

     

    1.  Com o id_consulta, você consegue realizar a chamada para consultar o status desta regra, bastando informar o id_consulta na chamada. Caso a API não tenha processado a solicitação, ela vai retornar uma mensagem informando que ainda está em processamento. Por outro lado, se o processamento já foi finalizado, ela vai trazer o status da regra conforme exemplo abaixo.

     

    1. Em nossa documentação temos uma lista com todos os códigos e detalhamento dos status.

     

     


    URL da documentação:

    https://documentacao.systax.com.br/PublicView2/Index/2a3c990310a1f2574324c8218/30608

    A importância deste documento é demonstrar, de forma prática, como realizar a consulta do status da regra.

     

     

     

    Tax Validator NFE

    Por Rafael Sena

     

    O Tax Validator faz a comparação entre os dados da Nota fiscal eletrônica com os cálculos produzidos pelo motor de cálculo a partir da regra tributária, seja parametrizada previamente na base de dados do cliente ou parceiro, ou via regra On Demand.

     

    Etapas da análise após envio do XML

     

    - Interpretação dos dados da Nota fiscal eletrônica para identificar produto e cenário.

    - Utilização dos parâmetros para buscar uma regra no cockpit.

    Observação: Caso não encontre regra com os parâmetros da Nota fiscal eletrônica no Cockpit, é possível utilizar o recurso On Demand, que produz uma regra na hora, a partir dos dados que foram identificados.

    - Motor de cálculo utiliza a regra como insumo e refaz os cálculos dos impostos.

    - Gera relatório comparativo, exibindo tanto os dados da Nota fiscal eletrônica, quanto os que foram gerados pela Systax para validação.

     

    Como identifico quais os campos da Nota fiscal eletrônica e os da Systax no retorno da API?

     

    As Tags iniciadas com “nFe_” são as da Nota fiscal eletrônica e as tags iniciadas em “tax_" são referentes ao que a Systax entende como correto.

     

    Como realizar a chamada na API?

    1. Utilize o método GET e informe o endpoint http://app.systax.com.br/auth/access-token/ para obter o Token.

     

     

    1. Utilize o método POST e informe o endpoint https://wscockpit.systax.com.br/api/api/TaxValidator e o XML na íntegra dentro das aspas simples para realização da chamada da API.

      Requisição: 

    {“documento”:’Colar XML’}

     

    Retorno da chamada.

     




    Informações que você irá encontrar no relatório conforme o print acima:

     

    - Quantos itens contém na Nota fiscal eletrônica.
    - Quantos itens efetivamente foram validados.

    - Os retornos vêm divido por blocos de informações de tributos que são: ICMS, ICMSST, PIS, COFINS, IPI e ICMSUFDEST.

    - No Início de cada bloco é informado quais os campos que apresentou diferença de valores e percentuais.

    - No final de cada bloco é informado o valor da diferença.

    - Tag que identifica em qual base foi gerada a regra, base do cliente ou On Demand.

     

    URL da documentação

    https://documentacao.systax.com.br/PublicView2/Index/f8bdb58b2ea813b38dfc5e844/57801
     

    A importância deste tópico é demonstrar de uma forma prática o que é o Tax Validator NFE e como utilizar a API.

    Voltar


Versão do documento: 51 Publicação: 12/28/2023