Service Layer de interação Tributos

Integração de Lançamentos

  • Visão Geral

O serviço de integração disponibilizado permite que sejam gerados lançamentos no Tributos (Cloud) vinculados a três classificações diferentes de referentes, são eles:

  • Econômicos;
  • Contribuintes;
  • Receitas diversas.

Para lançamentos por econômico ou contribuinte, é necessário sempre informar o valor lançado diretamente.

Para  as receitas diversas, seguindo o mesmo funcionamento da funcionalidade no Tributos (Cloud), é possível gerar o lançamento informando diretamente o valor lançado, ou informar os dados necessários para que seja executada uma fórmula de cálculo que defina o valor das receitas do lançamento.

  • Configuração

O primeiro passo para utilizar a ferramenta é fazer a configuração dos tipos de lançamentos que serão gerados pelo serviço, vinculando-os com seus respectivos créditos tributários.

A configuração pode ser acessada por meio do menu Utilitários > Central de configurações > Integração de lançamentos > Sistemas de terceiros.

Nessa tela, deve ser adicionada uma configuração para cada tipo de lançamento a ser gerado, definindo os campos:

  • Tipo de lançamento no sistema parceiro: Campo que define uma chave única para o tipo de lançamento a ser gerado.
  • Referente: O tipo de referente do lançamento (econômico, contribuinte ou receita diversa).

Para lançamentos de receitas diversas com os valores definidos por fórmula de cálculo, é necessário informar o campo Tipo de serviço. Os tipos de serviço são configurados na configuração de Receitas diversas, também presente na Central de configurações, onde é feito o vínculo entre os créditos tributários e os tipos de serviço (agrupamentos).

Voltando ao serviço de integração, ao ser selecionado um tipo de serviço no cadastro da configuração, o campo crédito é resgatado automaticamente (conforme a configuração de receitas diversas).

Para lançamentos de receitas diversas com os valores informados diretamente (sem execução de fórmula), lançamentos de econômicos ou lançamentos de contribuintes, é necessário informar na configuração de integração os campos:

  • Crédito: O crédito tributário do lançamento
  • Receita: A receita para qual o valor principal do lançamento será lançado

Os seguintes campos também devem ser informados independentemente do tipo de referente:

  • Taxa de expediente: opcional, para os lançamentos que possuem um valor de taxa de expediente vinculado ao lançamento do valor principal.
  • Convênio: O convênio contendo os dados que serão utilizados no processo de emissão da guia (documento) do lançamento gerado.
  • Sistema de origem: Identificação do sistema que originou o lançamento, para ser demonstrado no módulo Atendimento do Tributos (Cloud).
  • Receitas diversas por Tipo de serviço (execução de fórmula)

Para o funcionamento da integração de lançamentos referentes as receitas diversas, com valor definido pela execução de fórmula de cálculo, além da configuração da integração, é necessário que haja uma fórmula de cálculo cadastrada no Tributos (Cloud) para o crédito tributário vinculado ao tipo de serviço informado na configuração, e para o ano de lançamento recebido no corpo da requisição de integração.

O serviço de integração permite que sejam passados para a fórmula parâmetros customizados conforme os padrões de campos adicionais do Tributos (Cloud), conforme o exemplo a seguir:

Tendo o cenário acima de campos adicionais no cadastro de receitas diversas, os mesmos valores seriam informados da seguinte forma pelo serviço (no formato JSON):

A chave de cada campo no mapa de “camposAdicionais” deve ser o “título” do campo adicional no Tributos (Cloud), o qual pode ser informado:

  • exatamente como está no Tributos (com a mesma acentuação e espaçamento)
  • no formato normalizado: sem qualquer acentuação, sem caracteres especiais e sem espaçamentos, alterando a primeira letra seguinte à cada espaço para caixa alta)

Já o valor do campo deve ser informado entre aspas duplas, mesmo quando for numérico. Para campos de seleção (opções predefinidas), deve ser informado o “título” de cada campo, seguindo as mesmas regras de título já exemplificadas, separando-os por vírgula (caso haja mais de um campo selecionado no campo adicional do tipo Múltipla Opção).

  • Documentação dos serviços