English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.int.varejo.SerieNF
Web service Com.senior.g5.co.int.varejo.SerieNF
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: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_int_varejo_SerieNF?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_SerieNF?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_SerieNF?wsdl
Porta
Exportar_2
Integrações - Varejo - Cadastros - Exportar Séries Nota Fiscal
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 2
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Exportar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<consulta>
<codSnf>String</codSnf>
</consulta>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<tipoIntegracao>String</tipoIntegracao>
<quantidadeRegistros>Integer</quantidadeRegistros>
<identificadorSistema>String</identificadorSistema>
</parameters>
</ser:Exportar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| consulta | Set | (Obrigatório) - Utilizar para informar quais registros devem ser retornados. Utilizar apenas quando o tipo de integração for específico ("E") |
| consulta.codSnf | String | (Obrigatório) - CodSnf - String(003) - Código da série de notas fiscais |
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| tipoIntegracao | String | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
| quantidadeRegistros | Integer | (Opcional) - Number(005) - Quantidade de registros limite para retorno da solicitação. Quando o tipo de integração for "E", este valor não é utilizado. |
| identificadorSistema | String | (Obrigatório) - String(15) - - Identificação do sistema integrado |
Resposta:
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:ExportarResponse>
<result>
<seriesNF>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codSnf>String</codSnf>
<desSnf>String</desSnf>
<abrSnf>String</abrSnf>
<ultNum>Integer</ultNum>
<ultDat>String</ultDat>
<numNfd>Integer</numNfd>
<numNfa>Integer</numNfa>
<qtdItp>Integer</qtdItp>
<qtdIts>Integer</qtdIts>
<qtdPar>Integer</qtdPar>
<aplSnf>String</aplSnf>
<ultPre>Integer</ultPre>
<modRel>String</modRel>
<modDup>String</modDup>
<ultDup>Double</ultDup>
<codEdc>String</codEdc>
<venDbs>String</venDbs>
<venDbv>String</venDbv>
<codSel>String</codSel>
<codSsl>String</codSsl>
<utiImp>String</utiImp>
<codEqu>Integer</codEqu>
<indNma>String</indNma>
<disAut>Integer</disAut>
<dirNel>String</dirNel>
<qtdPos>Integer</qtdPos>
<dirCte>String</dirCte>
<dirNes>String</dirNes>
<excVar>String</excVar>
<seqInt>Integer</seqInt>
</seriesNF>
<gridErros>
<msgErr>String</msgErr>
</gridErros>
<finalizaramRegistros>String</finalizaramRegistros>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<numeroLote>Integer</numeroLote>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExportarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | 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" |
| seriesNF | Set | Dados gerais das marcas. |
| seriesNF.codEmp | Integer | (Obrigatório) - CodEmp - Number(004) - Código da empresa |
| seriesNF.codFil | Integer | (Opcional) - CodFil - Number(005) - Código da filial |
| seriesNF.codSnf | String | (Obrigatório) - CodSnf - String(003) - Código da série de notas fiscais |
| seriesNF.desSnf | String | (Obrigatório) - DesSnf - String(030) - Descrição da série de notas fiscais |
| seriesNF.abrSnf | String | (Obrigatório) - AbrSnf - String(010) - Abreviatura da série de notas fiscais |
| seriesNF.ultNum | Integer | (Opcional) - UltNum - Number(009) - Número da última nota fiscal emitida pela filial |
| seriesNF.ultDat | DateTime | (Opcional) - UltDat - Date(DD/MM/YYYY) - Data da última nota fiscal emitida pela filial |
| seriesNF.numNfd | Integer | (Opcional) - NumNfd - Number(009) - Faixa de número das últimas NF impressas |
| seriesNF.numNfa | Integer | (Opcional) - NumNfa - Number(009) - Últimas emissões de NF até número... |
| seriesNF.qtdItp | Integer | (Opcional) - QtdItp - Number(003) - Quantidade máxima de itens de produtos previsto para a nota fiscal |
| seriesNF.qtdIts | Integer | (Opcional) - QtdIts - Number(003) - Quantidade máxima de itens de serviços previsto para a nota fiscal |
| seriesNF.qtdPar | Integer | (Opcional) - QtdPar - Number(003) - Quantidade de parcelas permitidas pela série de NF |
| seriesNF.aplSnf | String | (Obrigatório) - AplSnf - String(001) - Aplicação da série de nota fiscal Lista: S = Notas Fiscais de Entrada e Saída, M = Geração Manual CR e CP, E = Somente para NF Entrada, F = Somente para Manifesto, D = Somente para NF Saída |
| seriesNF.ultPre | Integer | (Opcional) - UltPre - Number(009) - Número do último número de nota fiscal pré-impresso |
| seriesNF.modRel | String | (Opcional) - ModRel - String(012) - Código do modelo de emissão de notas fiscais |
| seriesNF.modDup | String | (Opcional) - ModDup - String(012) - Código do modelo de emissão de duplicatas |
| seriesNF.ultDup | Double | (Opcional) - UltDup - Number(010,0) - Número da última duplicata gerada |
| seriesNF.codEdc | String | (Opcional) - CodEdc - String(003) - Espécie de documento para fins fiscais |
| seriesNF.venDbs | DateTime | (Opcional) - VenDbs - Date(DD/MM/YYYY) - Data base da saída de mercadoria para nota fiscal |
| seriesNF.venDbv | DateTime | (Opcional) - VenDbv - Date(DD/MM/YYYY) - Data base para cálculo dos vencimento dos títulos a serem gerados |
| seriesNF.codSel | String | (Opcional) - CodSel - String(003) - Código da Série Legal |
| seriesNF.codSsl | String | (Opcional) - CodSsl - String(002) - Código da Subsérie Legal |
| seriesNF.utiImp | String | (Opcional) - UtiImp - String(001) - Indicativo se a série é utilizada para impostos (integração) Lista: N = Não, S = Sim |
| seriesNF.codEqu | Integer | (Opcional) - CodEqu - Number(003) - Código Equipamento Fiscal Padrão |
| seriesNF.indNma | String | (Opcional) - IndNma - String(001) - Indicativo se permite controlar a numeração das notas fiscais de saída manualmente Lista: N = Não, S = Sim |
| seriesNF.disAut | Integer | (Opcional) - DisAut - Number(001) - Tipo de dispositivo autorizado para a série de nota fiscal Lista: 1 = Blocos, 2 = Formulário Contínuo, 3 = Formulário de Segurança, 4 = Jogos Soltos, 5 = ECF, 6 = Nota Fiscal Eletrônica, 7 = Conhecimento de Transporte Eletrônico, 8 = Nota Fiscal Eletrônica de Serviço, 9 = Manifesto Eletrônico |
| seriesNF.dirNel | String | (Opcional) - DirNel - String(250) - Diretório onde deve ser gravado o arquivo de exportação da nota fiscal eletrônica |
| seriesNF.qtdPos | Integer | (Opcional) - QtdPos - Number(002) - Quantidade de posições do número da nota fiscal desta série |
| seriesNF.dirCte | String | (Opcional) - DirCte - String(250) - Diretório onde deve ser gravado o arquivo de exportação do conhecimento de transporte eletrônico |
| seriesNF.dirNes | String | (Opcional) - DirNes - String(250) - Diretório onde deve ser gravado o arquivo de exportação da nota fiscal eletrônica de serviço |
| seriesNF.excVar | String | (Obrigatório) - ExcVar - String(001) - Indica se o uso desta série é exclusiva do sistema de varejo Lista: N = Não, S = Sim |
| seriesNF.seqInt | Integer | (Obrigatório) - SeqInt - Number(009) - Sequencial do Registro Integrado |
| gridErros | Set | (Opcional) - Lista dos erro |
| gridErros.msgErr | String | Erros |
| finalizaramRegistros | String | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| numeroLote | Integer | (Obrigatório) - Inteiro - Identificação do Lote de Exportação |
English
Español
