PORTAL DE DOCUMENTAÇÃO
Gestão Empresarial | ERP - versão 5.10.4 (XTended)
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.mct.imp.escrituracao.integracao.guiarecolhimento

Web service Com.senior.g5.co.mct.imp.escrituracao.integracao.guiarecolhimento

Permite exportar e modificar Guias de Recolhimento, registrando impostos a recolher e seus pagamentos através de outros sistemas. O Web service possibilita consultar guias de recolhimento geradas na gestão de tributos e alterar campos relacionados ao pagamento.

Tipo de execução

Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.

Autenticação

Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.

Campos numéricos

Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.

ClosedCampos que representam valores monetários, quantidade e percentual e estão declarados como String
  • Envio no formato ZZZZ,ZZ
  • É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
  • Obrigatória a utilização do separador decimal com vírgula, e não com ponto
  • Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
ClosedExemplo:

number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;

number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;

number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.

ClosedCampos que representam valores monetários, quantidade e percentual e não estão declarados como String
  • Envio no formato ZZZZ.ZZ
  • É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
  • Obrigatória a utilização do separador decimal com ponto, e não com vírgula
ClosedExemplo:
  • number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
  • number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
  • number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.

WSDL

Porta(s)

ClosedListar

Listar

Necessita autenticação: Sim.

Versão: 1.

ClosedRequisição: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:Listar>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <codEmp>Integer</codEmp>
        <codFil>Integer</codFil>
        <cgcFil>String</cgcFil>
        <datIni>DateTime</datIni>
        <datFim>DateTime</datFim>
        <guiExp>String</guiExp>
      </parameters>
    </ser:Listar>
  </soapenv:Body>
</soapenv:Envelope>
ClosedParâmetros da requisição:
Nome Preenchimento Tipo Descrição
codEmp Opcional Integer (Opcional) - Number(004) - Código da Empresa
codFil Opcional Integer (Opcional) - Number(005) - Código da Filial
cgcFil Opcional String (Opcional) - String(14) - Código da Filial
datIni Opcional DateTime (Opcional) - Date - Data Inicial de Apuração
datFim Opcional DateTime (Opcional) - Date - Data Final de Apuração
guiExp Opcional String (Opcional) - String(1) - Carrega Guias já exportadas
ClosedResposta:

Observação

Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido. 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:ListarResponse>
      <result>
        <tipoRetorno>Integer</tipoRetorno>
        <mensagemRetorno>String</mensagemRetorno>
        <guia>
          <ideExp>Integer</ideExp>
          <cgcFil>String</cgcFil>
          <datApi>DateTime</datApi>
          <codDrf>Integer</codDrf>
          <conMer>String</conMer>
          <docOri>String</docOri>
          <numPar>DateTime</numPar>
          <vlrPri>Double</vlrPri>
          <obsGr1>String</obsGr1>
          <obsGr2>String</obsGr2>
          <obsGr3>String</obsGr3>
          <datVct>DateTime</datVct>
          <mesAno>String</mesAno>
          <vlrAtu>Double</vlrAtu>
          <vlrJur>Double</vlrJur>
          <vlrMul>Double</vlrMul>
          <vlrRec>Double</vlrRec>
          <datPag>DateTime</datPag>
          <codBan>String</codBan>
          <codAge>String</codAge>
          <autBan>String</autBan>
        </guia>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:ListarResponse>
  </soapenv:Body>
</soapenv:Envelope>
ClosedAtributos da resposta:
Nome Preenchimento Tipo Descrição
tipoRetorno Obrigatório Integer (Obrigatório) - Integer - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação
mensagemRetorno Obrigatório String (Obrigatório) - String - Mensagem de Retorno de Processamento
guia Opcional Set Guias de Recolhimento de Impostos
guia.ideExp Opcional Integer Number(009) - Identificador Único Exportação via API
guia.cgcFil Opcional String Number(15) - Cnpj/Cgc Filial
guia.datApi Opcional DateTime Date(DD/MM/YYYY) - Data inicial do período de apuração do imposto
guia.codDrf Opcional Integer Integer - Código para Documento de arrecadação
guia.conMer Opcional String String(030) - Número do convênio o protocolo / especificação da mercadoria
guia.docOri Opcional String String(020) - Número do documento de origem
guia.numPar Opcional DateTime String(010) - Número da parcela
guia.vlrPri Opcional Double Number(015,2) - Valor principal da guia de recolhimento
guia.obsGr1 Opcional String String(100) - Observação 1
guia.obsGr2 Opcional String String(100) - Observação 2
guia.obsGr3 Opcional String String(100) - Observação 3
guia.datVct Opcional DateTime Date(DD/MM/YYYY) - Data de vencimento da guia de recolhimento
guia.mesAno Opcional String Date(DD/MM/YYYY) - Mês e ano referente à ocorrência do fato gerador
guia.vlrAtu Opcional Double Number(015,2) - Atualização monetária
guia.vlrJur Opcional Double Number(015,2) - Valor dos juros
guia.vlrMul Opcional Double Number(015,2) - Valor da multa
guia.vlrRec Opcional Double Number(015,2) - Valor recolhido
guia.datPag Opcional DateTime Date(DD/MM/YYYY) - Data do pagamento do documento de arrecadação
guia.codBan Opcional String String(003) - Código do banco onde foi efetuado o recolhimento
guia.codAge Opcional String String(007) - Código da agência onde foi efetuado o recolhimento
guia.autBan Opcional String String(020) - Número de autenticação bancária do documento de arrecadação
erroExecucao Opcional String
  • Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:
    • Vazio ou nulo, indicando que a execução foi feita com sucesso
    • A mensagem do erro ocorrido no servidor
  • Só impede a gravação quando o retorno.tipRet for igual a "2"
ClosedAlterar

Alterar

Necessita autenticação: Sim.

Versão: 1.

ClosedRequisição: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:Alterar>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <guia>
          <ideExp>Integer</ideExp>
          <vlrAtu>Double</vlrAtu>
          <vlrJur>Double</vlrJur>
          <vlrMul>Double</vlrMul>
          <vlrRec>Double</vlrRec>
          <datPag>DateTime</datPag>
          <codBan>String</codBan>
          <codAge>String</codAge>
          <autBan>String</autBan>
        </guia>
      </parameters>
    </ser:Alterar>
  </soapenv:Body>
</soapenv:Envelope>
ClosedParâmetros da requisição:
Nome Preenchimento Tipo Descrição
guia Opcional Set Guias de Recolhimento
guia.ideExp Obrigatório Integer (Obrigatório) - Number(009) - Identificador Único Exportação via API
guia.vlrAtu Opcional Double Number(015,2) - Atualização monetária
guia.vlrJur Opcional Double Number(015,2) - Valor dos juros
guia.vlrMul Opcional Double Number(015,2) - Valor da multa
guia.vlrRec Opcional Double Number(015,2) - Valor recolhido
guia.datPag Opcional DateTime Date(DD/MM/YYYY) - Data do pagamento do documento de arrecadação
guia.codBan Opcional String String(003) - Código do banco onde foi efetuado o recolhimento
guia.codAge Opcional String String(007) - Código da agência onde foi efetuado o recolhimento
guia.autBan Opcional String String(020) - Número de autenticação bancária do documento de arrecadação
ClosedResposta:

Observação

Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido. 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:AlterarResponse>
      <result>
        <retorno>
          <ideExp>Integer</ideExp>
          <tipoRetorno>String</tipoRetorno>
          <mensagemRetorno>String</mensagemRetorno>
        </retorno>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:AlterarResponse>
  </soapenv:Body>
</soapenv:Envelope>
ClosedAtributos da resposta:
Nome Preenchimento Tipo Descrição
retorno Opcional Set Retorno das Guias de Recolhimento
retorno.ideExp Obrigatório Integer (Obrigatório) - Number(009) - Identificador Único Exportação via API
retorno.tipoRetorno Obrigatório String (Obrigatório) - Integer - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação
retorno.mensagemRetorno Obrigatório String (Obrigatório) - String - Mensagem de Retorno de Processamento
erroExecucao Opcional String
  • Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:
    • Vazio ou nulo, indicando que a execução foi feita com sucesso
    • A mensagem do erro ocorrido no servidor
  • Só impede a gravação quando o retorno.tipRet for igual a "2"

Este artigo ajudou você?

Base de Conhecimento

Portal de Exigências Legais

Contrato de Licenciamento de Software e Prestação de Serviços

Documentação em outros idiomas:

English

Español

Senior Store

Universidade Corporativa

Fórum de Produtos

Trabalhe conosco

Blog

Todos os direitos de cópias reservadas para Senior Sistemas S.A.

A reprodução não autorizada desta publicação, no todo ou em parte, constitui violação dos direitos autorais (Lei 9.610/98).

Ver site completo