Configurações básicas para Implementação provedor IPM
FAQ_CIGAM > FAQ_Fiscal > Gestão Fiscal Municipal > Configurações básicas para Implementação provedor IPM
Nesta FAQ iremos destacar parametrizações básica para integração da NFSe com o provedor IPM. Para que seja possível realizar a integração é necessário possuir o módulo Gestão Fiscal Municipal.
Parametrizações Básicas
[editar]As parametrizações devem ser realizadas através do menu Fiscal > Gestão Fiscal Municipal > Parâmetros > Cadastro NFS-e Configurável.
Guia Envio
[editar]Abaixo seguem informações de parametrização dos campos. Neste exemplo foi utilizada a prefeitura de Cachoeirinha/RS. Porém o conteúdo das TAGs será o mesmo independente do município.
TAGs
[editar]| Conteúdo Tag Código | 00001 - Sucesso |
| Tag Código | /retorno/mensagem/codigo |
| Tag Protocolo | /retorno/cod_verificador_autenticidade |
| Tag Número | /retorno/mensagem/codigo |
| Tag Número NF | /retorno/numero_nfse |
Botão Configurações
[editar]Neste botão deve ser marcada a opção "Envio Síncrono" e "Realiza comunicação WebService via DLL específica". Devemos ainda informar os campos "CNPJ" e a "Senha Prestador", com as respectivas informações de acesso do Portal IPM.
Botão Natureza
[editar]Neste botão devemos informar os respectivos códigos e seus tratamentos tributários.
Importante: Estas informações podem variar de acordo com o município a ser implementado, recomenda-se consultar o manual de orientações para o preenchimento das informações.
Botão Assinatura
[editar]Neste botão devemos informar a(s) respectivas TAGs em ordem que devem ser assinadas. Para identificar quais são as TAGs que necessitam deste tratamento, recomenda-se consultar o manual de Integração.
Botão Serviços
[editar]Neste botão devem ser informados os dados do serviço de envio do XML para a prefeitura. Respectivas URL(s) assim com o Método utilizado. Para identificar a URL e o método a ser utilizado recomenda-se consultar o manual de Integração.
Guia Retorno
[editar]Quando utilizada a opção "Envio Síncrono", não se faz necessário parametrizar a aba de Retorno, pois o retorno irá ocorrer na mesma requisição do Envio.
Guia Cancelamento
[editar]Parametrizações desta guia para o Provedor IPM estão detalhados na imagem abaixo.
TAGs
[editar]| Conteúdo Tag Código | 00001 - Sucesso |
| Tag Código | /retorno/mensagem/codigo |
| Tag Mensagem | /retorno/mensagem/codigo |
| Tag Número NF | /retorno/numero_nfse |
Botão Motivos
[editar]Neste botão devemos informar os respectivos códigos assim com a descrição (motivo) do cancelamento, conforme detalhado no manual de Integração.
Botão Assinatura
[editar]Neste botão devemos informar a(s) respectivas TAGs em ordem que devem ser assinadas. Para identificar quais são as TAGs que necessitam deste tratamento, recomenda-se consultar o manual de integração.
Botão Serviços
[editar]Neste botão devem ser informados os dados do serviço de envio do XML de Cancelamento para a prefeitura. Para identificar as respectivas URL(s) assim com o Método a ser utilizado, recomenda-se consultar o manual de Integração.
Botão Impressão
[editar]Para utilizar a funcionalidade de impressão da NFSe disponibilizada pela prefeitura, deve ser informada a url de impressão, seguidos pelos parâmetros necessários. Neste exemplo iremos utilizar o parâmetro @6@ (Protocolo). Ficando a URL neste formato:
https://NOMEDOMUNICIPIO.atende.net/autoatendimento/servicos/consulta-de-autenticidade-de-nota-fiscal-eletronica-nfse/detalhar/1/identificador/@6@
Na guia "Configurações" do Gerenciamento NFS-e Configurável, no "Modelo de Impressão" deve estar parametrizada a opção "Automático (imprime o modelo da prefeitura, se não existir, utiliza o modelo definido no CIGAM)"
Modelos
[editar]Cabecalho
[editar]O arquivo de cabeçalho deve possuir a seguinte estrutura:
| Código Fonte do modelo XML de Cabeçalho |
<CNPJPrestador>99999999999999</CNPJPrestador> <SenhaPrestador>123456</SenhaPrestador> |
Envio
[editar]O modelo XML de envio do provedor IPM (Última atualização 04/02/2025).
| Código Fonte do modelo XML de Envio |
<nfse> <nf> <valor_total><!$MG_total_servico_virgula></valor_total> <valor_desconto><!$MG_total_desconto_virgula></valor_desconto> <valor_ir><!$MG_valor_ir_virgula></valor_ir> <valor_inss><!$MG_valor_inss_virgula></valor_inss> <valor_contribuicao_social><!$MG_valor_contribuinte_virgula></valor_contribuicao_social> <valor_rps>0,00</valor_rps> <valor_pis><!$MG_valor_pis_virgula></valor_pis> <valor_cofins><!$MG_valor_cofins_virgula></valor_cofins> <observacao><!$MG_descricao_rps></observacao> </nf> <prestador> <cpfcnpj><!$MG_prestador_cnpj></cpfcnpj> <cidade>Informe o Código do Município do Prestador</cidade> </prestador> <tomador> <tipo><!$MG_tomador_pessoa></tipo> <cpfcnpj><!$MGIF_tomador_if_pess><!$MG_tomador_cpf><!$MGELSE><!$MG_tomador_cnpj><!$MGENDIF></cpfcnpj> <ie><!$MG_tomador_inscricao></ie> <nome_razao_social><!$MG_tomador_razao_social></nome_razao_social> <sobrenome_nome_fantasia><!$MG_tomador_fantasia></sobrenome_nome_fantasia> <logradouro><!$MG_tomador_endereco></logradouro> <email><!$MG_tomador_email></email> <numero_residencia><!$MG_tomador_endereco_n></numero_residencia> <complemento><!$MG_tomador_complemento></complemento> <ponto_referencia/> <bairro><!$MG_tomador_bairro></bairro> <cidade><!$MG_codigo_municipal></cidade> <cep><!$MG_tomador_cep></cep> <!$MGIF_tomador_if_pess><ddd_fone_residencial><!$MG_ddd_tomador></ddd_fone_residencial> <fone_residencial><!$MG_fone_tomador></fone_residencial><!$MGELSE><ddd_fone_comercial><!$MG_ddd_tomador></ddd_fone_comercial> <fone_comercial><!$MG_fone_tomador></fone_comercial><!$MGENDIF> <ddd_fax>00</ddd_fax> <fone_fax><!$MG_fax_fone_tomador></fone_fax> </tomador> <itens> <lista> <tributa_municipio_prestador><!$MG_mov_tribut_munic_prest></tributa_municipio_prestador> <codigo_local_prestacao_servico>8561</codigo_local_prestacao_servico> <unidade_codigo>1</unidade_codigo> <unidade_quantidade><!$MG_mov_unidade_quantidade></unidade_quantidade> <unidade_valor_unitario><!$MG_mov_unidade_vl_unitario></unidade_valor_unitario> <codigo_item_lista_servico><!$MG_mov_cod_servico></codigo_item_lista_servico> <descritivo><!$MG_mov_material_descricao> <!$MG_mov_descricao></descritivo> <aliquota_item_lista_servico><!$MG_mov_aliquota_iss_virgula></aliquota_item_lista_servico> <situacao_tributaria><!$MG_mov_substituicao_trib></situacao_tributaria> <valor_tributavel><!$MG_mov_valor_tributavel_virgula></valor_tributavel> <valor_deducao><!$MG_mov_valor_deducao_virgula></valor_deducao> <valor_issrf>0,00</valor_issrf> </lista> </itens> <produtos> <descricao><!$MG_descricao_itens_complement></descricao> <valor><!$MG_valor_itens_complement></valor> </produtos> </nfse> |
O modelo de envio do município de Cachoeirinha está disponível no FTP CIGAM para download, maiores informações no final desta FAQ.
Observação: Este provedor possui uma tabela específica de códigos dos municípios (Cidades). Este código deve ser informado na guia "Complementar" do Cadastro de Municípios. Podem ser utilizados os seguintes campos:
- Código GIA Municipal: neste caso deve-se utilizar a variável <!$MG_municipio_prestacao>.
- Código Municipal: neste caso deve-se utilizar a variável <!$MG_codigo_municipal> ou <!$MG_codigo_municipal_entrega>.
Envio Reforma Tributária
[editar]O modelo XML de Envio com as informações da Reforme Tributária (Última atualização 17/12/2025).
Importante: O modelo contém a TAG "<nfse_teste>1</nfse_teste>", para envios em ambientes de Produção é necessário remover está TAG do modelo utilizado.
| Código Fonte do modelo XML de Envio com Reforma Tributária |
<nfse>
<nfse_teste>1</nfse_teste>
<nf>
<valor_total><!$MG_total_servico_virgula></valor_total>
<valor_desconto><!$MG_total_desconto_virgula></valor_desconto>
<valor_ir><!$MG_valor_ir_virgula></valor_ir>
<valor_inss><!$MG_valor_inss_virgula></valor_inss>
<valor_contribuicao_social><!$MG_valor_contribuinte_virgula></valor_contribuicao_social>
<valor_rps>0,00</valor_rps>
<valor_pis><!$MG_valor_pis_virgula></valor_pis>
<valor_cofins><!$MG_valor_cofins_virgula></valor_cofins>
<observacao><!$MG_descricao_rps></observacao>
<IBSCBS>
<pRedutor><!$MG_ag_ibs_redutor_gov_virg></pRedutor>
<valores>
<vBC><!$MG_ag_ibscbs_base_virg></vBC>
<uf>
<pIBSUF><!$MG_mov_ibs_perc_ibs_uf_virg></pIBSUF>
<pRedAliqUF><!$MG_mov_ibs_red_aliq_uf_virg></pRedAliqUF>
<pAliqEfetUF><!$MG_mov_ibs_aliq_efet_uf_virg></pAliqEfetUF>
</uf>
<mun>
<pIBSMun><!$MG_mov_ibs_perc_ibs_mun_virg></pIBSMun>
<pRedAliqMun><!$MG_mov_ibs_red_aliq_mun_virg></pRedAliqMun>
<pAliqEfetMun><!$MG_mov_ibs_aliq_efet_mun_virg></pAliqEfetMun>
</mun>
<fed>
<pCBS><!$MG_ag_cbs_perc_cbs_virg></pCBS>
<pRedAliqCBS><!$MG_ag_cbs_red_aliq_virg></pRedAliqCBS>
<pAliqEfetCBS><!$MG_ag_cbs_aliq_efet_virg></pAliqEfetCBS>
</fed>
</valores>
<totCIBS>
<vTotNF><!$MG_mov_ibscbs_total_virg></vTotNF>
<gIBS>
<vIBSTot><!$MG_ag_ibs_total_virg></vIBSTot>
<gIBSCredPres>
<pCredPresIBS><!$MG_ag_ibs_cred_pres_virg></pCredPresIBS>
<vCredPresIBS><!$MG_ag_ibs_valor_cred_pres_virg></vCredPresIBS>
</gIBSCredPres>
<gIBSUFTot>
<vDifUF><!$MG_ag3_ibs_dif_uf_virg></vDifUF>
<vIBSUF><!$MG_mov_ibs_valor_ibs_uf_virg></vIBSUF>
</gIBSUFTot>
<gIBSMunTot>
<vDifMun><!$MG_ag3_ibs_dif_mun_virg></vDifMun>
<vIBSMun><!$MG_ag3_ibs_valor_dif_mun_virg></vIBSMun>
</gIBSMunTot>
</gIBS>
<gCBS>
<gCBSCredPres>
<pCredPresCBS><!$MG_ag_cbs_cred_pres_virg></pCredPresCBS>
<vCredPresCBS><!$MG_ag_cbs_valor_cred_pres_virg></vCredPresCBS>
</gCBSCredPres>
<vDifCBS><!$MG_ag_cbs_valor_dif_virg></vDifCBS>
<vCBS><!$MG_ag_cbs_valor_cbs_virg></vCBS>
</gCBS>
</totCIBS>
</IBSCBS>
</nf>
<prestador>
<cpfcnpj><!$MG_prestador_cnpj></cpfcnpj>
<cidade>Informar o Código do Município do Prestador</cidade>
</prestador>
<tomador>
<tipo><!$MG_tomador_pessoa></tipo>
<cpfcnpj><!$MGIF_tomador_if_pess><!$MG_tomador_cpf><!$MGELSE><!$MG_tomador_cnpj><!$MGENDIF></cpfcnpj>
<ie><!$MG_tomador_inscricao></ie>
<nome_razao_social><!$MG_tomador_razao_social></nome_razao_social>
<sobrenome_nome_fantasia><!$MG_tomador_fantasia></sobrenome_nome_fantasia>
<logradouro><!$MG_tomador_endereco></logradouro>
<email><!$MG_tomador_email></email>
<numero_residencia><!$MG_tomador_endereco_n></numero_residencia>
<complemento><!$MG_tomador_complemento></complemento>
<ponto_referencia/>
<bairro><!$MG_tomador_bairro></bairro>
<cidade><!$MG_codigo_municipal></cidade>
<cep><!$MG_tomador_cep></cep>
<!$MGIF_tomador_if_pess>
<ddd_fone_residencial><!$MG_ddd_tomador></ddd_fone_residencial>
<fone_residencial><!$MG_fone_tomador></fone_residencial>
<!$MGELSE>
<ddd_fone_comercial><!$MG_ddd_tomador></ddd_fone_comercial>
<fone_comercial><!$MG_fone_tomador></fone_comercial>
<!$MGENDIF>
<ddd_fax>00</ddd_fax>
<fone_fax><!$MG_fax_fone_tomador></fone_fax>
</tomador>
<itens>
<lista>
<tributa_municipio_prestador><!$MGIF_se_iss_retido>N<!$MGELSE>S<!$MGENDIF></tributa_municipio_prestador>
<codigo_local_prestacao_servico><!$MGIF_existe_end_entrega><!$MG_codigo_municipal_entrega><!$MGELSE><!$MG_codigo_municipal><!$MGENDIF></codigo_local_prestacao_servico>
<codigo_nbs><!$MG_mov_nbs></codigo_nbs>
<unidade_codigo>1</unidade_codigo>
<unidade_quantidade><!$MG_mov_unidade_quantidade></unidade_quantidade>
<unidade_valor_unitario><!$MG_mov_unidade_vl_unitario></unidade_valor_unitario>
<codigo_item_lista_servico><!$MG_ag_cod_servico_federal></codigo_item_lista_servico>
<descritivo><!$MG_mov_material_descricao> <!$MG_mov_descricao></descritivo>
<aliquota_item_lista_servico><!$MG_mov_aliquota_iss_virgula></aliquota_item_lista_servico>
<situacao_tributaria><!$MG_mov_situacao_tributaria></situacao_tributaria>
<valor_tributavel><!$MG_mov_valor_tributavel_virgula></valor_tributavel>
<valor_deducao><!$MG_mov_valor_deducao_virgula></valor_deducao>
<valor_issrf><!$MG_ag3_valor_issrf_virgula></valor_issrf>
</lista>
</itens>
<IBSCBS>
<finNFSe><!$MG_mov_ibscbs_finnfse></finNFSe>
<indFinal><!$MG_mov_ibscbs_ind_final></indFinal>
<cIndOp><!$MG_mov_ibscbs_ind_op></cIndOp>
<valores>
<trib>
<gIBSCBS>
<CST><!$MG_mov_ibscbs_cst></CST>
<cClassTrib><!$MG_mov_ibscbs_cod_class_trib></cClassTrib>
<cCredPres>01</cCredPres>
<gDif>
<pDifUF><!$MG_mov_ibs_dif_uf_virg></pDifUF>
<pDifMun><!$MG_mov_ibs_dif_mun_virg></pDifMun>
<pDifCBS><!$MG_mov_cbs_perc_dif_virg></pDifCBS>
</gDif>
</gIBSCBS>
</trib>
</valores>
</IBSCBS>
<produtos>
<descricao><!$MG_descricao_itens_complement></descricao>
<valor><!$MG_valor_itens_complement></valor>
</produtos>
</nfse>
|
Retorno
[editar]O Provedor IPM Fiscal, utiliza envio Síncrono, logo não se faz necessário o uso de modelos de retorno.
Cancelamento
[editar]| Código Fonte do modelo XML de Cancelamento |
<nfse>
<nf>
<numero><!$MG_nf_referencia></numero>
<serie_nfse><!$MG_serie></serie_nfse>
<situacao>C</situacao>
<observacao>DADOS INCORRETOS</observacao>
</nf>
<prestador>
<cpfcnpj><!$MG_prestador_cnpj></cpfcnpj>
<cidade>Informar o Código do Município do Prestador</cidade>
</prestador>
</nfse>
|
O modelo de cancelamento do município de Cachoeirinha está disponível no FTP CIGAM para download, maiores informações no final desta FAQ.
Download Modelos
[editar]Os modelos disponíveis para download podem serem baixados através do Botão Importar Layout da rotina de Cadastro NFS-e Configurável.
Através do Botão FTP o sistema realizará uma consulta no FTP CIGAM exibindo todos os layout que estão disponíveis para download.
