English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.int.varejo.cupomespelho
Web service Com.senior.g5.co.int.varejo.cupomespelho
Este Web service possibilita o serviço para importação de notas fiscais de venda que servirão de espelho para os cupons fiscais emitidos no varejo.
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.
Campos 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
Exemplo:
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.
Campos 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
Exemplo:
- 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: hhttp://servidor:1234/g5-senior-services/sapiens_Synccom_senior_g5_co_int_varejo_cupomespelho?wsdl
- Assíncrono: http://servidor:1234/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_cupomespelho?wsdl
- Agendado: http://servidor:1234/g5-senior-services/sapiens_Schedulecom_senior_g5_co_int_varejo_cupomespelho?wsdl
Porta
ImportarNotaEspelhoCupom
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
Versão atual: 1.
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:ImportarNotaEspelhoCupom>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<dadosGerais>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<tnsPro>String</tnsPro>
<tnsSer>String</tnsSer>
<datEmi>DateTime</datEmi>
<obsNfv>String</obsNfv>
<numNcf>Integer</numNcf>
<snfNcf>String</snfNcf>
<codEqu>Integer</codEqu>
<numCfi>Integer</numCfi>
<numCro>Integer</numCro>
<ideExt>Integer</ideExt>
<tipOpe>Integer</tipOpe>
<documentosEletronicos>
<sitDoe>Integer</sitDoe>
<sitDea>Integer</sitDea>
<chvDoe>String</chvDoe>
<numDfs>Double</numDfs>
<codVer>String</codVer>
<numPrt>String</numPrt>
<datAut>DateTime</datAut>
<horAut>String</horAut>
<usuEmi>Double</usuEmi>
<numPrc>String</numPrc>
<datCan>DateTime</datCan>
<horCan>String</horCan>
<usuCan>Double</usuCan>
<numPri>String</numPri>
<datInu>DateTime</datInu>
<horInu>String</horInu>
<usuInu>Double</usuInu>
</documentosEletronicos>
<eventosDocumentos>
<seqEve>Integer</seqEve>
<tipEve>Integer</tipEve>
<desEve>String</desEve>
<datEve>DateTime</datEve>
<horEve>String</horEve>
<usuEve>Integer</usuEve>
<codOrg>Integer</codOrg>
<desCor>String</desCor>
<sitCce>Integer</sitCce>
<numPrt>String</numPrt>
<datAut>DateTime</datAut>
<horAut>String</horAut>
<jusEve>String</jusEve>
</eventosDocumentos>
</dadosGerais>
<identificacaoSistema>String</identificacaoSistema>
</parameters>
</ser:ImportarNotaEspelhoCupom>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Preenchimento | Tipo | Descrição |
|---|---|---|---|
| dadosGerais | Opcional | Set | Conjunto de dados gerais da nota fiscal de venda |
| dadosGerais.codEmp | Opcional | Integer | Código da empresa |
| dadosGerais.codFil | Opcional | Integer | Código da filial |
| dadosGerais.codSnf | Opcional | String | Código da série da nota fiscal |
| dadosGerais.numNfv | Opcional | Integer | Número da nota fiscal de venda |
| dadosGerais.tnsPro | Opcional | String | Código da transação do produto |
| dadosGerais.tnsSer | Opcional | String | Código da transação do serviço |
| dadosGerais.datEmi | Opcional | DateTime | Data de emissão |
| dadosGerais.obsNfv | Opcional | String | Observações da nota fiscal |
| dadosGerais.numNcf | Opcional | Integer | Número do cupom fiscal |
| dadosGerais.snfNcf | Opcional | String | Série do cupom fiscal |
| dadosGerais.codEqu | Opcional | Integer | Código do equipamento ECF |
| dadosGerais.numCfi | Opcional | Integer | Número do COO - Contador de Ordem de Operação |
| dadosGerais.numCro | Opcional | Integer | Número do CRO - Contador de Reinício de Operação |
| dadosGerais.ideExt | Opcional | Integer | Identificação externa |
| dadosGerais.tipOpe | Opcional | Integer | Tipo de operação |
| documentosEletronicos | Opcional | Set | Informações dos documentos eletrônicos |
| documentosEletronicos.sitDoe | Opcional | Integer | Situação do documento eletrônico |
| documentosEletronicos.sitDea | Opcional | Integer | Situação do documento eletrônico auxiliar |
| documentosEletronicos.chvDoe | Opcional | String | Chave do documento eletrônico |
| documentosEletronicos.numDfs | Opcional | Double | Número do documento fiscal |
| documentosEletronicos.codVer | Opcional | String | Código de verificação |
| documentosEletronicos.numPrt | Opcional | String | Número do protocolo |
| documentosEletronicos.datAut | Opcional | DateTime | Data de autorização |
| documentosEletronicos.horAut | Opcional | String | Hora de autorização |
| documentosEletronicos.usuEmi | Opcional | Double | Usuário de emissão |
| documentosEletronicos.numPrc | Opcional | String | Número do processo |
| documentosEletronicos.datCan | Opcional | DateTime | Data de cancelamento |
| documentosEletronicos.horCan | Opcional | String | Hora de cancelamento |
| documentosEletronicos.usuCan | Opcional | Double | Usuário do cancelamento |
| documentosEletronicos.numPri | Opcional | String | Número do protocolo de inutilização |
| documentosEletronicos.datInu | Opcional | DateTime | Data de inutilização |
| documentosEletronicos.horInu | Opcional | String | Hora de inutilização |
| documentosEletronicos.usuInu | Opcional | Double | Usuário da inutilização |
| eventosDocumentos | Opcional | Set | Eventos relacionados aos documentos |
| eventosDocumentos.seqEve | Opcional | Integer | Sequência do evento |
| eventosDocumentos.tipEve | Opcional | Integer | Tipo do evento |
| eventosDocumentos.desEve | Opcional | String | Descrição do evento |
| eventosDocumentos.datEve | Opcional | DateTime | Data do evento |
| eventosDocumentos.horEve | Opcional | String | Hora do evento |
| eventosDocumentos.usuEve | Opcional | Integer | Usuário do evento |
| eventosDocumentos.codOrg | Opcional | Integer | Código do órgão |
| eventosDocumentos.desCor | Opcional | String | Descrição da correção |
| eventosDocumentos.sitCce | Opcional | Integer | Situação da carta de correção eletrônica |
| eventosDocumentos.numPrt | Opcional | String | Número do protocolo |
| eventosDocumentos.datAut | Opcional | DateTime | Data de autorização |
| eventosDocumentos.horAut | Opcional | String | Hora de autorização |
| eventosDocumentos.jusEve | Opcional | String | Justificativa do evento |
| identificacaoSistema | Opcional | String | String(015) - Identificação do sistema integrado |
Resposta:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:ImportarNotaEspelhoCupomResponse>
<result>
<mensagemRetorno>String</mensagemRetorno>
<tipoRetorno>Integer</tipoRetorno>
<retorno>
<codEmp>String</codEmp>
<codFil>Integer</codFil>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<ideExt>Integer</ideExt>
<tipRet>Integer</tipRet>
<msgRet>String</msgRet>
</retorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ImportarNotaEspelhoCupomResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Preenchimento | Tipo | Descrição |
|---|---|---|---|
| mensagemRetorno | Opcional | String | String(1000) - Mensagem de Retorno de Processamento |
| tipoRetorno | Opcional | Integer |
Número(001) - Tipo de Retorno de Processamento:
|
| retorno | Opcional | Set | Conjunto de dados de retorno do processamento |
| retorno.codEmp | Opcional | String | Código da empresa |
| retorno.codFil | Opcional | Integer | Código da filial |
| retorno.codSnf | Opcional | String | Código da série da nota fiscal |
| retorno.numNfv | Opcional | Integer | Número da nota fiscal de venda |
| retorno.ideExt | Opcional | Integer | Identificação externa |
| retorno.tipRet | Opcional | Integer | Tipo de retorno |
| retorno.msgRet | Opcional | String | Mensagem de retorno |
| 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 |
English
Español
