STM - Publicações

Artigos destinados aos Usuários do STM e Parceiros.

(Manual) Sistema E-ISS

Acessando o Sistema E-ISS

O Sistema Eletrônico de ISS (e-ISS) proporciona ao contribuinte segurança, agilidade e comodidade na utilização do sistema para emissão de Nota Fiscal Eletrônica.

O sistema de e-ISS permitirá que o prestador de serviços a:

Este manual apresenta todas as funcionalidades disponíveis pelo sistema, conforme as disposições legais de cada município.

Não tenho senha

Para Mobiliário e Contador

Se deseja emitir Nota Fiscal de Prestação de Serviços e sua empresa ainda não está autorizada, o mobiliário deverá comparecer na Prefeitura, no setor de Fiscalização e solicitar cadastro.

Para Guias de Recolhimento Avulsas

Passo a passo:

  1. Ao acessar o endereço disponibilizado pelo site da Prefeitura da sua cidade, informe seu Usuário e Senha e clique em Entrar.

  2. Sistema apresenta a página inicial do sistema. Clique em Guias de Recolhimento Avulsas.

  1. Clique na opção “Ainda não possui cadastro? Clique aqui.”
  2. Preencha todos os campos obrigatórios e aguarde o e-mail com o login e senha em sua caixa de emails.

Esqueci minha senha

Calma, nós podemos te ajudar.

Passo a passo:

  1. Ao acessar o endereço disponibilizado pelo site da Prefeitura da sua cidade, clique em qualquer um dos serviços oferecidos: NFS-e, Escrituração de Serviços Prestados ou Escrituração de Serviços Tomados ou Escrituração Especial ou Guias de Recolhimento Avulsas.
  2. Caso você já tenha cadastro na Prefeitura, mas esqueceu sua senha, clique no link “Não sabe sua senha? Clique Aqui”.
  3. Para solicitar ou recuperar a sua senha, preencha os campos CPF/CNPJ e Email e clique no botão “Requisitar”.

Múltiplo CCM

Quando a empresa tem mais de uma filial, ao digitar o CNPJ, sistema apresenta campo CCM, exigindo o preenchimento do mesmo.

  1. Preencha os campos CPF/CNPJ, CCM e Senha e clqiue o botão "Entrar".

Importante: Contribuinte deverá se atentar ao digitar corretamente o CCM, exemplo: 001234.

Serviços ao Contribuinte

Emissão de Nota Fiscal Eletrônica de Serviços Prestados

Sua empresa deve estar autorizada a emitir Notas Fiscais Eletrônicas de Prestação de Serviços, caso contrário, compareça à Prefeitura e procure pelo setor de fiscalização

Importante: Antes de iniciar a emissão de NFS-e confira se seus dados cadastrais e enquadramento de suas atividades estão corretos no sistema. Caso existir divergências, entre em contato com a Prefeitura para proceder a atualização dos dados.

Passo a passo:

  1. Ao acessar o endereço disponibilizado pelo site da Prefeitura da sua cidade, na página inicial do sistema, clique no serviço Nota Fiscal Eletrônica.
  2. Na tela de login de mobiliários, informe o “CNPJ/CPF”, “Senha” e clique no botão “Entrar”.
  3. Sistema apresenta a tela inicial do sistema e-ISS.

  1. No canto superior direito da tela, o sistema possui um atalho para selecionar o Período Fiscal.
  2. Clique no período fiscal apresentado na tela e selecione o novo período que deseja consultar.
  3. Clique na opção “NFS-e” do menu superior ou clique no botão “Nota Eletrônica” localizado no centro da tela em "Escrituração".
  4. Sistema apresenta as Notas Fiscais emitidas no período selecionado.

Importante: Você não pode criar um período fiscal maior que o mês corrente.

Importante: A criação de Notas Fiscais eletrônicas só é permitida para o período relativo ao mês atual.

Importante: A numeração da nota fiscal é automática.

Importante: Confira as informações nesta tela antes de emitir a NFS-e, evitando a emissão incorreta de notas fiscais. Caso haja alguma divergência, entre em contato com a prefeitura para procedimentos de atualização.

  1. Para emitir uma nota fiscal, clique no botão “+Emitir Nota Eletrônica”.
  2. Sistema apresenta tela para inclusão de Nota Fiscal. Na aba "Tomador", preencha todos os campos obrigatórios com os dados do Tomador e clique no botão “Avançar”.
  3. Na aba "Serviço", informe todos os campos obrigatórios com os dados do Serviço Prestado e clique no botão “Incluir Itens” representado por (+).

Importante: Caso seja informado um CNPJ, haverá a possibilidade de informar se o mesmo é MEI ou Produtor Rural. Caso o tomador se enquadre numa dessas opções, não deixe de informar para que o sistema trate corretamente a questão da retenção do ISS.

Importante: Se o serviço for prestado no exterior, o resultado será definido com “Exterior” e o ISS não será tributado.

Importante: Se o serviço for prestado no Brasil e o resultado (efeito) do serviço foi no Exterior, o ISS também não será tributado.

Importante: Se o serviço for prestado no Brasil e seu resultado (efeito) for no Brasil, o ISS será tributado e devido ao prestador.

Importante:
Art. 2° O imposto não incide sobre:
I - As exportações de serviço para o exterior do país;
Parágrafo único: Não se enquadram no disposto no inciso I os serviços desenvolvidos no Brasil, cujo resultado aqui se verifique, ainda que o pagamento seja feito por residente no exterior.

  1. Na tela Editar Item de Serviço, informe os campos: Quantidade, Valor Unitário e Descrição do Serviço Prestado. Clique no botão “Gravar”.

  2. Confirme se todos os campos do Serviço Prestado estão preenchidos e clique no botão “Avançar”.

  3. Na aba "Valores", informe as retenções do serviço prestado:

Importante: Empresas Optante pelo Simples não são obrigadas a efetuar as retenções.

  1. Na aba "Confirmação", informe o valor do Tributo (Municipal e Federal) conforme o IBPT, Vencimento e Observações e clique no botão “Gravar”.

Importante:
A Lei n.º 12.741/2012 estabelece que, na nota fiscal ou documento equivalente, fornecida ao consumidor, deverá constar, obrigatoriamente, o valor aproximado dos tributos federais, estaduais e municipais que incidem no caso e que influenciam na formação do preço do produto ou serviço.

  1. Sistema apresenta a visualização da Nota Fiscal emitida. Para a impressão da mesma, clique no botão "Imprimir".
  2. No botão “Ações”, sistema permite encaminhar a Nota fiscal por email. Basta clicar na opção “Encaminhar”.
  3. Preencha os campos obrigatórios e envie a nota recém escriturada ao tomador. Clique no botão "Enviar e-Mail".

Importante: Confirme sempre se o e-mail do tomador está atualizado, pois o sistema enviará notificações de notas emitidas para o mesmo.
O tomador poderá visualizar e imprimir a Nota Fiscal com os dados recebidos na mensagem através da opção “Autenticidade NFS-e” na página principal.

Exportar arquivo de Nota Fiscal em .XML

O sistema permite a exportação da Nota Fiscal em .XML estruturada conforme o layout pré-definido pela Prefeitura.

Importante: Use esse recurso apenas se for uma empresa do município.

Passo a passo:

  1. Ao acessar o endereço disponibilizado pelo site da Prefeitura da sua cidade, na página inicial do sistema, clique no serviço Nota Fiscal Eletrônica.
  2. Na tela de login de mobiliários, informe o “CNPJ/CPF”, “Senha” e clique no botão “Entrar”.
  3. Sistema apresenta a tela inicial do sistema e-ISS.
  4. Clique em “Períodos” no menu superior ou no botão “Períodos Fiscais” de Escrituração localizado no centro da tela.
  5. O sistema apresenta a tela “Detalhes do Período Fiscal”. Selecione o período que deseja.

  1. Clique no botão “Engrenagem” e selecione a opção “Exportar XML”.

  1. O sistema cria um arquivo no formato .XML, seguindo as seguintes especificações:

TIPOS DE DADOS
Os tipos de dados utilizados nesta especificação deverão seguir os seguintes critérios:

Obs.: Alguns campos têm apenas a função de agrupar outros campos e, portanto, não são tipificados. Exemplo: <NOTA_FISCAL>, <DADOS_PRESTADOR>, <DADOS_TOMADOR> etc

LEIAUTE DO SISTEMA:

Elemento Tipo de Dados Observações
NFES e-ISS - Início do elemento raiz de exportação. Contém informações relativas ao arquivo.
NOTA_FISCAL - Agrupador de Nota Fiscal Eletrônica
SERIE_NOTA Alfa Numérico Série da NFS-e
NUMERO_NOTA Inteiro Número da NFS-e
EMISSAO Alfa Numérico Informa a situação de emissão da nota. Ativa , Cancelada , Substituída, Anulada, Retificada ou Excluída
DATAEMISSAO Data Data de emissão da NFS-e
DATAVENCIMENTO Data Data de vencimento da NFS-e
AUTENTICIDADE_NF Alfa Numérico Código de Autenticidade da NFS-e, para verificação posterior.
SIMPLESNACIONAL Alfa Numérico Informa se a NFS-e está sujeita ao Simples Nacional: Sim ou Não
ISSRETIDO Alfa Numérico Informa se o ISS na nota está sujeito a retenção pelo tomador: Sim ou Não
ISSISENTO Alfa Numérico Informa se o ISS é isento: Sim ou Não
ISSNAOTRIB Alfa Numérico Informa se o ISS não é tributado no Município: Sim (não tributado) Não (Tributado)
ISSFORAMUN Alfa Numérico Informa se o ISS é devido fora do município do prestador: Sim ou Não
SISTEMAGERADOR_NF Alfa Numérico Informa o sistema que gerou a NFS-e, no caso, NFSE.
DADOS_PRESTADOR - Agrupador de informações do Prestador de Serviço
CPF_PRESTADOR Alfa Numérico CPF do prestador de serviço. Não será listado caso o prestador tenha CNPJ.
CNPJ_PRESTADOR Alfa Numérico CNPJ do prestador de serviço. Não será listado caso o prestador tenha CPF.
INSCRMUNICIPAL_PRESTADOR Alfa Numérico Inscrição municipal do Prestador de Serviço
INSCRESTADUAL_PRESTADOR Alfa Numérico Inscrição estadual do Prestador de serviço
CNAE_PRESTADOR Alfa Numérico CNAE Principal do Prestador de Serviço
CNAE_ATIVIDADE Alfa Numérico Descrição do CNAE principal do prestador de serviço
NOME_PRESTADOR Alfa Numérico Nome / Razão Social do Prestador de Serviço
ENDERECO_PRESTADOR Alfa Numérico Endereço do Prestador de serviço
BAIRRO_PRESTADOR Alfa Numérico Bairro do Prestador de serviço
CEP_PRESTADOR Alfa Numérico CEP do Prestador de serviço
CIDADE_PRESTADOR Alfa Numérico Cidade do Prestador de serviço
UF_PRESTADOR Alfa Numérico UF do Prestador de serviço
FONE_PRESTADOR Alfa Numérico Fone do prestador de serviço
EMAIL_PRESTADOR Alfa Numérico E-mail do prestador de serviço. Último campo do agrupador <DADOS_PRESTADOR>
DADOS_TOMADOR - Agrupador de dados do Tomador do Serviço
PESSOAFISJUR_TOMADOR Alfa Numérico Informa se a pessoa é Fisica, Juridica ou Indefinida (sem informação)
CCM_TOMADOR Alfa Numérico Cadastro municipal do Tomador de Serviço, no município do prestador (se houver)
CPF_TOMADOR Alfa Numérico CPF do tomador de serviço. Não será listado caso o tomador tenha CNPJ.
CNPJ_TOMADOR Alfa Numérico CNPJ do tomador de serviço. Não será listado caso o tomador tenha CPF.
INSCRESTADUAL_TOMADOR Alfa Numérico Inscrição estadual do Tomador de serviço
NOME_TOMADOR Alfa Numérico Nome / Razão Social do Tomador de Serviço
ENDERECO_TOMADOR Alfa Numérico Endereço do Tomador de serviço
BAIRRO_TOMADOR Alfa Numérico Bairro do Tomador de serviço
<CEP_TOMADOR> Alfa Numérico CEP do Tomador de serviço
<CIDADE_TOMADOR> Alfa Numérico Cidade do Tomador de serviço
<UF_TOMADOR> Alfa Numérico UF do Tomador de serviço
<PAIS_TOMADOR> Alfa Numérico País do Tomador de serviço
<FONE_TOMADOR> Alfa Numérico Fone do Tomador de Serviço
<EMAIL_TOMADOR> Alfa Numérico E-Mail do Tomador de Serviço. Último Item do agrupador <DADOS_TOMADOR>
<CODSERVICO> Alfa Numérico Código do serviço prestado, conforme
definido na Lei Complementar 116. São fornecidos os 4 dígitos, sem pontuação.
<DESCRICAOSERV> Alfa Numérico Descrição do serviço prestado, conforme definido na Lei Complementar 116.
<ITENS> - Agrupador dos Itens da NFS-e
<ITEM> - Agrupador de um item específico.
<ORDEM> Inteiro Número do item na ordenação dos itens cadastrados. Começa em 1 e segue conforme disposição dos itens na NFS-e.
<QUANTIDADE> Decimal Quantidade informada para o item em questão.
<VALOR_UNITARIO> Decimal Valor unitário designado para o item em questão. Possui quatro (4) casas decimais).
<DESCRICAO> Alfa Numérico Descrição do Item em questão.
<VALOR_TOTAL> Decimal Valor total do item, oriundo da multiplicação da quantidade pelo valor unitário. Possui duas (2) casas decimais. Último item do agrupador <ITEM>, ao final dos itens encerra o agrupador <ITENS>
<VALORNOTA> Decimal Valor total da NFS-e, composto da soma dos valores totais dos itens.
<DEDUCAO> Decimal Dedução informada.
<VLSERVICO> Decimal Valor do serviço, considerado o valor total da NFS-E descontada a dedução informada.
<ALIQUOTAISS> Decimal Alíquota do ISS informada para execução do serviço, contém quatro (4) casas decimais.
<VALORISS> Decimal Valor calculado do ISSQN devido.
<VALORISSRETIDO> Decimal Valor do ISSQN a ser retido na fonte pelo tomador de serviço.
<VALORPIS> Decimal Valor do PIS Informado
<VALORCOFINS> Decimal Valor do COFINS Informado
<VALORCSLL> Decimal Valor da CSLL Informado
<VALORIRRF> Decimal Valor do IRRF Informado
<VALORINSS> Decimal Valor do INSS Informado
<VALOROUTRASRETENCOES> Decimal Valor para outras retenções informadas.
<OBSERVACOES> Alfa Numérico Observações inseridas no preenchimento da NFS-e.
<NUMERORPS> Alfa Numérico Número da RPS informada

Protesto Cartório CRT - Cebi Informática

Acessando o sistema

Acessar Sistema

Passo a passo:

  1. Acesse o endereço informado pela Prefeitura: xxxxxxpref.cebiclou.com.br e clique no botão "Controle de Remessa Tributação".
  2. Informe seu usuário e senha e clique em "Entrar".

Esqueceu sua senha?

Passo a passo:

  1. Sem problemas, clique em "clique aqui" para recupera-la.
  2. Informar seu usuário de cadastro e clicar em “Enviar solicitação”.

Tela inicial

Sistema permite a inclusão de títulos para protesto ou para execução fiscal.

Protestos cartório

Sistema permite incluir protesto cartório crt.

Passo a passo:

  1. Para criar uma remessa, clique no menu “Protestos Cartório”, selecione a opção “Inclusão de títulos na Remessa”.

  2. Selecione o cartório no campo “Destino da Remessa”.

  3. Selecione o tipo contribuinte e clique em “Filtrar”.

  4. Sistema apresenta as certidções de dívida ativa. Selecione os títulos que deseja incluir na remessa e clique no botão “Incluir CDA's na remessa”.

Importante: É possível atualizar o valor de uma CDA utilizando o botão na lista de CDA’s.

Importante:  Sistema permite atualizar mais de uma CDA simultaneamente. Para isso, basta selecionar as CDA's e clicar no botão "Atualizar Valor das CDA's Selecionadas".

Excluir remessa

Passo a passo:

  1. Na tela de Protesto Cartório CRT, selecione o Destino de Remessa e clique em “Detalhes”.

Importante: Quando uma CDA é colocada em uma remessa, ela passa a ser chamada de "Título"

  1. O sistema apresenta os título em aberto. Para excluir, clique no botão “Excluir” representado pela lixeira.

Importante: É possível atualizar o valor da CDA utilizando o botão na lista de Títulos da Remessa.

Lista de títulos pagos

Passo a passo:

  1. No menu lateral “Protestos Cartório”, escolha a opção “Lista de Títulos pagos”.

  2. Sistema apresenta a lista dos protestos quitados na prefeitura.

Remessas

Lista de remessas

Passo a passo:

  1. Para enviar ou editar uma remessa aberta é necessário selecionar o menu “Remessas” e escolha a opção “Lista de remessas”.

  2. Na tela de Filtros, selecione o Destino da Remessa e clique em “Filtrar”. O sistema apresenta uma lista de todas as remessas realizadas.

Cancelar títulos

Passo a passo:

  1. Na lista de Remessas, clique no número do lote que deseja cancelar um título.

  2. Na tela Títulos de Remessa, selecione o título que deseja cancelar e clique no botão “**Cancelar Tributos **”.

Importante: Sistema permite cancelar mais de um título ao mesmo tempo.

Integração Software ISS externo - Funcionamento da API (Boletos, Pagamentos, Cadastro)

Objetivo:

Documentação das credenciais e informações para a API de integração do ISS, para conhecimento do time e fornecimento de informações a terceiros que desejam se integrar ao ISS.

Serão 3 os tipos de integração disponíveis entre o Sistema Tributário (STM) e os sistemas de ISS Eletrônico e Escrituração externos:

  1. Recepção de boletos e cancelamentos de boletos registrados pelo terceiro, para inclusão nas carteiras dos contribuintes e possibilitar baixa nos pagamentos.
  2. Envio de cadastros e alterações de cadastro realizadas no sistema Tributário STM para o terceiro, de forma a possibilitar a atualização dos cadastros com base ao cadastro tibutário.
  3. Envio de Pagamentos realizados no ssitema STM para informação de compensação dos boletos encaminhados previamente.

As permissões para acesso aos serviços é dada pela CEBI, com expressa autorização da Prefeitura (Chamado Técnico e/ou documentação apropriada).

Os serviços utilizam-se de Webhook para envio, em tempo real, das informações e do conceito de Fila para registrar todas as transações realizadas e informações trafegadas, de forma a facilitar a solução de problemas.

Conjuntamente ao serviço é disponibilizado um Painel de Integração para que os técnicos (Prefeitura e Atendimento à Prefeitura) possam fazer a consulta de dados trafegados e, conforme permissão, permitir o reprocessamento das informações.

Autenticação:

Esse tópico trata da autenticação no servidor de Login do ambiente Cebi, realizada através de chamadas HTTP.

Dessa forma, o Usuário de Integração Envia Credenciais, que passam pelo sistema Integrador (CEBI) - o qual valida as credenciais - e por sua vez retorna com o token (expirável) para que as informações de integração sejam validadas pela integração desejada (Boletos, Cadastro, Pagamento, Dívida Ativa).

Endpoints:
URL Método
http://agenciavirtual.cebicloud.com.br/login/connect/token POST
Headers:

Content-Type: application/x-www-form-urlencoded

Campo Conteúdo
grant_type client_credentials
client_id Será informado pela CEBI
client_secret Será informado pela CEBI
scope Cebi.Api

Emissão de Boletos:

Uma vez com as credenciais obtidas/autenticadas, o boleto deverá ser enviado para recebimento/processamento:

Cancelamentos de boletos devem ser feitos em endpoint específico.

Endpoints:
URL Método
http://agenciavirtual.cebicloud.com.br/integracao_iss/boletos POST
Conteúdo:

O Conteúdo deverá ser enviado no BODY da requisição como um objeto JSON, como nos campos descritos abaixo:

BOLETO CONTRIBUINTE CCM

Boletos emitidos para contribuintes do municipio (com CCM) deverão ser enviados dentro desta especificação, para criação do débito no nosso sistema.

Nome Tipo Descrição
ChaveGuia Numérico Número do Boleto
ChaveGuiaOriginal Numérico (OPCIONAL) Utilizado para 2a via
TipoBoleto Numérico 1 - Avulso, 2 - Encerramento, 3 - SegundaVia, 4 - Complementar, *Boletos do tipo “Cancelamento” deverão ser enviados ao endpoint de cancelamentos.
TipoTributacao Numérico 0 - Tomado 1 - Prestado
Ccm Alfa-Numérico
CpfCnpj Alfa-Numérico 000.000.000-00 (CPF) // 00.000.000/0000-00 (CNPJ)
ExercicioBase Numérico
Mes Numérico
DataEmissao Data
DataVencimento Data
ValorImposto Decimal
ValorMulta Decimal
ValorJuros Decimal
ValorCorrecao Decimal
NossoNumero Numérico
CadastroEventual Objeto Obrigatório em boletos emitidos para contribuintes de fora do municipio

CADASTRO EVENTUAL

Boletos emitidos para contribuintes de fora do municipio deverão, dentro do objeto do Boleto, ter um objeto chamado “Cadastro Eventual”, para criação no nosso sistema.

Nome Tipo Descrição
Ccm Numérico (OPCIONAL)
CpfCnpj Alfa-Numérico 000.000.000-00 (CPF) // 00.000.000/0000-00 (CNPJ)
RazaoSocial Alfa-Numérico
NomeFantasia Alfa-Numérico
TipoLogradouro Alfa-Numérico
Logradouro Alfa-Numérico
Numero Alfa-Numérico
Bairro Alfa-Numérico
Cep Alfa-Numérico
Complemento Alfa-Numérico
Cidade Alfa-Numérico
Estado Alfa-Numérico
Telefone Alfa-Numérico
CodigoServico Numérico (OPCIONAL)
DataInicialServico Data (Opcional)
DataFinalServico Data (Opcional)
Regime Alfa-Numérico

Cancelamento de Boletos:

Uma vez com as credenciais obtidas/autenticadas, o boleto deverá ser enviado para recebimento/processamento:

Endpoints:
URL Método
http://agenciavirtual.cebicloud.com.br/integracao_iss/boletos/cancelamento POST
Conteúdo:

O Conteúdo deverá ser enviado no BODY da requisição como um objeto JSON, como nos campos descritos abaixo:

Nome Tipo Descrição
ChaveGuia Numérico
Ccm Alfa-Numérico
CpfCnp Alfa-Numérico 000.000.000-00 (CPF) // 00.000.000/0000-00 (CNPJ)
DataCancelamento Alfa-Numérico

Retorno (Geral):

Em caso de sucesso, os endpoints retornaram um status code 200 e uma mensagem de operação concluída com sucesso.

Em caso de erros, retornará um status code 400, um código de erro (que poderá ser consultado a baixo) e uma breve descrição sobre o ocorrido.

Código Descrição Ocorrência
01 Não foi possível encontrar o contribuinte informado As informações fornecidas no que diz respeito ao contribuinte, não consistem com as que temos previamente cadastradas. Ou seja, recebemos CCM: 1 e CNPJ: X Mas na nossa base de dados não encontramos alguém com essa combinação de CCM e Documento
02 Data de Vencimento não informada
03 Boleto não encontrado para cancelamento
04 Boleto duplicado O Boleto informado já se encontra na nossa base de dados
05 Boleto não processado
06 Tipo de Boleto informado inválido Tipo de Boleto informado inválido
07 Boleto já está pago Não é possível cancelar um boleto que ja recebemos o pagamento

Integração API Extrato Judicial

Objetivo:

Documentação da API que fornece Extrato de atualização de Débitos Judiciais com base a autenticação e apresentação de Processo Judicial.

Os endpoints retornarão dois sets de infromações para o terceiro:

  1. Informações em JSON correspondentes ao solicitado;
  2. Formulário PDF (necessita de homologação da Prefeitura) para consumo e entrega a interessados.

A homologação do documento fornecido e seus dados específicos são de responsabilidade da Prefeitura Municipal em questão, sendo que os dados sensíveis disponibilizados serão somente aqueles autorizados pela Prefeitura para exibição.

Conceito:

Para funcionamento da ferramenta, é preciso que os números de Processo Cadastrados no STM sejam equivalentes aos requisitados pelo terceiro.

As permissões para acesso aos serviços é dada pela CEBI, com expressa autorização da Prefeitura (Chamado Técnico e/ou documentação apropriada).

Pode acontecer, em alguns casos, do número cadastrado no Sistema Tributário STM não serem os mesmos requisitados pela integração, nesse caso haverá tratamento de erro indicando a situação.

Para os casos onde o Processo for identificado no sistema, o STM fará diversas verificações de status:

  1. Verificação das carteiras correspondentes ao Processo Judicial;
  2. Verificação do Processo Administrativo equivalente ao Processo Judicial solicitado;
  3. Verificar qual é o cadastro correspondente e responder responsivamente se trata de um CCM, Inscrição de IPTU ou Documento, conforme o caso;
  4. Verificação se o processo solicitado é o último processo cadastrado na carteira;
  5. Verificação do tipo de Integração realizado com parceiro;
  6. Verificação do Processo Administrativo equivalente ao Processo Identificado;
  7. Os valores das dívidas processadas (se houver registro), ou o valor calculado das dívidas para a data do processo judicial;
  8. As baixas, cancelamentos, e outras situações de carteiras referentes às carteiras executadas;
  9. Os parcelamentos e reparcelamentos efetivados com base às dívidas;
  10. A situação das parcelas desse parcelamento;
  11. Caso o parcelamento tenha vários processos na sua composição, fará a identificação e extração da informação correspondente (principal baixas, pagamentos, etc.) somente ao Processo Requisitado;
  12. Verificará o endereço prioritário para o tipo de contribuinte necessário (se é Imóvel, se é CCM ou se é Pessoa) para exibição no relatório e nos dados disponibilizados.

Foi estabelecida rotina para que o sistema identifique de forma automática a situação completa da dívida e seus desdobramentos, para informação de resposta das APIs.

Quando há mais de um processo judicial cadastrado na carteira pesquisada, apenas o último (mais recente) será considerado como ativo.

Conflitos cadastrais não retornarão informações, ou seja, se não houver certeza dos valores a apresentar, a API não apresentará informações e retornará erro (verificar tabela de erros).

O terceiro fará conexão com o serviço através da obtenção de um token, seguido de uma requisição POST relacionada.

Através de todas essas operações desenvolvidas na API, o sistema fará a interpretação das informações e retornará os dados requisitados.

IMPORTANTE: Para cada terceiro integrador (ou seja, para cada sistema que utilize da API) e para cada cliente deverá ser desenvolvida sistemática de apuração dos valores de CDA, obedecendo as regras estabelecidas para aquela integração de CDA e ajuizamento, assim como as regras da própria Prefeitura em relação à apresentação de seus débitos e pagamentos e dados legados.

Autenticação:

Esse tópico trata da autenticação no servidor de Login do ambiente Cebi, realizada através de chamadas HTTP.

No modelo proposto, o Usuário de Integração Envia Credenciais, que passam pelo sistema Integrador (CEBI) - o qual valida as credenciais - e por sua vez retorna com o token (expirável) para que as informações de integração sejam validadas pela integração desejada (Extrato Judicial).

Endpoints:
URL Método
/login/connect/token POST

A primeira parte da URL depende do cliente e será disponiblizada para cada implantação conforme demanda à Infraestrutura.

Conteúdo:

Headers:

Content-Type: application/x-www-form-urlencoded

Campo Conteúdo
grant_type client_credentials
client_id Será informado pela CEBI
client_secret Será informado pela CEBI
scope Cebi.Api

Emissão de Extrato:

Após obtenção das credenciais, o serivço de API retornará com informações de Extrato:

  1. Informações do Devedor e Dívdia (consolidada) em JSON:

  2. Documento em PDF, desenvolvido em Web, para impressão com as informações (que deve ser aprovada e homologada pela Dívida Ativa do município).

Processo Judicial - Retorno JSON

Uma vez com as credenciais obtidas/autenticadas, as informações de Extrato devem ser solicitadas em:

URL Método
/Integracao_stm/ProcessosJudiciais/Extrato POST

O Número do processo judicial - CNJ, deverá ser enviada no Parâmetro da requisição o número do processo.

Parâmetro Tipo Descrição
NumeroProcesso Alfanumérico Número cadastrado no sistema, exemplo '1500930-19.2023.8.26.0363'

Importante: O número deve ser solicitado com traços e pontos, da forma que está cadastrado no sistema. Processos antigos podem ter formato diferenciado, o que impossibilita a padronização dos campos.

Em caso de sucesso, o retorno será status code 200:

Retorno Descrição
"numeroProcesso" Extraído do BD do cliente, idêntico ao solicitado na requisição (conferência)
"anoProcesso" Ano do Processo Judicial, exemplo "2016"
"vara" Informação da Vara cadastrada no sistema.
"ccm" Se o contribuinte for mobiliário, será o número do CCM conrome cadasrro do órgão. Exemplo: 00.000
"inscricao" Se o contribuinte for um imóvel, o número da Inscrição Cadastral do Imóvel. Exemplo: 51-53-71-0178-001
"documento" Número do CPF ou do CNPJ da pessoa (fornecido com máscara)
"nome" nome do contribuinte cadastrado no sistema
"tributo" Tributos que fazem parte do Processo, ex: "IPTU-2011"
"endereco" Agrupador do endereço do devedor (principal)
"logradouro" Logradouro do devedor
"numero" Número do devedor
"complemento" Complemento do devedor
"bairro" Bairro do Devedor
"cidade" Cidade do Devedor
"uf" UF do Devedor
"cep" CEP do Devedor

As informações do devedor referem-se àquelas cadastradas no sistema no momento da pesquisa.

Para identificação do devedor (caso haja mais de uma pessoa cadastrada no sistema), será observada a seguinte regra:

  1. Se houver Parcelamento nas carteiras do Processo, o devedor apurado será aquele que parcelou (confessou) a dívida.

  2. Se não houver parcelamento, contudo houver mais de um devedor, deverá ser apurado pela seguinte ordem:

    a. Pessoa ligada ao CCM;

    b. Pessoa proprietária do Imóvel;

    c. Pessoa que tem documento cadastrado, caso haja mais de uma pessoa nessa situação, o que tiver sido cadastrado por ÚLTIMO (maior PFJ_SEQ).

A apuração dos débitos será da seguinte forma:

CASO 1: DÍVIDAS SEM PARCELAMENTO

Retorno (cont.) Descrição
"dividaExecutada" Valor da Dívida da(s) CDA(s) Executadas para o Processo (valor original + encargos)
"dividaExecutadaHonorarios" 10% calculados sobre o valor da dívida executada
"dividaExecutadaTotal" soma dos campos "dividaExecutada" e "dividaExecutadaHonorarios"
"valorPago" Soma (do valor original do débito) das parcelas pagas pertencentes às carteiras executadas
"valorPagoTotal" Soma do valor das parcelas pagas pertencentes às carteiras utilizadas (com encargos)
"ValorDevidoAtualizado" Valor da dívida Atualizada para a data atual (somados multa, juros e correção)
"valorDevidoAtualizadoHonorarios" Honorários Advocatícios atualizados
"valorDevidoAtualizadoTotal" Valor devido atualizado total, devido pelo contribuinte.
"dataEmissao" SysDate da emissão do JSON

CASO 2: DÍVIDAS COM PARCELAMENTO, QUANDO EXISTIR APENAS UM PARCELAMENTO COM TODA A DÍVIDA

Retorno (cont.) Descrição
"dividaExecutada" Valor da Dívida da(s) CDA(s) Executadas para o Processo (valor original + encargos)
"dividaExecutadaHonorarios" 10% calculados sobre o valor da dívida executada
"dividaExecutadaTotal" soma dos campos "dividaExecutada" e "dividaExecutadaHonorarios"
"acordo" agrupador das informações do Arcordo/parcelamento realizado
"numeroAcordo" Número do parcelamento/acordo realizado entre o contribuinte e a PM
"numeroParcelas" Número de parcelas que foi negociado o acordo
"numeroParcelasPagas" Número de parcelas pagas do acordo
"valorAcordoPago" Valor pago do acordo
"honorariosAcordoPago" Valor pago de honorários correspondente ao acordo
"totalAcordoPago" Valor total do pagamento do acordo
"restanteDebito" valor restante do débito, referente ao parcelamento/acordo (calculado da data da abertura parcelamento)
"restanteDebitoHonorarios" valor do honorário do débito, referente ao parcelamento/acordo (calculado da data da abertura parcelamento)
"restanteDebitoTotal" soma dos campos "restanteDebito" e "restanteDebitoHonorarios"
"ValorDevidoAtualizado" Valor da dívida Atualizada para a data atual (somados multa, juros e correção)
"valorDevidoAtualizadoHonorarios" Honorários Advocatícios remanescentes do acordo
"valorDevidoAtualizadoTotal" Valor devido atualizado total, devido pelo contribuinte.
"dataEmissao" SysDate da emissão do JSON
Processo Judicial - Retorno PDF

Com as credenciais autenticadas, a certidão deverá ser solicitada em:

URL Método
/Integracao_stm/ProcessosJudiciais/ExtratoPdf POST

O Número do processo judicial - CNJ, deverá ser enviada no Parâmetro da requisição o número do processo.

Parâmetro Tipo Descrição
NumeroProcesso Alfanumérico Número cadastrado no sistema, exemplo '1500930-19.2023.8.26.0363'

Importante: O número deve ser solicitado com traços e pontos, da forma que está cadastrado no sistema. Processos antigos podem ter formato diferenciado, o que impossibilita a padronização dos campos.

Mensagens de Erro

Em caso de erro, retornará 404 e a descrição do erro como mensagem, conforme o problema identificado, para ambas as requisições realizadas.

TABELA DE ERROS

Código Descrição
ERRO 101 Não foi possível obter o endereço do devedor relacionado a carteira [NRO CARTEIRA], favor procure a Dívida Ativa e informe o erro encontrado
ERRO 102 Não foi possível obter o endereço do devedor do imóvel [COD IMOVEL], favor procure a Dívida Ativa e informe o erro encontrado
ERRO 103 Não foi possível obter o endereço do devedor da empresa [COD MOBILIARIO], favor procure a Dívida Ativa e informe o erro encontrado
ERRO 104 Não foi possível obter o endereço do devedor [PESSOA ID], favor procure a Dívida Ativa e informe o erro encontrado
ERRO 001 O Processo informado [NRO PROCESSO] não existe, favor procure a Dívida Ativa e informe o erro encontrado
ERRO 002 Existem [X] Processos com o número informado [NRO PROCESSO], favor procure a Dívida Ativa e informe o erro encontrado
ERRO 003 Não foram encontradas carteiras vinculadas ao processo informado, favor procure a Dívida Ativa e informe o erro encontrado
ERRO 004 A carteira [NRO CARTEIRA] relacionada ao processo solicitado, esta vinculada a um processo mais recente [NRO PROCESSO]
ERRO 005 Nome do contribuinte não localizado na Carteira [NRO CARTEIRA], favor procure a Dívida Ativa e informe o erro encontrado
ERRO 006 Dados do contribuinte não localizados na carteira [NRO CARTEIRA], favor procure a Dívida Ativa e informe o erro encontrado
ERRO 007 Não foi possível obter o valor da divida executada para a CarteiraId: [NRO CARTEIRA], favor procure a Dívida Ativa e informe o erro encontrado
ERRO 008 Erro ao obter dados da Carteira [NRO CARTEIRA], favor procure a Dívida Ativa e informe o erro encontrado
ERRO 009 Existem mais de 1 parcelamento vigente para este processo, favor procure a Dívida Ativa e informe o erro encontrado
ERRO 010 Não foi possível obter o valor da divida executada para a carteira de parcelamento, CarteiraId: [NRO CARTEIRA], favor procure a Dívida Ativa e informe o erro encontrado

4. Considerações:

Os relatórios e informações são extraídas com base às carteiras e acordos processados no sistema. O desenvolvimento trabalha na expectativa de enviar informações apuradas e barrar a entrega no caso de divergências ou necessidade de intervenção.

A API devido a sua natureza é dependente de recursos de infraestrutura alheios ao desenvolvimento, de responsabilidade do cliente e/ou compartilhada, conforme contrato de prestação de serviços.

As informações disponibilizadas são as constantes do cadastro, ou seja, qualquer mudança no cadastro que seja relevante nas rotinas pode alterar os resultados, portanto, as informações podem variar de requisição a requisição baseado nesse fato.