Manual de integração com o webservice
Portais Disponíveis
- Produção
Métodos Disponíveis
- Envio.
- Síncrono.
- Consulta de NFSe por RPS.
Observações
Não possui envio em lote;
A cidade de Alto Paraiso de Goiás e Vianópolis contam com um modo Teste onde as informações são processadas e validadas pelo sistema da prefeitura, mas sem realizar alterações no banco de dados. O retorno do webservice, quando em "teste", são sempre fixos.
A mudança de modo teste para produção deve ser solicitada para a prefeitura.
Cancelamento de uma NFSe
No momento da homologação o método de cancelamento não estava funcionando, portanto o cancelamento é apenas via portal da prefeitura.
Novos Campos da Reforma tributária
| CodigoNbs | TipoRetPisCofins | ValorPisProprio |
| AliquotaPisProprio | ValorCofinsProprio | AliquotaCofinsProprio |
| SituacaoTributariaIbsCbs | ClassificacaoTributariaIbsCbs | CodigoOperacao |
| ValorTotalTribFed | ValorTotalTribEst | ValorTotalTribMun |
| InscricaoFiscalImovel | CodigoCIB | CodigoCidadeImovel |
| CepImovel | EnderecoImovel | NumeroImovel |
| ComplementoImovel | BairroImovel | CodigoModoPrestacao |
| CodigoVinculoPrestacao | TipoMoedaEstrangeira | ValorServicosEstrangeiro |
| TipoFomentoPrestador | TipoFomentoTomador | TipoMovimentacaoBens |
| NumeroDeclaracaoImp | NumeroRegistroExp | TipoMDIC |
| IdentificacaoEvento | DescricaoEvento | DataInicioEvento |
| DataFinalEvento | CepEvento | CodigoPostalEvento |
| CidadeExteriorEvento | RegiaoEvento | EnderecoEvento |
| NumeroEvento | ComplementoEvento | BairroEvento |
| CodigoCidadeEvento | PaisEvento | TipoOperacao |
| TipoEnteGovernamental | ChaveNFSe | TipoChaveDF |
| ChaveDFe | MunicipioDocumentoFiscal | NumeroDocumentoFiscal |
| DescricaoDocumentoFiscal | NumeroDocumentoNaoFiscal | DescricaoDocumentoNaoFiscal |
| CpfCnpjFornecedor | NifFornecedor | MotivoNaoNifFornecedor |
| RazaoSocialFornecedor | DataEmissaoDedutivel | DataCompetenciaDedutivel |
| TipoValorDedutivel | DescricaoValorDedutivel | ValorDedutivel |
Observação: Campos obrigatórios conforme o arquivo de esquema do Padrão estão destacados em negrito.
Ressaltamos que, para manter a funcionalidade em ambos os ambientes de emissão (produção e homologação), essas regras de validação ainda não foram aplicadas em nossas aplicações.
Para maiores informações sobre a forma de preenchimento destes campos novos, acesse nossa documentação do Padrão Unificado de TX2.
Particularidades dos campos
- Ao informar o TipoEnteGovernamental (1 a 4), a tag CompraGovernamental é gerada automaticamente com o valor 1.
- A NFS-e da operação já realizada (TipoOperacao 2 ou 3) deve ser informada no campo ChaveNFSe (50 dígitos), entre os comandos INCLUIRREFERENCIA e SALVARREFERENCIA. O padrão aceita apenas uma NFS-e referenciada.
- Os documentos referenciados (reembolso, repasse ou ressarcimento) são informados entre os comandos INCLUIRDOCUMENTOREFERENCIADO e SALVARDOCUMENTOREFERENCIADO, podendo haver mais de um por nota. Cada documento deve ter apenas um dos tipos: ChaveDFe (TipoChaveDF 1 - NFS-e, 2 - NF-e ou 3 - CT-e), documento fiscal (NumeroDocumentoFiscal) ou documento não fiscal (NumeroDocumentoNaoFiscal).
- O TipoValorDedutivel aceita os valores 01, 02, 03, 04 e 99. Para o valor 99, o campo DescricaoValorDedutivel é obrigatório.
INCLUIRDOCUMENTOREFERENCIADO TipoChaveDF=1 ChaveDFe=52152312247960950114054000000000000126111234567890 CpfCnpjFornecedor=29062609000177 RazaoSocialFornecedor=EMPRESA FORNECEDORA DataEmissaoDedutivel=2026-10-15 DataCompetenciaDedutivel=2026-10-01 TipoValorDedutivel=01 ValorDedutivel=10.00 SALVARDOCUMENTOREFERENCIADO
Exemplos de TX2 e XML
Campos de Obra
Após alteração recente no layout do padrão, os seguintes campos começaram a ser validados para dados de preenchimento de obra
| Nome do campo TX2 | Observação |
| CodigoObra | Código CNO (Cadastro Nacional de Obras) da obra |
| CodigoCib | Código Cib |
| EnderecoObra | Endereço da Obra |
| NumeroObra | Número do endereço da Obra |
| BairroObra | Bairro da Obra |
| ComplementoObra | Complemento da Obra |
| CepObra | Cep da Obra |
| CodigoCidadeObra | Código da cidade da Obra |
| InscricaoFiscalImovel | Inscrição Fiscal |
Observação: Atualmente o webservice aceita que seja enviado apenas UM dos grupos de dados de obra. Ou CodigoObra, ou CodigoCib, ou demais campos de endereço.
Geração do XML - Campos Importantes
Não utiliza Código Cnae, Natureza Operação, Regime especial Tributacao, Tipo tributação, Optante simples nacional.
O CodigoTributacaoMunicipio segue o que está descrito na LC-116.
Campos customizados para a impressão
Impressão do RPS
- RazaoSocialPrestador=String[80]
- NomeFantasiaPrestador=String[80]
- EnderecoPrestador=String[80]
- NumeroPrestador=String[80]
- ComplementoPrestador=String[80]
- BairroPrestador=String[80]
- CepPrestador=String[80]
- CodigoCidadePrestador=String[80]
- TelefonePrestador=String[80]
- Cei=String[80]
- RetencoesFederais=String[20]
- OutrasRetencoes=String[20]
- BaseCalculo=String[20]
- DescontoCondicionado=String[20]
- ValorIss=String[20]
- OptanteSimplesNacional=String[1]
- MunicipioIncidencia=String[7]
Impressão da NFSe
- NomeFantasiaPrestador=String[80]
- TelefonePrestador=String[80]
- Cei=String[80]
- RetencoesFederais=String[20]
- OutrasRetencoes=String[20]
- DescontoCondicionado=String[20]
- OptanteSimplesNacional=String[1]
- MunicipioIncidencia=String[7]
- NumeroAidf=String[10]
- NotaCancelada=String[10]
Comentários
5 comentários
Quando irá liberar o componente pq meu cliente está parado e me deu uma semana para liberar eles senão vão encerrar o contrato conosco.
Já abri vários ticket e ninguém retorna
Nada ainda???? De liberação
Vcs não repondem os chamados. Devem dar desconto pois estamos pagando sem sermos atendidos…
ta complicado, se tivesse feito pelo acbr ja teria resolvido meu problema com o cliente, estou perto de perder o contrato com ele
Ninguém da retorno
Ninguém responde as mensagens
Ninguém resolve o problema que já vem se alastrando a meses
Tá difícil, sou cliente a mais de 15 anos e está me deixando na mão
Por favor, entre para comentar.