Agora no Bluesoft ERP, é possível incluir, consultar e fazer manutenção de benefícios fiscais via API

A fim de permitir a automação do processo de cadastro e atualização de benefícios fiscais, que antes estava disponível apenas através da interface gráfica do ERP, disponibilizamos novos endpoints na nossa API.

Através do cadastro de Benefícios por UF da NFe é possível incluir os códigos utilizados pelos Estados na tag <cBenef> do XML da nota fiscal eletrônica, além de criar o vínculo entre produtos/bens e o respectivo código de benefício.

Novos Endpoints Disponíveis:

  • Consultar Benefícios (GET /api/fiscal/beneficio-uf): Permite a consulta parametrizada de benefícios fiscais filtrando por uf, codigoBeneficioFiscal ou descricao.
  • Cadastrar Benefício (POST /api/fiscal/beneficio-uf): Criação de novos registros de benefícios. A requisição exige o envio da UF, Código, Descrição, CFOPs, datas de vigência CST (de cst00 a cst90).

Exemplo de de JSON:

{
    "uf": "CE",
    "codigoBeneficioFiscal": "CE3641",
    "descricao": "TESTE VIA API",
    "observacao": "TESTE VIA API",
    "cfops": [
        26949,
        1202
    ],
    "dataVigenciaInicial": "12/02/2026",
    "dataVigenciaFinal": "20/05/2026",
    "cst00": true,
    "cst10": false,
    "cst20": true,
    "cst30": false,
    "cst40": false,
    "cst41": true,
    "cst50": false,
    "cst51": true,
    "cst60": false,
    "cst70": true,
    "cst90": false
}
  • Vincular Produtos (PUT /api/fiscal/beneficio-uf/{beneficioFiscalKey}/vincular-produtos): Permite a associação em lote de produtos às regras de benefícios. Este vínculo ocorre de forma assíncrona.

Exemplo de JSON:

{
    "produtoKeys": [
        375461
    ]
}
  • Desvincular Produtos (POST /api/fiscal/beneficio-uf/{beneficioFiscalKey}/desvincular-produtos): Remove a associação de produtos específicos, mantendo a regra de benefício ativa para os demais itens.

Exemplo de JSON:

{
    "produtoKeys": [
        375461
    ]
}
  • Consultar Produtos Vinculados (GET /api/fiscal/beneficio-uf/{beneficioFiscalKey}/produtos): Retorna a lista de produtos (por produtoKey) vinculados a um código de benefício fiscal.

Regras e Validações da API:

  • Unicidade: O sistema impede estritamente a duplicidade, não permitindo cadastrar o mesmo código alfanumérico para a mesma UF.
  • Conflito Fiscal: Um mesmo produto não pode estar vinculado a mais de um Código de Benefício Fiscal vigente no mesmo Estado (UF) se compartilharem os mesmos CFOPs.
  • Vigência: A Data de Vigência Inicial deve ser obrigatoriamente menor ou igual à Data Final.

Permissões Necessárias: Para utilizar os novos recursos, o usuário precisa possuir as seguintes permissões de acesso liberadas:

  • 4482 – API Benefícios por UF (Consultar)
  • 4483 – API Benefícios por UF (Incluir)
  • 4484 – API Benefícios por UF (Excluir)

Para conhecer mais sobre como é a utilização dessa ferramenta, clique aqui.

Para saber mais sobre a utilização das APIs do ERP, clique aqui.

Disponível a partir da versão r367.01