Web service Com.senior.g5.co.mct.imp.escrituracao.lancamentos.estornolancamentos
Este web service tem a finalidade de extornar notas fiscais de entrada e saída, controles de exportação, outros documentos, inventários fiscais e reduções Z de acordo com a porta utilizada.
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.
- 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
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.
- 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
- 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:
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_mct_imp_escrituracao_lancamentos_estornolancamentos?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mct_imp_escrituracao_lancamentos_estornolancamentos?wsdl
- Agendamento: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_mct_imp_escrituracao_lancamentos_estornolancamentos?wsdl
Portas
- ExcluirNotaEntrada
- ExcluirNotaSaida
- ExcluirControleExportacao
- ExcluirOutrosDocumentos
- ExcluirInventarioFiscal
- ExcluirReducaoZ
- ExcluirTitulo
Extornar notas fiscais de entrada.
Necessita autenticação: sim.
Situação da versão: atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExcluirNotaEntrada> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <nota> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <codFor>Integer</codFor> <numNfi>Integer</numNfi> <codSnf>String</codSnf> </nota> </parameters> </ser:ExcluirNotaEntrada> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
nota | Opcional | Set | Notas fiscais de entrada |
nota.codEmp | Opcional | Integer | Number(004) - Código da empresa |
nota.codFil | Opcional | Integer | Number(005) - Código da filial |
nota.codFor | Opcional | Integer | Number(009) - Código do fornecedor da nota fiscal de entrada |
nota.numNfi | Opcional | Integer | Number(009) - Número inicial da nota fiscal de entrada |
nota.codSnf | Opcional | String | String(003) - Código da série da nota fiscal de entrada |
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:ExcluirNotaEntradaResponse> <result> <retorno> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <codFor>Integer</codFor> <numNfi>Integer</numNfi> <codSnf>String</codSnf> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </retorno> <erroExecucao>String</erroExecucao> </result> </ser:ExcluirNotaEntradaResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
retorno | Opcional | Set | Retorno (Cadastrado/Erros) |
retorno.codEmp | Opcional | Integer | Number(004) - Código da empresa |
retorno.codFil | Opcional | Integer | Number(005) - Código da filial |
retorno.codFor | Opcional | Integer | Number(009) - Código do fornecedor da nota fiscal de entrada |
retorno.numNfi | Opcional | Integer | Number(009) - Número inicial da nota fiscal de entrada |
retorno.codSnf | Opcional | String | String(003) - Código da série da nota fiscal de entrada |
retorno.tipRet | Opcional | Integer | Number(001) - Retorno |
retorno.msgRet | Obrigatório | String | Descrição (OK = Estornado) |
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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
Necessita autenticação: sim.
Situação da versão: atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExcluirNotaSaida> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <nota> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <codCli>Integer</codCli> <numNfi>Integer</numNfi> <codSnf>String</codSnf> </nota> </parameters> </ser:ExcluirNotaSaida> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
nota | Opcional | Set | Notas fiscais de saída |
nota.codEmp | Opcional | Integer | Number(004) - Código da empresa |
nota.codFil | Opcional | Integer | Number(005) - Código da filial |
nota.codCli | Opcional | Integer | Number(009) - Código do cliente da nota fiscal de saída |
nota.numNfi | Opcional | Integer | Number(009) - Número inicial da nota fiscal de saída |
nota.codSnf | Opcional | String | String(003) - Código da série da nota fiscal de saída |
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:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExcluirNotaSaidaResponse> <result> <retorno> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <codCli>Integer</codCli> <numNfi>Integer</numNfi> <codSnf>String</codSnf> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </retorno> <erroExecucao>String</erroExecucao> </result> </ser:ExcluirNotaSaidaResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
retorno | Opcional | Set | Retorno (Cadastrado/Erros) |
retorno.codEmp | Opcional | Integer | Number(004) - Código da empresa |
retorno.codFil | Opcional | Integer | Number(005) - Código da filial |
retorno.codCli | Opcional | Integer | Number(009) - Código do cliente da nota fiscal de saída |
retorno.numNfi | Opcional | Integer | Number(009) - Número inicial da nota fiscal de saída |
retorno.codSnf | Opcional | String | String(003) - Código da série da nota fiscal de saída |
retorno.tipRet | Opcional | Integer | Number(001) - Tipo do retorno |
retorno.msgRet | Obrigatório | String | Descrição (OK = Estornado) |
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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
Necessita autenticação: sim.
Situação da versão: atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExcluirControleExportacao> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <Controle> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <numEbq>Integer</numEbq> </Controle> </parameters> </ser:ExcluirControleExportacao> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
controle | Obrigatório | Set | Estornar Controle Exportação |
controle.codEmp | Obrigatório | Integer | Number(004) - Código da empresa |
controle.codFil | Obrigatório | Integer | Number(005) - Código da filial |
controle.numEbq | Obrigatório | Integer | Number(008) - Número do embarque |
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:ExcluirControleExportacaoResponse> <result> <Retorno> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <numEbq>Integer</numEbq> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </Retorno> <erroExecucao>String</erroExecucao> </result> </ser:ExcluirControleExportacaoResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
retorno | Opcional | Set | Retorno (Cadastrado/Erros) |
retorno.codEmp | Obrigatório | Integer | Código da empresa |
retorno.codFil | Obrigatório | Integer | Código da filial |
retorno.numEbq | Obrigatório | Integer | Número do embarque |
retorno.tipRet | Obrigatório | Integer | Tipo de Retorno |
retorno.msgRet | Obrigatório | String | Mensagem de Retorno (OK = Gravado) |
erroExecucao | Obrigatório | 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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
Necessita autenticação: sim.
Situação da versão: atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExcluirOutrosDocumentos> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <OutrosDocumentos> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <numDoc>Integer</numDoc> <seqDoc>Integer</seqDoc> </OutrosDocumentos> </parameters> </ser:ExcluirOutrosDocumentos> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
outrosDocumentos | Obrigatório | Set | Estornar Outros Documentos |
outrosDocumentos.codEmp | Obrigatório | Integer | Number(004) - Código da empresa |
outrosDocumentos.codFil | Obrigatório | Integer | Number(005) - Código da filial |
outrosDocumentos.numDoc | Obrigatório | Integer | Number(009) - Número de documento da movimentação |
outrosDocumentos.seqDoc | Obrigatório | Integer | Number(009) - Sequencial de lançamento do documento |
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:ExcluirOutrosDocumentosResponse> <result> <Retorno> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <numDoc>Integer</numDoc> <seqDoc>Integer</seqDoc> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </Retorno> <erroExecucao>String</erroExecucao> </result> </ser:ExcluirOutrosDocumentosResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
retorno | Opcional | Set | Retorno (Cadastrado/Erros) |
retorno.codEmp | Obrigatório | Integer | Código da empresa |
retorno.codFil | Obrigatório | Integer | Código da filial |
retorno.numDoc | Obrigatório | Integer | Número de documento da movimentação |
retorno.seqDoc | Obrigatório | Integer | Sequencial de lançamento do documento |
retorno.tipRet | Obrigatório | Integer | Tipo de Retorno |
retorno.msgRet | Obrigatório | String | Mensagem de Retorno (OK = Gravado) |
erroExecucao | Obrigatório | 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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
Necessita autenticação: sim.
Situação da versão: atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExcluirInventarioFiscal> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <inventarioFiscal> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <codPro>String</codPro> <codDer>String</codDer> <codDep>String</codDep> <mesAno>String</mesAno> </inventarioFiscal> </parameters> </ser:ExcluirInventarioFiscal> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
inventarioFiscal | Opcional | Set | Estorno de Inventário Fiscal |
inventarioFiscal.codEmp | Opcional | Integer | Number(004) - Código da empresa |
inventarioFiscal.codFil | Opcional | Integer | Number(005) - Código da filial |
inventarioFiscal.codPro | Opcional | String | String(014) - Código do produto |
inventarioFiscal.codDer | Opcional | String | String(007) - Código da derivação do produto |
inventarioFiscal.codDep | Opcional | String | String(010) - Código do depósito |
inventarioFiscal.mesAno | Opcional | String | Date(DD/MM/YYYY) - Mês e ano |
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:ExcluirInventarioFiscalResponse> <result> <retorno> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <codPro>String</codPro> <codDer>String</codDer> <codDep>String</codDep> <mesAno>String</mesAno> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </retorno> <erroExecucao>String</erroExecucao> </result> </ser:ExcluirInventarioFiscalResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
retorno | Opcional | Set | Retorno |
retorno.codEmp | Obrigatório | Integer | Number(004) - Código da empresa |
retorno.codFil | Obrigatório | Integer | Number(005) - Código da filial |
retorno.codPro | Obrigatório | String | String(014) - Código do produto |
retorno.codDer | Obrigatório | String | String(007) - Código da derivação do produto |
retorno.codDep | Obrigatório | String | String(010) - Código do depósito |
retorno.mesAno | Obrigatório | String | Date(DD/MM/YYYY) - Mês e ano |
retorno.tipRet | Obrigatório | Integer | Tipo do Retorno |
retorno.msgRet | Obrigatório | String | Mensagem de Retorno (OK = Gravado) |
erroExecucao | Opcional | String |
|
Necessita autenticação: sim.
Situação da versão: atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExcluirReducaoZ> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <ReducaoZ> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <codEqu>Integer</codEqu> <datRef>DateTime</datRef> </ReducaoZ> </parameters> </ser:ExcluirReducaoZ> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
reducaoZ | Obrigatório | Set | Estornar Redução Z. |
reducaoZ.codEmp | Obrigatório | Integer | Number(004) - Código da empresa. |
reducaoZ.codFil | Obrigatório | Integer | Number(005) - Código da filial. |
reducaoZ.codEqu | Obrigatório | Integer | Number(003) - Código do equipamento fiscal da redução Z. |
reducaoZ.datRef | Obrigatório | DateTime | Date(DD/MM/YYYY) - Data de referência da redução Z. |
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:ExcluirReducaoZResponse> <result> <Retorno> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <codEqu>Integer</codEqu> <datRef>String</datRef> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </Retorno> <erroExecucao>String</erroExecucao> </result> </ser:ExcluirReducaoZResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
retorno | Obrigatório | Set | Retorno (Cadastrado/Erros) |
retorno.codEmp | Obrigatório | Integer | Código da empresa |
retorno.codFil | Obrigatório | Integer | Código da filial |
retorno.codEqu | Obrigatório | Integer | Código do equipamento fiscal da redução Z |
retorno.datRef | Obrigatório | String | Data de referência da redução Z |
retorno.tipRet | Obrigatório | Integer | Tipo de Retorno |
retorno.msgRet | Obrigatório | String | Mensagem de Retorno (OK = Gravado) |
erroExecucao | Obrigatório | 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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExcluirTitulo> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <Titulo> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <codTpt>String</codTpt> <numTit>String</numTit> </Titulo> </parameters> </ser:ExcluirTitulo> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
titulo | Opcional | Set | |
titulo.codEmp | Obrigatório | Integer | Number(004) - Código da empresa |
titulo.codFil | Obrigatório | Integer | Number(005) - Código da filial |
titulo.codTpt | Obrigatório | String | String(003) - Código do tipo do título movimentado |
titulo.numTit | Obrigatório | String | String(025) - Número do título movimentado |
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:ExcluirTituloResponse> <result> <Retorno> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <codTpt>String</codTpt> <numTit>String</numTit> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </Retorno> <erroExecucao>String</erroExecucao> </result> </ser:ExcluirTituloResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
retorno | Obrigatório | Set | Retorno (Cadastrado/Erros) |
retorno.codEmp | Obrigatório | Integer | Código da empresa |
retorno.codFil | Obrigatório | Integer | Código da filial |
retorno.codTpt | Obrigatório | String | String(003) - Código do tipo do título movimentado |
retorno.numTit | Obrigatório | String | String(025) - Número do título movimentado |
retorno.tipRet | Obrigatório | Integer | Tipo de Retorno |
retorno.msgRet | Obrigatório | String | Mensagem de Retorno (OK = Gravado) |
erroExecucao | Obrigatório | 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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |