Modulo Business Intelligence Smart Component/SC-IMP-02-0001-01 Importacao Dados RPS
De Touch ERP
Modulo_Business_Intelligence_Smart_Component
Este componente é responsável pela importação de dados básicos, para geração de RPS(Recibo Provisório de Serviço), com posterior geração da NFSe.
Payload
Abaixo, segue um exemplo de payload em texto puro.
[{
"condicaoDePagamento": "123",
"parcelas": "1;",
"codigoAuxiliarServico": "",
"codigoServicoNacional": "",
"codigoServicoMunicipio": "",
"naturezaOperacao": "1",
"cnpjEmpresa": "13150228000100",
"competencia": "2025-07-30T00:00:00",
"emissao": "2025-07-30T00:00:00",
"regimeEspecialTributacao": null,
"exibilidadeIss": 1,
"servicos": [
{
"valorBrutoServico": 15694.52,
"descricaoServico": "Elaboração de planos diretores, estudos de viabilidade, estudos organizacionais e outros, relacionados com obras e serviços de engenharia; elaboração de anteprojetos, projetos básicos e projetos executivos para trabalhos de engenharia.",
"itemServico": "321"
}
],
"tomador": {
"nome": "3487 - AFONSO HENRIQUE DA SILVA JUNIOR",
"nomeFantasia": "AFONSO HENRIQUE",
"logradouro": "RUA DOS PLANETAS",
"numero": "151",
"complemento": "",
"bairro": "RECANTO DA PAMPULHA",
"cep": "32180420",
"cidade": "Belo Horizonte",
"codigoMunicipio": "3106200",
"uf": "MG",
"telefone": null,
"email": null,
"cnpj": "47111447069",
"inscricaoMunicial": null,
"inscricaoEstadual": null,
"contribuinteDoEstado": null
},
"alias": "teste_1"
}]
Ao enviar este conteudo ao gerenciador de Smarts(Plugins) da Touch Comp, este json deve ser encapsulado em Base64. Logo o payload a ser enviado é:
{
"input": "W3sKICAiY29uZGljYW9EZVBhZ2FtZW50byI6ICIxMjMiLAogICJwYXJjZWxhcyI6ICIxOyIsCiAgImNvZGlnb1NlcnZpY28iOiAiNTAzIiwKICAiY29kaWdvVHJpYnV0YWNhb1NlcnZpY28iOiAiNTAzMDAxODgiLAogICJuYXR1cmV6YU9wZXJhY2FvIjogIjEiLAogICJjbnBqRW1wcmVzYSI6ICIxMzE1MDIyODAwMDEwMCIsCiAgImNvbXBldGVuY2lhIjogIjIwMjUtMDctMzBUMDA6MDA6MDAiLAogICJlbWlzc2FvIjogIjIwMjUtMDctMzBUMDA6MDA6MDAiLAogICJyZWdpbWVFc3BlY2lhbFRyaWJ1dGFjYW8iOiBudWxsLAogICJleGliaWxpZGFkZUlzcyI6IDEsCiAgInNlcnZpY29zIjogWwogICAgewogICAgICAidmFsb3JCcnV0b1NlcnZpY28iOiAxNTY5NC41MiwKICAgICAgImRlc2NyaWNhb1NlcnZpY28iOiAiRWxhYm9yYcOnw6NvIGRlIHBsYW5vcyBkaXJldG9yZXMsIGVzdHVkb3MgZGUgdmlhYmlsaWRhZGUsIGVzdHVkb3Mgb3JnYW5pemFjaW9uYWlzIGUgb3V0cm9zLCByZWxhY2lvbmFkb3MgY29tIG9icmFzIGUgc2VydmnDp29zIGRlIGVuZ2VuaGFyaWE7IGVsYWJvcmHDp8OjbyBkZSBhbnRlcHJvamV0b3MsIHByb2pldG9zIGLDoXNpY29zIGUgcHJvamV0b3MgZXhlY3V0aXZvcyBwYXJhIHRyYWJhbGhvcyBkZSBlbmdlbmhhcmlhLiIsCiAgICAgICJpdGVtU2VydmljbyI6ICIzMjEiCiAgICB9CiAgXSwKICAidG9tYWRvciI6IHsKICAgICJub21lIjogIjM0ODcgLSBBRk9OU08gSEVOUklRVUUgREEgU0lMVkEgSlVOSU9SIiwKICAgICJub21lRmFudGFzaWEiOiAiQUZPTlNPIEhFTlJJUVVFIiwKICAgICJsb2dyYWRvdXJvIjogIlJVQSBET1MgUExBTkVUQVMiLAogICAgIm51bWVybyI6ICIxNTEiLAogICAgImNvbXBsZW1lbnRvIjogIiIsCiAgICAiYmFpcnJvIjogIlJFQ0FOVE8gREEgUEFNUFVMSEEiLAogICAgImNlcCI6ICIzMjE4MDQyMCIsCiAgICAiY2lkYWRlIjogIkJlbG8gSG9yaXpvbnRlIiwKICAgICJjb2RpZ29NdW5pY2lwaW8iOiAiMzEwNjIwMCIsCiAgICAidWYiOiAiTUciLAogICAgInRlbGVmb25lIjogbnVsbCwKICAgICJlbWFpbCI6IG51bGwsCiAgICAiY25waiI6ICI0NzExMTQ0NzA2OSIsCiAgICAiaW5zY3JpY2FvTXVuaWNpYWwiOiBudWxsLAogICAgImluc2NyaWNhb0VzdGFkdWFsIjogbnVsbCwKICAgICJjb250cmlidWludGVEb0VzdGFkbyI6IG51bGwKICB9LAogICJhbGlhcyI6ICJ0ZXN0ZV8xIgp9XQ==",
}
Quando a informação chegar em noosso sistema, o gerenciado ira decodificar o conteudo "input", e enviar ao plugin SC-IMP-02-0001-01 para processamento.
Detalhes dos Campos
| Campo | Observações |
|---|---|
| condicaoDePagamento | Condições de Pagamento do Serviço |
| parcelas | Parcelas (se aplicável) de acordo com a condição de pagamento (Ex: "30;60;90") |
| codigoAuxiliarServico | Código do serviço definido dentro do âmbito do sistema da TouchComp. Ele é utilizado para identificar um serviço sem necessariamente trabalhar com os padrões municipal/nacional. |
| codigoServicoNacional | Código do serviço no âmbito nacional. Esse é o padrão que vale para o país inteiro. Ele foi criado pela Lei Complementar nº 116 de 2003 e serve para listar quais serviços podem ser tributados pelo ISS (Imposto Sobre Serviços). |
| codigoServicoMunicipio | Código de tributação conforme padronizado pelo município. O Brasil está unificando a emissão de notas de serviço com o projeto da NFSe-Nacional mas até então cada município que não aderiu ao padrão nacional pode ter sua tabela de códigos. |
| naturezaOperacao | Natureza de operação do RPS. Utilize um dos valores: 1 (Tributação no municipio); 2 (Tributação fora do municipio); 3 (Isenção); 4 (Imune); 5 (Exigibilidade suspensa por decisão judicial); 6 (Exigibilidade suspensa por procedimento administrativo). |
| cnpjEmpresa | CNPJ da empresa prestadora do serviço. |
| competencia | Data de competência do RPS. |
| emissao | Data de emissão do RPS. |
| regimeEspecialTributacao | Regime especial de tributação do RPS caso seja aplicável. |
| exibilidadeIss | Situações de exigibilidade (ou seja, de possibilidade de cobrança) do ISS. Utilize um dos valores: 1 (Exigível); 2 (Não Incidência); 3 (Isenção); 4 (Exportação); 5 (Imunidade); 6 (Exigibilidade Suspensa por Decisão Judicial); 7 (Exigibilidade Suspensa por Processo Administrativo). |
| servicos | Lista dos serviços prestados vinculados ao RPS. |
| valorBrutoServico | Valor bruto cobrado pelo serviço |
| descricaoServico | Descrição do serviço prestado. |
| itemServico | Identificação do Item RPS. |
| tomador | Informações do tomador do serviço. |
| alias | Campo opcional para identificação de cada RPS passado na importação. Sugerimos informar valores únicos pra cada RPS pois em eventuais problemas de processamento, os erros serão retornados vinculados a esse campo e, com códigos únicos, será mais fácil identificar qual RPS ocorreu o(s) problema(s). |
Os campos "codigoAuxiliarServico", "codigoServicoNacional" e "codigoServicoMunicipio" não necessariamente precisam ser informados ao mesmo tempo. Se a empresa aderiu a utilização interna de um código (codigoAuxiliarServico) para identificar os serviços, não precisam ser informados os campos "codigoServicoNacional" e "codigoServicoMunicipio". Caso negativo, os serviços devem estar cadastrados no sistema conforme os códigos municipais e nacionais dos serviços que a empresa trabalha. Consulte as documentações oficiais dos municípios e nacional e/ou o próprio cadastro dos serviços no Touch Comp ERP.
O campo "itemServico" está ligado ao serviço, caso não exista no sistema um cadastro cujo código de sincronização seja igual ao definido nesse campo, o mesmo será cadastrado.
Resposta
Sucesso – 200 OK
{
"@type": "WebDTOResult",
"status": "SUCESSO",
"messages": [],
"result": [
{
"alias": "teste_1",
"status": "SUCESSO",
"informacoes": [
{
"tipo": "SUCESSO",
"message": "RPS salvo com sucesso. Identificador: 348"
}
]
}
],
"countOf": 0,
"name": null,
"message": null,
"detailMessage": null
}
Sucesso – 200 OK (Com erros de processamento)
{
"@type": "WebDTOResult",
"status": "SUCESSO",
"messages": [],
"result": [
{
"alias": "teste_1",
"status": "SUCESSO",
"informacoes": [
{
"tipo": "ERRO",
"message": "A condição de pagamento informada não foi localizada. Verifique o código mapeado entre as plataformas"
},
{
"tipo": "ERRO",
"message": "Ocorreram erros de validação antes de salvar o RPS. Verifique: V.ERP.0657.001 : Informe as condições de pagamento.\nV.ERP.0657.002 : Informe o meio de Pagamento.\n"
}
]
}
],
"countOf": 0,
"name": null,
"message": null,
"detailMessage": null
}
Problemas e soluções
Erros Comuns
Durante o processamento, é possível que ocorra erros. Alguns dos que esperamos que podem ocorrer estão listados abaixo.
| Código | Mensagem | Causas e Solução |
|---|---|---|
| E.INT.0657.002 | Nenhuma empresa cadastrada com o CNPJ: {0} | Não encontramos no nosso sistema uma empresa cadastrada com o CNPJ informada no RPS passado nos parâmetros. |
| E.INT.0657.003 | Ocorreram erros de validação antes de salvar o RPS. Verifique: {0} | Antes de salvar o RPS, realizamos uma série de validações para verificar a integridade dos dados do registro. Caso ocorra problemas nessa fase da validação, eles serão retornadas nessa mensagem. Geralmente os erros são sugestivos, nesse caso verifique os dados do RPS. Entretanto, alguns podem se referir a aspectos internos do nosso sistema e, nesses casos, recomendamos que entre em contato com nosso suporte. |
| E.INT.0657.004 | A condição de pagamento informada não foi localizada. Verifique o código mapeado entre as plataformas. | Há um código em nosso sistema criado com o intuito de realizar o mapeamento entre condições de pagamento de diferentes sistemas. O código para 2 condições de pagamento equivalentes devem ser iguais entre os sistemas e, na utilização da nossa integração, ele deve ser utilizado nos parâmetros. Na ocorrência desse erro, o código informado não está mapeado corretamente. |
| E.INT.0657.005 | Dados do Tomador não informado no RPS | No RPS passado como parâmetro não foi informado dados do Tomador. |
| E.INT.0657.006 | Nenhum Serviço foi informado no RPS. | No RPS passado como parâmetro não foi informado dados do(s) Serviço(s). O Serviço é localizado com base nos campos "codigoAuxiliarServico", "codigoServicoNacional" ou "codigoServicoMunicipio", verifique esses valores e o cadastro dos serviços no sistema. |
| E.INT.0657.007 | Campo Exigibilidade ISS do RPS {0} está com formato inválido. A propriedade foi marcada como Não Incidência. | Nos parâmetros solicitamos o campo "exibilidadeIss". Ele deve ser informado conforme os valores: 1 (Exigível), 2 (Não Incidência), 3 (Isenção), 4 (Exportação), 5 (Imunidade), 6 (Exigibilidade Suspensa por Decisão Judicial), 7 (Exigibilidade Suspensa por Processo Administrativo). |
| E.INT.0657.008 | Data de emissão não foi informada ou está com formato inválido. Verifique o manual de integração e seu payload. | Verifique no seu payload se o campo de data emissão do RPS foi informado. Além disso, ele deve estar no formato ISO 8601, que é amplamente utilizado em sistemas computacionais e APIs por sua clareza e padronização internacional. Exemplo de utilização: '2025-07-30T00:00:00' (30/07/2025 00:00:00). |
| E.INT.0657.010 | Nenhum Serviço RPS com o código serviço:{0} e código tributação:{1} foi encontrado. Solicite a parametrização no sistema. | O problema ocorreu por falta de parametrização do serviço com os códigos informados RPS. Verifique o item E.INT.0657.006. Entre em contato com nosso suporte solicitando a configuração. |
| E.INT.0657.011 | Ocorreram erros de validação antes de salvar o Tomador. Verifique: {0}. | Caso ainda não tenha um tomador com os dados informados no RPS, nosso sistema tentará cadastrá-lo mas poderá ocorrer erros de validação retornados nesse caso. |
| E.INT.0657.012 | Não foi definido nas Opções Faturamento NFSe da empresa os campos de categoria e classificação padrão do tomador. | Solicite a algum usuário com acesso ao recurso 763 do Touch Comp ERP para definir a Categoria e Classificação padrão que serão utilizadas no cadastro do tomador. |
Parâmetros Adicionais
Nenhum.
Formato
Síncrono.
