Web service Com.senior.g5.co.int.venda.documentofiscal
Web service para cálculo de retenção. As alíquotas de retenção de PIS, COFINS, CSLL, Outras Retenções e IRRF são sugeridas quando:
Quando é enviada uma unidade de medida de venda (UniVen) diferente da unidade de medida de estoque (UniMed) configurada para o produto, o sistema faz a conversão da quantidade enviada para a unidade de estoque.
Exemplo
Produto cadastrado com unidade de medida de estoque em quilos (KG) e vendido em gramas (GR) no preço de venda de R$10,00. Caso seja enviada a quantidade 100 na unidade de medida GR, a quantidade faturada em quilos deve ser convertida para 0,1 e o preço unitário convertido para R$10.000,00. Então:
- 100 gramas x R$10,00 = R$1.000,00 (unidade comercial);
- 0,1 quilo x R$10.000,00 = R$1.000,00 (unidade tributável).
Controlar produtos com ICMS ST entre filiais em estados diferentes
Quando uma empresa possui duas ou mais filiais em estados diferentes e comercializa produtos com ICMS ST em um estado, enquanto em outro o produto não é controlado pelo ICMS ST, este último não pode ser considerado no Controle de Entrada e Saída; o primeiro, sim.
Exemplo: no estado de SC, o produto A não tem ICMS ST. No estado do RS, sim; ou seja, deve passar pelos processos de ressarcimento, restituição e complementação. Como o processo parte do produto registrado nas estruturas de Entrada e Saída, se o produto para determinada filial não estiver no Controle, ele não será apresentado na declaração para o estado. Diante disso, é necessário parametrizar a nível de filial se o produto deve ou não entrar no Controle:
Ao tratar uma nota/cupom fiscal, o sistema analisa o conteúdo do campo Reg. entradas e saídas para controle de impostos das telas F075PFI/F075APF, juntamente com as parametrizações das telas F075PRO/F075GFP:
- Quando não há ligação do produto com a filial: o sistema gera um registro no Controle de Entrada e Saída de produtos apenas se na derivação for informado S-Sim para o campo Reg. entradas e saídas para controle de impostos;
- Quando há ligação do produto com a filial: o sistema gera um registro no Controle de Entrada e Saída de produtos apenas se na derivação e na ligação for informado S-Sim para o campo Reg. entradas e saídas para controle de impostos;
- Caso contrário, o sistema não gera um registro no Controle de Entrada e Saída de produtos.
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_venda_documentofiscal?wsdl`
- Assíncrono: `http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_venda_documentofiscal?wsdl`
- Agendamento: `http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_int_venda_documentofiscal?wsdl`
Portas
CalcularRetencoes
Este serviço permite a realização de uma simulação de cálculo de retenção dos seguintes impostos: PIS, COFINS, CSLL, IRRF e Outras Retenções. São consideradas as parametrizações da filial, cliente, produto e serviço, enviadas na requisição. Caso o cliente não possua definições na filial enviada na requisição, o sistema duplica automaticamente as definições com base na filial configurada como Matriz.
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Versão atual: 1
Classe do sistema ERP que implementa a porta do web service: TSr140CalcularRetencoesDocumentosFiscais.
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:CalcularRetencoes>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<Cabecalho>
<cnpjFilial>String</cnpjFilial>
<identificadorCliente>String</identificadorCliente>
<itensVenda>
<iteFis>String</iteFis>
<proSer>String</proSer>
<indTel>String</indTel>
<uniVen>String</uniVen>
<qtdVen>Double</qtdVen>
<preVen>Double</preVen>
<perDsc>Double</perDsc>
<vlrDsc>Double</vlrDsc>
<vlrLiq>Double</vlrLiq>
</itensVenda>
</Cabecalho>
</parameters>
</ser:CalcularRetencoes>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| cabecalho | Set | Opcional | (Obrigatório) - Lista com os dados das vendas a serem calculadas |
| cabecalho.cnpjFilial | String | Opcional | (Obrigatório) - String(014) - CNPJ da filial que está emitindo a venda |
| cabecalho.identificadorCliente | String | Opcional | (Obrigatório) - String(040) - CNPJ, CPF ou documento estrangeiro do cliente |
| itensVenda | Set | Opcional | (Obrigatório) - Lista com os dados dos itens da venda |
| itensVenda.iteFis | String | Opcional | (Obrigatório) - String(060) - Código fiscal do item da venda |
| itensVenda.proSer | String | Opcional | (Obrigatório) - String(001) - Definindo sé é produto ou serviço (“P – Produtos”, “S – Serviços”) |
| itensVenda.indTel | String | Opcional | (Opcional) - String(001) - Determina se o item é telemático (“S – Sim”, "N - Não", "Vazio - Não") |
| itensVenda.uniVen | String | Opcional | (Opcional) - String(003) - Unidade de medida de venda |
| itensVenda.qtdVen | Double | Opcional | (Obrigatório) - Number(014,5) - Quantidade de venda |
| itensVenda.preVen | Double | Opcional | (Obrigatório) - Number(014,5) - Preço de venda |
| itensVenda.perDsc | Double | Opcional | (Opcional) - Number(005,2) - Percentual de desconto |
| itensVenda.vlrDsc | Double | Opcional | (Opcional) - Number(015,2) - Valor do desconto |
| itensVenda.vlrLiq | Double | Opcional | (Obrigatório) - Number(015,2) - Valor líquido do item |
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:CalcularRetencoesResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<Retornos>
<cnpjFilial>String</cnpjFilial>
<identificadorcliente>String</identificadorcliente>
<tipoRetorno>String</tipoRetorno>
<totalRetencoes>Double</totalRetencoes>
<itens>
<iteFis>String</iteFis>
<preVen>String</preVen>
<codPit>Integer</codPit>
<vlrBpt>Double</vlrBpt>
<perPit>Double</perPit>
<vlrPit>Double</vlrPit>
<codCrt>Integer</codCrt>
<vlrBct>Double</vlrBct>
<perCrt>Double</perCrt>
<vlrCrt>Double</vlrCrt>
<codCsl>Integer</codCsl>
<vlrBcl>Double</vlrBcl>
<perCsl>Double</perCsl>
<vlrCsl>Double</vlrCsl>
<codOur>Integer</codOur>
<vlrBor>Double</vlrBor>
<perOur>Double</perOur>
<vlrOur>Double</vlrOur>
<codIrf>Integer</codIrf>
<vlrBir>Double</vlrBir>
<perIrf>Double</perIrf>
<vlrIrf>Double</vlrIrf>
<totRet>Double</totRet>
<vlrliq>Double</vlrliq>
</itens>
<erros>
<mensagem>String</mensagem>
</erros>
</Retornos>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:CalcularRetencoesResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| tipoRetorno | Integer | Opcional | (Obrigatório) - Number(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
| retornos | Set | Opcional | (Obrigatório) - Lista com os dados de retornos das vendas |
| retornos.cnpjFilial | String | Opcional | (Obrigatório) - String(014) - CNPJ da filial |
| retornos.identificadorcliente | String | Opcional | (Obrigatório) - String(040) - CNPJ, CPF ou documento estrangeiro do cliente |
| retornos.tipoRetorno | String | Opcional | (Obrigatório) - Number(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
| retornos.totalRetencoes | Double | Opcional | (Obrigatório) - Number(015,2) - Soma do valor total das retenções de todos os itens. |
| itens | Set | Opcional | Lista com os dados dos itens da venda calculados |
| itens.iteFis | String | Opcional | String(060) - Código fiscal do item da venda |
| itens.preVen | Double | Opcional | Number(014,5) - Preço de venda informado para o item. |
| itens.codPit | Integer | Opcional | Number(009) - Código para documento de arrecadação (PIS) |
| itens.vlrBpt | Double | Opcional | Number(015,2) - Valor base do PIS Retido |
| itens.perPit | Double | Opcional | Number(004,2) - Percentual de PIS Retido |
| itens.vlrPit | Double | Opcional | Number(015,2) - Soma dos valores do PIS retido |
| itens.codCrt | Integer | Opcional | Number(009) - Código para documento de arrecadação (COFINS) |
| itens.vlrBct | Double | Opcional | Number(015,2) - Valor base do Cofins Retido |
| itens.perCrt | Double | Opcional | Number(004,2) - Percentual de Cofins Retido |
| itens.vlrCrt | Double | Opcional | Number(015,2) - Valor do Cofins Retido |
| itens.codCsl | Integer | Opcional | Number(009) - Código para documento de arrecadação (CSLL) |
| itens.vlrBcl | Double | Opcional | Number(015,2) - Valor base do CSLL Retido |
| itens.perCsl | Double | Opcional | Number(004,2) - Percentual de CSLL Retido |
| itens.vlrCsl | Double | Opcional | Number(015,2) - Valor do CSLL Retido |
| itens.codOur | Integer | Opcional | Number(009) - Código para documento de arrecadação (Outras Retenções) |
| itens.vlrBor | Double | Opcional | Number(015,2) - Valor base de Outras Retenções |
| itens.perOur | Double | Opcional | Number(004,2) - Percentual de Outras Retenções |
| itens.vlrOur | Double | Opcional | Number(015,2) - Valor de Outras Retenções |
| itens.codIrf | Integer | Opcional | Number(009) - Código para documento de arrecadação (IRRF) |
| itens.vlrBir | Double | Opcional | Number(015,2) - Valor base IRRF |
| itens.perIrf | Double | Opcional | Number(004,2) - Percentual do IRRF |
| itens.vlrIrf | Double | Opcional | Number(015,2) - Valor do IRRF |
| itens.totRet | Double | Opcional | Number(015,2) - Valor total da retenção |
| itens.vlrliq | Double | Opcional | Number(015,2) - Valor líquido |
| erros | Set | Opcional | (Obrigatório) - Lista com as mensagens de erros ocorridas no processamento da venda (independente de documento fiscal) |
| erros.mensagem | String | Opcional | (Obrigatório) - String(1000) - Mensagem de erro |
| mensagemRetorno | String | Opcional | (Obrigatório) - String(255) - Mensagem de retorno da situação da execução do serviço |
| erroExecucao | String | Opcional | 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. |
Este web service atua nos seguintes tipos de retenção:
Retenção de produtos- PIS, COFINS e CSLL:
- o campo Retenção por Produto estiver parametrizado como Sim, no Cadastro de Empresa (F070EMP), indicando que a empresa está configurada para retenção de produto;
- o campo Retenção por Produto estiver parametrizado como Sim, na guia Cadastro do Cadastro de Cliente (F085CAD),indicando que o cliente está configurado para retenção de produtos;
- o tipo de retenção estiver parametrizado como C (considera outras retenções como imposto próprio) ou O (desconsidera somente outras retenções), no campo Tipo Retenção, na guia Vendas 2 da tela Parâmetros da Filial para Vendas (F070FVE);
- o cliente estiver configurado para reter PIS, COFINS ou CSLL na tela Cadastro do Cadastro de Cliente (F085CAD).
Se todas as condições acima estiverem atendidas, as alíquotas são buscadas do cadastro de produto.
- Outras Retenções:
- o campo Retenção por Produto estiver parametrizado como Sim, no Cadastro de Empresa (F070EMP), indicando que a empresa está configurada para retenção de produto;
- o campo Retenção por Produto estiver parametrizado como Sim, na guia Cadastro do Cadastro de Cliente (F085CAD),indicando que o cliente está configurado para retenção de produtos;
- o tipo de retenção estiver parametrizado como C (considera outras retenções como imposto próprio) ou S (substitui CSLL/COFINS/PIS em outras retenções), no campo Tipo Retenção, na guia Vendas 2 da tela Parâmetros da Filial para Vendas (F070FVE);
- o cliente estiver configurado para outras retenções na tela Cadastro do Cadastro de Cliente (F085CAD).
Se todas as condições acima estiverem atendidas, as alíquotas são buscadas do cadastro de produto.
- IRRF
- o campo Retenção por Produto estiver parametrizado como Sim, no Cadastro de Empresa (F070EMP), indicando que a empresa está configurada para retenção de produto;
- o campo Retenção por Produto estiver parametrizado como Sim, na guia Cadastro do Cadastro de Cliente (F085CAD),indicando que o cliente está configurado para retenção de produtos;
- o cliente estiver configurado para reter IRRF na tela Cadastro do Cadastro de Cliente (F085CAD).
Se todas as condições acima estiverem atendidas e o cliente for empresa pública (Tipo Direito Propriedade (F085CAD) = 2), a alíquota é buscada do campo % IRRF Empresa Pública do cadastro de produto. Caso o cliente for empresa privada (Tipo Direito Propriedade (F085CAD) = 1), a alíquota é buscada do campo % IRRF.
Retenção de serviços- PIS, COFINS e CSLL:
- o tipo de retenção estiver parametrizado como C (considera outras retenções como imposto próprio) ou O (desconsidera somente outras retenções), no campo Tipo Retenção, na guia Vendas 2 da tela Parâmetros da Filial para Vendas (F070FVE);
- o cliente estiver configurado para outras retenções na tela Cadastro do Cadastro de Cliente (F085CAD).
Se todas as condições acima estiverem atendidas, as alíquotas são buscadas do cadastro de serviço.
- Outras Retenções:
- o tipo de retenção estiver parametrizado como C (considera outras retenções como imposto próprio) ou S (substitui CSLL/COFINS/PIS em outras retenções), no campo Tipo Retenção, na guia Vendas 2 da tela Parâmetros da Filial para Vendas (F070FVE);
- o cliente estiver configurado para outras retenções na tela Cadastro do Cadastro de Cliente (F085CAD).
Se todas as condições acima estiverem atendidas, as alíquotas são buscadas do cadastro de serviço.
- IRRF:
- o cliente estiver configurado para reter IRRF na tela Cadastro do Cadastro de Cliente (F085CAD).
Se todas as condições acima estiverem atendidas e o cliente for empresa pública (Tipo Direito Propriedade (F085CAD) = 2), a alíquota é buscada do campo % IRRF Empresa Pública do cadastro de serviço. Caso o cliente for empresa privada (Tipo Direito Propriedade (F085CAD) = 1), a alíquota é buscada do campo % IRRF.
Cancelar
Serviço para o cancelamento de vendas que geraram no ERP documentos fiscais de saída no modelo 21 (Nota Fiscal de Comunicação), no modelo 55 (Nota Fiscal Eletrônica) ou no modelo 65 (Nota Fiscal de Consumidor Eletrônica).
Quando é requisitado o cancelamento de um documento fiscal que esteja na situação "1 - Digitado", ele será inutilizado na SEFAZ mesmo que sua numeração seja a última da série fiscal.
Observação
Esta porta não deve ser utilizada para cancelar notas fiscais geradas por uma pré-fatura, pois o web service não tem essa finalidade. Para cancelamento de notas fiscais geradas por pré-fatura, deve ser utilizado o web service Com.senior.g5.co.mcm.ven.notafiscal, porta GravarNotasFiscaisSaida_13, onde o valor do campo tipoProcessamento deve ser "3 - Cancelamento", além da passagem dos demais parâmetros necessários para a solicitação de cancelamento de uma nota fiscal.
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Versão atual: 1
Classe do sistema ERP que implementa a porta do web service: TSr140CancelamentoDocumentosFiscais.
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Cancelar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<Cabecalho>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<cnpjFil>String</cnpjFil>
<numInt>String</numInt>
<chvDoe>String</chvDoe>
<obsCan>String</obsCan>
<chvNrf>String</chvNrf>
</Cabecalho>
</parameters>
</ser:Cancelar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| cabecalho | Set | Opcional | (Obrigatório) - Lista com os dados das vendas a serem canceladas |
| cabecalho.codEmp | Integer | Opcional | (Obrigatório quando informado CodFil, CodSnf, NumNfv) - Number(004) - Código da empresa |
| cabecalho.codFil | Integer | Opcional | (Obrigatório quando informado CodEmp, CodSnf, NumNfv) - Number(005) - Código da filial |
| cabecalho.codSnf | String | Opcional | (Obrigatório quando informado CodEmp, CodFil, NumNfv) - String(3) - Série da nota fiscal |
| cabecalho.numNfv | Integer | Opcional | (Obrigatório quando informado CodEmp, CodFil, CodSnf) - Number(009) - Número da nota fiscal |
| cabecalho.cnpjFil | String | Opcional | (Obrigatório quando informado NumInt) - String(014) - CNPJ da filial de emissão da venda. Quando informado o CNPJ, o sistema considera somente as filiais que não são consolidadoras de movimentos de impostos |
| cabecalho.numInt | String | Opcional | (Obrigatório quando informado CnpjFil) - String(100) - Número do documento externo (Integrado) |
| cabecalho.chvDoe | String | Opcional | (Obrigatório) - String(045) - Chave eletrônica do documento fiscal |
| cabecalho.obsCan | String | Opcional | (Opcional) - String(1000) - Descrição do motivo do cancelamento da venda |
| cabecalho.chvNrf | String | Opcional | Chave da Nota Fiscal Eletrônica referenciada, para cancelamento por substituição. |
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:CancelarResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<RetornosDocumentos>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<cnpjFil>String</cnpjFil>
<numInt>String</numInt>
<chvDoe>String</chvDoe>
<retornos>
<cnpjFil>String</cnpjFil>
<codEmp>Integer</codEmp>
<codFIl>Integer</codFIl>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<codEdc>String</codEdc>
<codSel>String</codSel>
<sitDoe>Integer</sitDoe>
<chvDoe>String</chvDoe>
<prtAut>String</prtAut>
<tipoRetorno>String</tipoRetorno>
<numPrc>String</numPrc>
<datCan>DateTime</datCan>
<horCan>Integer</horCan>
<numPri>String</numPri>
<datInu>DateTime</datInu>
<horInu>Integer</horInu>
<eventos>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<seqEve>Integer</seqEve>
<tipEve>Integer</tipEve>
<desEve>String</desEve>
<datEve>DateTime</datEve>
<horEve>Integer</horEve>
<usuEve>Double</usuEve>
<codOrg>Integer</codOrg>
<desCor>String</desCor>
<sitCce>Integer</sitCce>
<numPrt>String</numPrt>
<datAut>DateTime</datAut>
<horAut>Integer</horAut>
<jusEve>String</jusEve>
<nomMot>String</nomMot>
<cgcCpf>Double</cgcCpf>
<numPrc>String</numPrc>
<datPro>DateTime</datPro>
<horPro>Integer</horPro>
<datPrc>DateTime</datPrc>
<horPrc>Integer</horPrc>
<ideEve>String</ideEve>
<eveOri>String</eveOri>
<xmlEve>String</xmlEve>
</eventos>
<itens>
<itemFiscal>String</itemFiscal>
<seqItem>Integer</seqItem>
</itens>
<erros>
<mensagem>String</mensagem>
</erros>
</retornos>
</RetornosDocumentos>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:CancelarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| tipoRetorno | Integer | Opcional | (Obrigatório) - Number(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
| retornosDocumentos | Set | Opcional | (Obrigatório) - Lista com os dados de retorno das vendas canceladas |
| retornosDocumentos.codEmp | Integer | Opcional | (Obrigatório) - Number(004) - Código da empresa |
| retornosDocumentos.codFil | Integer | Opcional | (Obrigatório) - Number(005) - Código da filial |
| retornosDocumentos.codSnf | String | Opcional | (Obrigatório) - String(3) - Série da nota fiscal |
| retornosDocumentos.numNfv | Integer | Opcional | (Obrigatório) - Number(009) - Número da nota fiscal |
| retornosDocumentos.cnpjFil | String | Opcional | (Obrigatório) - String(014) - CNPJ da filial de emissão da venda |
| retornosDocumentos.numInt | String | Opcional | (Obrigatório) - String(100) - Número do documento externo (Integrado) |
| retornosDocumentos.chvDoe | String | Opcional | (Obrigatório) - String(045) - Chave eletrônica do documento fiscal |
| retornos | Set | Opcional | (Obrigatório) - Lista com os dados de retorno dos documentos fiscais da venda que foram cancelados |
| retornos.cnpjFil | String | Opcional | (Obrigatório) - Number(014) - CNPJ da filial |
| retornos.codEmp | Integer | Opcional | (Obrigatório) - Number(004) - Código da empresa |
| retornos.codFIl | Integer | Opcional | (Obrigatório) - Number(005) - Código da filial |
| retornos.codSnf | String | Opcional | (Obrigatório) - String(003) - Código da série fiscal |
| retornos.numNfv | Integer | Opcional | (Obrigatório) - Number(009) - Número da nota fiscal |
| retornos.codEdc | String | Opcional | (Obrigatório) - String(003) - Código do modelo do documento fiscal (21 = Nota Fiscal de Comunicação; 55 = Nota Fiscal Eletrônica; 65 = Nota Fiscal de Consumidor Eletrônica) |
| retornos.codSel | String | Opcional | (Obrigatório) - String(003) - Código da série legal |
| retornos.sitDoe | Integer | Opcional | (Obrigatório) - String(001) - Situação do documento eletrônico (0 = Não se aplica 1 = Não Enviada; 2 = Enviada; 3 = Autorizada; 4 = Rejeitada; 5 = Denegada; 6 = Solicitado Inutilização; 7 = Solicitado Cancelamento; 8 = Inutilizada; 9 = Cancelada; 10 = Erro Geração; 11 = Erro Solicitação Cancelamento; 12 = Erro Solicitação Inutilização; 13 = Pendente de Cancelamento; 16 = Autorizado em Contingência (utilizado apenas para retorno WebService); 17= Evento registrado (evento pror. suspensão ICMS - utilizado apenas Web Service); 18 = Deferido parcial (evento pror. suspensão ICMS - utilizado apenas no Web Service); 19 = Indeferido (evento prorrogação suspensão ICMS - utilizado apenas no Web Service)) |
| retornos.chvDoe | String | Opcional | (Obrigatório) - String(045) - Chave eletrônica do documento fiscal |
| retornos.prtAut | String | Opcional | (Obrigatório) - String(015) - Protocolo de autorização de envio do documento eletrônico |
| retornos.tipoRetorno | String | Opcional | (Obrigatório) - String(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
| retornos.numPrc | String | Opcional | String(015) - Número do protocolo de cancelamento do documento eletrônico |
| retornos.datCan | DateTime | Opcional | Date(DD/MM/YYYY) - Data de autorização para cancelamento do documento eletrônico |
| retornos.horCan | Integer | Opcional | Number(005) - Hora da autorização do cancelamento do documento eletrônico |
| retornos.numPri | String | Opcional | String(015) - Número do protocolo de inutilização do documento eletrônico |
| retornos.datInu | DateTime | Opcional | Date(DD/MM/YYYY) - Data de autorização da Inutilização do documento eletrônico |
| retornos.horInu | Integer | Opcional | Number(005) - Hora da autorização de inutilização do documento eletrônico |
| eventos | Set | Opcional | Lista de eventos |
| eventos.codEmp | Integer | Opcional | Number(004) - Código da empresa |
| eventos.codFil | Integer | Opcional | Number(005) - Código da filial |
| eventos.codSnf | String | Opcional | String(003) - Código da série da nota fiscal de saída |
| eventos.numNfv | Integer | Opcional | Number(009) - Número da nota fiscal de saída |
| eventos.seqEve | Integer | Opcional | Number(004) - Sequência do evento |
| eventos.tipEve | Integer | Opcional | Number(006) - Tipo do evento |
| eventos.desEve | String | Opcional | String(060) - Descrição do evento |
| eventos.datEve | DateTime | Opcional | Date(DD/MM/YYYY) - Data do evento |
| eventos.horEve | Integer | Opcional | Number(005) - Hora do evento |
| eventos.usuEve | Double | Opcional | Number(010) - Usuário solicitante do evento |
| eventos.codOrg | Integer | Opcional | Number(002) - Código do órgão de recepção do evento |
| eventos.desCor | String | Opcional | String(999) - Descritivo da correção a ser considerada |
| eventos.sitCce | Integer | Opcional | Number(002) - Situação do evento (eventos de Cancelamento de NF-e e Carta de Correção) - [ 01=Não Enviada;02=Enviada;03=Autorizada;04=Rejeitada;05=Denegada;06=Solicitado Inutilização;07=Solicitado Cancelamento;08=Inutilizada;09=Cancelada;10=Erro Geração;11=Erro Solicitação Cancelamento;12=Erro Solicitação Inutilização;13=Pendente de Cancelamento;14=Solicitado Encerramento (MDF-e);15=Encerrado (MDF-e);16=Autorizado em Contingência (utilizado apenas para retorno WebService);17=Evento registrado (evento pror. suspensão ICMS - utilizado apenas Web Service);18=Deferido parcial (evento pror. suspensão ICMS - utilizado apenas no Web Service);19=Indeferido (evento prorrogação suspensão ICMS - utilizado apenas no Web Service) ] |
| eventos.numPrt | String | Opcional | String(015) - Número do protocolo de autorização ou recebimento |
| eventos.datAut | DateTime | Opcional | Date(DD/MM/YYYY) - Data do protocolo de autorização |
| eventos.horAut | Integer | Opcional | Number(005) - Hora do protocolo de autorização |
| eventos.jusEve | String | Opcional | String(254) - Justificativa do evento |
| eventos.nomMot | String | Opcional | String(100) - Nome do motorista |
| eventos.cgcCpf | Double | Opcional | Number(012) - Número do CPF do motorista |
| eventos.numPrc | String | Opcional | String(015) - Protocolo do pedido de cancelamento de prorrogação de suspensão de ICMS |
| eventos.datPro | DateTime | Opcional | Date(DD/MM/YYYY) - Data do protocolo de recebimento do evento de prorrogação de suspensão de ICMS |
| eventos.horPro | Integer | Opcional | Number(005) - Hora do protocolo de recebimento do evento de prorrogação de suspensão de ICMS |
| eventos.datPrc | DateTime | Opcional | Date(DD/MM/YYYY) - Data do protocolo de cancelamento do evento de prorrogação de suspensão de ICMS |
| eventos.horPrc | Integer | Opcional | Number(005) - Hora do protocolo de cancelamento do evento de prorrogação de suspensão de ICMS |
| eventos.ideEve | String | Opcional | String(100) - Identificação do evento |
| eventos.eveOri | String | Opcional | String(100) - Identificação do evento de origem emitido pelo contribuinte |
| eventos.xmlEve | String | Opcional | (Obrigatório) - String - XML do evento do documento eletrônico |
| itens | Set | Opcional | (Obrigatório) - Lista com os dados dos itens da venda vinculados ao documento fiscal |
| itens.itemFiscal | String | Opcional | (Obrigatório) - String(060) - Código fiscal do item da venda |
| itens.seqItem | Integer | Opcional | (Obrigatório) - Number(004) - Sequência do item da venda |
| erros | Set | Opcional | (Obrigatório) - Lista com as mensagens de erros ocorridos no cancelamento do documento fiscal da venda |
| erros.mensagem | String | Opcional | (Obrigatório) - String(1000) - Mensagem de retorno de erro ocorrido cancelamento do documento fiscal da venda |
| mensagemRetorno | String | Opcional | (Obrigatório) - String(1000) - Mensagem de retorno da situação da execução do serviço |
| erroExecucao | String | Opcional | 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. |
Emitir
Serviço para envio de vendas que poderão gerar no ERP documentos fiscais de saída no modelo 21 (Nota Fiscal de Comunicação), no modelo 55 (Nota Fiscal Eletrônica) ou no modelo 65 (Nota Fiscal de Consumidor Eletrônica).
São realizadas as seguintes validações:
- a soma dos valores das formas de pagamento deve ser igual ao valor líquido da venda;
- o valor líquido da venda deve ser igual a soma dos valores líquidos dos itens;
- quando informado percentual e valor de desconto, o valor de desconto deve ser igual ao resultado da operação "valor bruto * % desconto";
- o valor bruto do item deve ser igual ao resultado da operação "preço * quantidade";
- o valor líquido informado deve ser igual ao valor líquido calculado na Solução Fiscal;
- quando informado um item que é serviço (telemático ou outros), a unidade de medida de venda informada deve ser igual a unidade de medida do cadastro do serviço.
Ao emitir a NF-e, o sistema verifica se o tipo de integração, informado no campo Tipo de integração via web service no grupo Documentos Fiscais de Saída, subgrupo Modelo 55 da tela Parâmetros de Integração (F191CPT), é síncrona ou assíncrona. Se for síncrona, a comunicação com o eDocs é realizada obtendo a resposta na mesma requisição. Se a integração for assíncrona, o ERP envia a NF-e para o eDocs e retorna o status de Aguardando a SEFAZ.
Assim, o sistema integrado envia a nova requisição para que o ERP consulte a situação da NF-e no eDocs. Após a consulta, o ERP retorna a situação da NF-e (autorizada ou rejeitada).
Ao gerar uma NF-e junto a outros documentos (modelo 21 e/ou outros documentos), e a filial estiver configurada para emitir NF-e de forma assíncrona, os outros documentos são gerados apenas após a NF-e ser autorizada.
Na primeira requisição é gerada a NF-e e enviada à SEFAZ. O retorno do documento eletrônico indica que o ERP está aguardando o retorno da SEFAZ e o retorno do documento no modelo 21 e dos outros documentos retorna a mensagem Documento não processado pois há documentos eletrônicos aguardando autorização. Na segunda requisição é consultada a situação da NF-e no eDocs e, caso esteja autorizada, os demais documentos serão gerados. E caso a NF-e estiver rejeitada, nenhum documento é gerado.
Caso sejam enviados apenas itens de serviços com a forma de pagamento igual à que foi configurado no parâmetro Forma de pagamento para faturamento futuro no grupo Documentos fiscais de saída, subgrupo Outros Documentos da tela Parâmetros de Integração (F191CPT), os itens que seriam adicionados em outros documentos são ignorados, assim não é gerado nenhum documento. Dessa forma se uma venda contiver somente itens que gerariam outros documentos, não retorna nenhum documento para a venda.
Observação
As vendas realizadas por este web service se referem apenas a uso e consumo internas ou interestaduais. Caso o cliente seja estrangeiro, a operação será considerada interna (CFOP iniciada em "5").
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Versão atual: 1
Classe do sistema ERP que implementa a porta do web service: TSr140EmissaoDocumentosFiscais.
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Emitir>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<Cabecalho>
<cnpjFil>String</cnpjFil>
<identificadorCliente>String</identificadorCliente>
<identificadorTransportadora>String</identificadorTransportadora>
<vlrliq>Double</vlrliq>
<datSai>DateTime</datSai>
<horSai>Time</horSai>
<numInt>String</numInt>
<nroEnvio>Integer</nroEnvio>
<indPre>String</indPre>
<seqEnt>Integer</seqEnt>
<tipImp>String</tipImp>
<duplicarDefinicaoCliente>String</duplicarDefinicaoCliente>
<eMail>String</eMail>
<datPre>DateTime</datPre>
<chvRef>String</chvRef>
<formaPagamento>
<tipPag>String</tipPag>
<vlrPar>Double</vlrPar>
<vlrTro>Double</vlrTro>
<dadosPagamentoCartao>
<tipInt>String</tipInt>
<cnpjCre>String</cnpjCre>
<banOpe>String</banOpe>
<catTef>String</catTef>
</dadosPagamentoCartao>
</formaPagamento>
<itensVenda>
<iteFis>String</iteFis>
<proSer>String</proSer>
<indTel>String</indTel>
<desIsv>String</desIsv>
<uniVen>String</uniVen>
<qtdVen>Double</qtdVen>
<preVen>Double</preVen>
<perDsc>Double</perDsc>
<vlrDsc>Double</vlrDsc>
<vlrBru>Double</vlrBru>
<vlrLiq>Double</vlrLiq>
<totRet>Double</totRet>
</itensVenda>
<dadosAdicionaisDocumentos>
<tipDoc>String</tipDoc>
<obsNfv>String</obsNfv>
</dadosAdicionaisDocumentos>
</Cabecalho>
</parameters>
</ser:Emitir>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| cabecalho | Set | Opcional | (Obrigatório) - Lista com os dados das vendas a serem emitidas |
| cabecalho.cnpjFil | String | Opcional | (Obrigatório) - String(014) - CNPJ da filial que está emitindo a venda |
| cabecalho.identificadorCliente | String | Opcional | (Opcional) - String(040) - CNPJ, CPF ou documento estrangeiro do cliente. Observação: para CNPJ ou CPF, apenas os números devem ser informados, e para um documento estrangeiro, podem ser informados todos os caracteres. |
| cabecalho.identificadorTransportadora | String | Opcional | (Opcional) - String(014) - CNPJ ou CPF da transportadora responsável pela entrega |
| cabecalho.vlrliq | Double | Opcional | (Obrigatório) - Number(015,2) - Valor líquido total da venda |
| cabecalho.datSai | DateTime | Opcional | (Opcional) - DateTime(DD/MM/AAAA) - Data da saída da venda |
| cabecalho.horSai | Time | Opcional | (Opcional) - Time(hh:mm) - Hora da saída da venda |
| cabecalho.numInt | String | Opcional | (Obrigatório) - String(020) - Número do documento externo (integrado) |
| cabecalho.nroEnvio | Integer | Opcional | (Obrigatório) - Number(004) - Número de tentativas de envio da venda |
| cabecalho.indPre | String | Opcional | (Opcional) - String(001) - Indicativo de presença do consumidor (0 = Não se aplica; 1 = Operação presencial; 2 = Operação não presencial, pela Internet; 3 = Operação não presencial, Teleatendimento; 4 = NFC-e em operação com entrega a domicílio; 5 - Operação presencial, fora do estabelecimento; 9 = Operação não presencial, outros) |
| cabecalho.seqEnt | Integer | Opcional | (Opcional) - Number(005) - Sequência do endereço de entrega do cliente |
| cabecalho.tipImp | String | Opcional | (Obrigatório) - String(001) - Tipo de impressão do DANFE NFC-e (1 = Completo; 2 = Resumido) |
| cabecalho.duplicarDefinicaoCliente | String | Opcional | (Opcional) - String(001) - Duplicar automaticamente a definição do cliente existente na filial matriz para a filial atual (S = Sim; N = Não) |
| cabecalho.eMail | String | Opcional | (Opcional) - String(060) - Endereço eletrônico para onde será enviado o documento fiscal. |
| cabecalho.datPre | DateTime | Opcional | (Opcional) - DateTime(DD/MM/AAAA) - Data da prestação do serviço |
| cabecalho.chvRef | String | Opcional | (Opcional) - String(050) - Chave eletrônica do documento fiscal referenciado. Deve ser informado quando for indicativo presencial "5 - Operação presencial, fora do estabelecimento". |
| formaPagamento | Set | Opcional | (Obrigatório) - Lista com os dados das formas de pagamento da venda |
| formaPagamento.tipPag | String | Opcional | (Obrigatório) - String(002) - Forma de pagamento (01 = Dinheiro; 02 = Cheque; 03 = Cartão de Crédito; 04 = Cartão de Débito; 05 = Crédito Loja; 10 = Vale Alimentação; 11 = Vale Refeição; 12 = Vale Presente; 13 = Vale Combustível; 99 = Outros) |
| formaPagamento.vlrPar | Double | Opcional | (Obrigatório) - Number(015,2) - Valor da parcela de pagamento |
| formaPagamento.vlrTro | Double | Opcional | (Obrigatório) - Number(015,2) - Valor do troco |
| dadosPagamentoCartao | Set | Opcional | (Obrigatório) - Lista com os dados de pagamento em cartão |
| dadosPagamentoCartao.tipInt | String | Opcional | (Opcional) - String(001) - Tipo de Integração do processo de pagamento com o sistema de automação da empresa (1 = Pagamento integrado com o sistema de automação da empresa; 2 = Pagamento não integrado com o sistema de automação da empresa |
| dadosPagamentoCartao.cnpjCre | String | Opcional | (Opcional) - String(014) - CNPJ da Credenciadora de cartão de crédito/débito |
| dadosPagamentoCartao.banOpe | String | Opcional | (Opcional) - String(002) - Bandeira da operadora de cartão de crédito e/ou débito (01 = Visa; 02 = Mastercard; 03 = American Express; 04 = Sorocred; 99 = Outros) |
| dadosPagamentoCartao.catTef | String | Opcional | (Opcional) - String(100) - Número da autorização da transação da operação com cartão de crédito e/ou débito |
| itensVenda | Set | Opcional | (Obrigatório) - Lista com os dados dos itens da venda |
| itensVenda.iteFis | String | Opcional | (Obrigatório) - String(060) - Código fiscal do item da venda |
| itensVenda.proSer | String | Opcional | (Obrigatório) - String(001) - Definindo sé é produto ou serviço (“P – Produtos”, “S – Serviços”) |
| itensVenda.indTel | String | Opcional | (Opcional) - String(001) - Determina se o item é telemático (“S – Sim”, "N - Não", "Vazio - Não") |
| itensVenda.desIsv | String | Opcional | (Opcional) - String(250) - Descrição complementar para item de serviço telemático |
| itensVenda.uniVen | String | Opcional | (Opcional) - String(003) - Unidade de medida de venda |
| itensVenda.qtdVen | Double | Opcional | (Obrigatório) - Number(014,5) - Quantidade de venda |
| itensVenda.preVen | Double | Opcional | (Obrigatório) - Number(014,5) - Preço de venda |
| itensVenda.perDsc | Double | Opcional | (Opcional) - Number(005,2) - Percentual de desconto |
| itensVenda.vlrDsc | Double | Opcional | (Opcional) - Number(015,2) - Valor do desconto |
| itensVenda.vlrBru | Double | Opcional | (Obrigatório) - Number(015,2) - Valor bruto do item |
| itensVenda.vlrLiq | Double | Opcional | (Obrigatório) - Number(015,2) - Valor líquido do item |
| itensVenda.totRet | Double | Opcional | (Opcional) - Number(015,2) - Valor total da retenção descontada no pagamento |
| dadosAdicionaisDocumentos | Set | Opcional | (Obrigatório) - Lista de dados adicionais para os documentos identificados. Quando sabe que a informação pertence a um determina tipo de documento. Se a venda não contiver o tipo informado é apresentado erro. |
| dadosAdicionaisDocumentos.tipDoc | String | Opcional | (Obrigatório) - String(002) - Tipo de documento, permite os valores (55 = Nf-e; 65 = NFC-e; 21 = Telemático; 99 = Outros documentos) |
| dadosAdicionaisDocumentos.obsNfv | String | Opcional | (Opcional) - String(999) - Observação para o tipo de documento informado. |
Observação
- Caso os parâmetros do grupo formaPagamento não estejam informados, o sistema gera as parcelas e a forma de pagamento de acordo com as informações da tela Parâmetros de Integração (F191CPT), e do modelo de documento que está sendo emitido.
- Ao escolher as opções 03 = Cartão de Crédito e 04 = Cartão de Débito no parâmetro tipPag, tipo de pagamento, se não for informado o tipo de integração (tipInt) com a operadora de cartões, o sistema exibe uma mensagem de erro, abortando o processo.
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:EmitirResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<Retornos>
<cnpjFil>String</cnpjFil>
<numInt>String</numInt>
<eMail>String</eMail>
<retorno21>
<tipoRetorno>String</tipoRetorno>
<cnpjFil>String</cnpjFil>
<codEmp>String</codEmp>
<codFil>String</codFil>
<codSnf>String</codSnf>
<numNfv>String</numNfv>
<codEdc>String</codEdc>
<codSel>String</codSel>
<datEmi>DateTime</datEmi>
<horEmi>String</horEmi>
<itens21>
<itemFiscal>String</itemFiscal>
<seqItem>Integer</seqItem>
<preVen>Double</preVen>
<desIsv>String</desIsv>
</itens21>
<erros21>
<mensagem>String</mensagem>
</erros21>
</retorno21>
<retornoOutrosDocumentos>
<tipoRetorno>String</tipoRetorno>
<cnpjFil>String</cnpjFil>
<codEmp>String</codEmp>
<codFil>String</codFil>
<codSnf>String</codSnf>
<numNfv>String</numNfv>
<codEdc>String</codEdc>
<codSel>String</codSel>
<datEmi>DateTime</datEmi>
<horEmi>String</horEmi>
<itensOutrosDocumentos>
<itemFiscal>String</itemFiscal>
<seqItem>Integer</seqItem>
<preVen>Double</preVen>
</itensOutrosDocumentos>
<errosOutrosDocumentos>
<mensagem>String</mensagem>
</errosOutrosDocumentos>
</retornoOutrosDocumentos>
<retorno55>
<tipoRetorno>String</tipoRetorno>
<aguardandoSEFAZ>String</aguardandoSEFAZ>
<cnpjFil>String</cnpjFil>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<codEdc>String</codEdc>
<codSel>String</codSel>
<datEmi>DateTime</datEmi>
<horEmi>String</horEmi>
<sitDoe>Integer</sitDoe>
<chvDoe>String</chvDoe>
<codigoRejeicao>String</codigoRejeicao>
<xMLRetorno>String</xMLRetorno>
<urlDanfe>String</urlDanfe>
<itens55>
<itemFiscal>String</itemFiscal>
<seqItem>Integer</seqItem>
<preVen>Double</preVen>
</itens55>
<erros55>
<mensagem>String</mensagem>
</erros55>
</retorno55>
<retorno65>
<tipoRetorno>String</tipoRetorno>
<cnpjFil>String</cnpjFil>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<codEdc>String</codEdc>
<codSel>String</codSel>
<datEmi>DateTime</datEmi>
<horEmi>String</horEmi>
<sitDoe>Integer</sitDoe>
<chvDoe>String</chvDoe>
<codigoRejeicao>String</codigoRejeicao>
<xMLRetorno>String</xMLRetorno>
<docImp>String</docImp>
<itens65>
<itemFiscal>String</itemFiscal>
<seqItem>Integer</seqItem>
<preVen>Double</preVen>
</itens65>
<erros65>
<mensagem>String</mensagem>
</erros65>
</retorno65>
<retornoComum>
<tipoRetorno>String</tipoRetorno>
<errosComum>
<mensagem>String</mensagem>
</errosComum>
</retornoComum>
</Retornos>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:EmitirResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| tipoRetorno | Integer | Opcional | (Obrigatório) - Number(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
| retornos | Set | Opcional | (Obrigatório) - Lista com os dados de retornos das vendas |
| retornos.cnpjFil | String | Opcional | (Obrigatório) - String(014) - CNPJ da filial |
| retornos.numInt | String | Opcional | (Obrigatório) - String(020) - Número do documento externo (integrado) |
| retornos.eMail | String | Opcional | (Opcional) - String(060) - Endereço de e-mail para qual foi enviado o e-mail |
| retorno21 | Set | Opcional | (Obrigatório) - Lista com os dados de retornos dos documentos fiscais gerados no modelo 21 (Nota Fiscal de Comunicação) |
| retorno21.tipoRetorno | String | Opcional | (Obrigatório) - String(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
| retorno21.cnpjFil | String | Opcional | (Obrigatório) - String(014) - CNPJ da filial |
| retorno21.codEmp | String | Opcional | (Obrigatório) - String(004) - Código da empresa do documento fiscal |
| retorno21.codFil | String | Opcional | (Obrigatório) - String(004) - Código da filial do documento fiscal |
| retorno21.codSnf | String | Opcional | (Obrigatório) - String(003) - Código da série fiscal do documento fiscal |
| retorno21.numNfv | String | Opcional | (Obrigatório) - String(009) - Número do documento fiscal |
| retorno21.codEdc | String | Opcional | (Obrigatório) - String(003) - Espécie de documento para fins fiscais |
| retorno21.codSel | String | Opcional | (Obrigatório) - String(003) - Código da Série Legal |
| retorno21.datEmi | DateTime | Opcional | (Obrigatório) - DateTime(DD/MM/AAAA) - Data de emissão do documento fiscal |
| retorno21.horEmi | String | Opcional | (Obrigatório) - Time(HH:MM) - Hora de emissão do documento fiscal |
| itens21 | Set | Opcional | (Obrigatório) - Lista com os dados dos itens da venda vinculados ao documento fiscal gerado no modelo 21 (Nota Fiscal de Comunicação) |
| itens21.itemFiscal | String | Opcional | (Obrigatório) - String(060) - Código fiscal do item da venda |
| itens21.seqItem | Integer | Opcional | (Obrigatório) - Number(004) - Sequência do item da venda |
| itens21.preVen | Double | Opcional | (Obrigatório) - Number(014,5) - Preço de venda |
| itens21.desIsv | String | Opcional | (Opcional) - String(250) - Descrição complementar para item de serviço telemático |
| erros21 | Set | Opcional | (Obrigatório) - Lista com as mensagens de erros ocorridas no processamento do documento fiscal gerado no modelo 21 (Nota Fiscal de Comunicação) |
| erros21.mensagem | String | Opcional | (Obrigatório) - String(1000) - Mensagem de erro |
| retornoOutrosDocumentos | Set | Opcional | (Obrigatório) - Lista com os dados de retornos dos documentos fiscais gerados "Outros Documentos" |
| retornoOutrosDocumentos.tipoRetorno | String | Opcional | (Obrigatório) - String(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
| retornoOutrosDocumentos.cnpjFil | String | Opcional | (Obrigatório) - String(014) - CNPJ da filial |
| retornoOutrosDocumentos.codEmp | String | Opcional | (Obrigatório) - String(004) - Código da empresa do documento fiscal |
| retornoOutrosDocumentos.codFil | String | Opcional | (Obrigatório) - String(004) - Código da filial do documento fiscal |
| retornoOutrosDocumentos.codSnf | String | Opcional | (Obrigatório) - String(003) - Código da série fiscal do documento fiscal |
| retornoOutrosDocumentos.numNfv | String | Opcional | (Obrigatório) - String(009) - Número do documento fiscal |
| retornoOutrosDocumentos.codEdc | String | Opcional | (Obrigatório) - String(003) - Espécie de documento para fins fiscais |
| retornoOutrosDocumentos.codSel | String | Opcional | (Obrigatório) - String(003) - Código da Série Legal |
| retornoOutrosDocumentos.datEmi | DateTime | Opcional | (Obrigatório) - DateTime(DD/MM/AAAA) - Data de emissão do documento fiscal |
| retornoOutrosDocumentos.horEmi | String | Opcional | (Obrigatório) - Time(HH:MM) - Hora de emissão do documento fiscal |
| itensOutrosDocumentos | Set | Opcional | (Obrigatório) - Lista com os dados dos itens da venda vinculados ao documento fiscal gerado no modelo 21 (Nota Fiscal de Comunicação) |
| itensOutrosDocumentos.itemFiscal | String | Opcional | (Obrigatório) - String(060) - Código fiscal do item da venda |
| itensOutrosDocumentos.seqItem | Integer | Opcional | (Obrigatório) - Number(004) - Sequência do item da venda |
| itensOutrosDocumentos.preVen | Double | Opcional | (Obrigatório) - Number(014,5) - Preço de venda |
| errosOutrosDocumentos | Set | Opcional | (Obrigatório) - Lista com as mensagens de erros ocorridas no processamento do documento fiscal gerado no modelo 21 (Nota Fiscal de Comunicação) |
| errosOutrosDocumentos.mensagem | String | Opcional | (Obrigatório) - String(1000) - Mensagem de erro |
| retorno55 | Set | Opcional | (Obrigatório) - Lista com os dados de retornos dos documentos fiscais gerados no modelo 55 (Nota Fiscal Eletrônica) |
| retorno55.tipoRetorno | String | Opcional | (Obrigatório) - String(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
| retorno55.aguardandoSEFAZ | String | Opcional | (Obrigatório) - String(001) - Indicativo se o documento fiscal foi enviado a SEFAZ e não obteve retorno imediato (requisições assíncronas) (0 = Não aguardando; 1 = Aguardando) |
| retorno55.cnpjFil | String | Opcional | (Obrigatório) - String(014) - CNPJ da filial |
| retorno55.codEmp | Integer | Opcional | (Obrigatório) - String(004) - Código da empresa do documento fiscal |
| retorno55.codFil | Integer | Opcional | (Obrigatório) - String(004) - Código da filial do documento fiscal |
| retorno55.codSnf | String | Opcional | (Obrigatório) - String(003) - Código da série fiscal do documento fiscal |
| retorno55.numNfv | Integer | Opcional | (Obrigatório) - String(009) - Número do documento fiscal |
| retorno55.codEdc | String | Opcional | (Obrigatório) - String(003) - Espécie de documento para fins fiscais |
| retorno55.codSel | String | Opcional | (Obrigatório) - String(003) - Código da Série Legal |
| retorno55.datEmi | DateTime | Opcional | (Obrigatório) - DateTime(DD/MM/AAAA) - Data de emissão do documento fiscal |
| retorno55.horEmi | String | Opcional | (Obrigatório) - Time(HH:MM) - Hora de emissão do documento fiscal |
| retorno55.sitDoe | Integer | Opcional | (Obrigatório) - String(001) - Situação do documento eletrônico (0 = Não se aplica 1 = Não Enviada; 2 = Enviada; 3 = Autorizada; 4 = Rejeitada; 5 = Denegada; 6 = Solicitado Inutilização; 7 = Solicitado Cancelamento; 8 = Inutilizada; 9 = Cancelada; 10 = Erro Geração; 11 = Erro Solicitação Cancelamento; 12 = Erro Solicitação Inutilização; 13 = Pendente de Cancelamento; 16 = Autorizado em Contingência (utilizado apenas para retorno WebService); 17= Evento registrado (evento pror. suspensão ICMS - utilizado apenas Web Service); 18 = Deferido parcial (evento pror. suspensão ICMS - utilizado apenas no Web Service); 19 = Indeferido (evento prorrogação suspensão ICMS - utilizado apenas no Web Service)) |
| retorno55.chvDoe | String | Opcional | (Obrigatório) - String(045) - Chave eletrônica do documento fiscal |
| retorno55.codigoRejeicao | String | Opcional | (Obrigatório) - String(003) - Código da rejeição retornada pela SEFAZ |
| retorno55.xMLRetorno | String | Opcional | (Obrigatório) - String(1000) - XML do documento fiscal autorizado |
| retorno55.urlDanfe | String | Opcional | (Obrigatório) - String(1000) - URL para consulta do DANFE |
| itens55 | Set | Opcional | (Obrigatório) - Lista com os dados dos itens da venda vinculados ao documento fiscal gerado no modelo 55 (Nota Fiscal Eletrônica) |
| itens55.itemFiscal | String | Opcional | (Obrigatório) - String(060) - Código fiscal do item da venda |
| itens55.seqItem | Integer | Opcional | (Obrigatório) - Number(004) - Sequência do item da venda |
| itens55.preVen | Double | Opcional | (Obrigatório) - Number(014,5) - Preço de venda |
| erros55 | Set | Opcional | (Obrigatório) - Lista com as mensagens de erros ocorridas no processamento do documento fiscal gerado no modelo 55 (Nota Fiscal Eletrônica) |
| erros55.mensagem | String | Opcional | (Obrigatório) - String(1000) - Mensagem de erro |
| retorno65 | Set | Opcional | (Obrigatório) - Lista com os dados de retornos dos documentos fiscais gerados no modelo 65 (Nota Fiscal de Consumidor Eletrônica) |
| retorno65.tipoRetorno | String | Opcional | (Obrigatório) - String(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
| retorno65.cnpjFil | String | Opcional | (Obrigatório) - String(014) - CNPJ da filial |
| retorno65.codEmp | Integer | Opcional | (Obrigatório) - String(004) - Código da empresa do documento fiscal |
| retorno65.codFil | Integer | Opcional | (Obrigatório) - String(004) - Código da filial do documento fiscal |
| retorno65.codSnf | String | Opcional | (Obrigatório) - String(003) - Código da série fiscal do documento fiscal |
| retorno65.numNfv | Integer | Opcional | (Obrigatório) - String(009) - Número do documento fiscal |
| retorno65.codEdc | String | Opcional | (Obrigatório) - String(003) - Espécie de documento para fins fiscais |
| retorno65.codSel | String | Opcional | (Obrigatório) - String(003) - Código da Série Legal |
| retorno65.datEmi | DateTime | Opcional | (Obrigatório) - DateTime(DD/MM/AAAA) - Data de emissão do documento fiscal |
| retorno65.horEmi | String | Opcional | (Obrigatório) - Time(HH:MM) - Hora de emissão do documento fiscal |
| retorno65.sitDoe | Integer | Opcional | (Obrigatório) - String(001) - Situação do documento eletrônico (0 = Não se aplica 1 = Não Enviada; 2 = Enviada; 3 = Autorizada; 4 = Rejeitada; 5 = Denegada; 6 = Solicitado Inutilização; 7 = Solicitado Cancelamento; 8 = Inutilizada; 9 = Cancelada; 10 = Erro Geração; 11 = Erro Solicitação Cancelamento; 12 = Erro Solicitação Inutilização; 13 = Pendente de Cancelamento; 16 = Autorizado em Contingência (utilizado apenas para retorno WebService); 17= Evento registrado (evento pror. suspensão ICMS - utilizado apenas Web Service); 18 = Deferido parcial (evento pror. suspensão ICMS - utilizado apenas no Web Service); 19 = Indeferido (evento prorrogação suspensão ICMS - utilizado apenas no Web Service)) |
| retorno65.chvDoe | String | Opcional | (Obrigatório) - String(045) - Chave eletrônica do documento fiscal |
| retorno65.codigoRejeicao | String | Opcional | (Obrigatório) - String(003) - Código da rejeição retornada pela SEFAZ |
| retorno65.xMLRetorno | String | Opcional | (Obrigatório) - String(1000) - XML do documento fiscal autorizado |
| retorno65.docImp | String | Opcional | (Obrigatório) - String(1000) - DANFE NFC-e para impressão em formato texto |
| itens65 | Set | Opcional | (Obrigatório) - Lista com os dados dos itens da venda vinculados ao documento fiscal gerado no modelo 65 (Nota Fiscal de Consumidor Eletrônica) |
| itens65.itemFiscal | String | Opcional | (Obrigatório) - String(060) - Código fiscal do item da venda |
| itens65.seqItem | Integer | Opcional | (Obrigatório) - Number(004) - Sequência do item da venda |
| itens65.preVen | Double | Opcional | (Obrigatório) - Number(014,5) - Preço de venda |
| erros65 | Set | Opcional | (Obrigatório) - Lista com as mensagens de erros ocorridas no processamento do documento fiscal gerado no modelo 65 (Nota Fiscal de Consumidor Eletrônica) |
| erros65.mensagem | String | Opcional | (Obrigatório) - String(1000) - Mensagem de erro |
| retornoComum | Set | Opcional | (Obrigatório) - Lista com os dados de retornos ocorridos na venda (independente de documento fiscal) |
| retornoComum.tipoRetorno | String | Opcional | (Obrigatório) - String(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
| errosComum | Set | Opcional | (Obrigatório) - Lista com as mensagens de erros ocorridas no processamento da venda (independente de documento fiscal) |
| errosComum.mensagem | String | Opcional | (Obrigatório) - String(1000) - Mensagem de erro |
| mensagemRetorno | String | Opcional | (Obrigatório) - String(255) - Mensagem de retorno da situação da execução do serviço |
| erroExecucao | String | Opcional | 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. |
EmitirCartaCorrecao
Serviço para envio de Carta de correção eletrônica.
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Versão atual: 1
Classe do sistema ERP que implementa a porta do web service: TSr140CartaCorrecaoEletronica.
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:EmitirCartaCorrecao>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<Cabecalho>
<chvDoe>String</chvDoe>
<cnpjFil>String</cnpjFil>
<codEmp>Integer</codEmp>
<codFIl>Integer</codFIl>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<datEve>DateTime</datEve>
<horEve>Time</horEve>
<desCor>String</desCor>
<tipGer>Integer</tipGer>
</Cabecalho>
</parameters>
</ser:EmitirCartaCorrecao>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| cabecalho | Set | Opcional | (Obrigatório) - Lista com os dados das cartas de corrreção eletronica. |
| cabecalho.chvDoe | String | Opcional | (Opcional) - String(060) - Chave do documento eletrônico(obrigatório caso não informar CNPJ e/ou não identificar pela chave a nota). |
| cabecalho.cnpjFil | String | Opcional | (Opcional) - String(015) - CNPJ da filial da empresa(orbigatório caso não identificar a pela chave a filial). Quando informado o CNPJ, o sistema considera somente as filiais que não são consolidadoras de movimentos de impostos. |
| cabecalho.codEmp | Integer | Opcional | (Opcional) - Number(004) - Código da empresa(obrigatório caso não informar o CNPJ ou chave do documento eletrônico). |
| cabecalho.codFIl | Integer | Opcional | (Opcional) - Number(005) - Código da filial(obrigatório caso não informar o CNPJ ou chave do documento eletrônico). |
| cabecalho.codSnf | String | Opcional | (Opcional) - String(003) - Código da série da nota fiscal(obrigatório caso nao informar a chave do documento eletrônico). |
| cabecalho.numNfv | Integer | Opcional | (Opcional) - Number(009) - Número da nota fiscal de saída(obrigatório caso nao informar a chave do documento eletrônico). |
| cabecalho.datEve | DateTime | Opcional | (Obrigatório) - DateTime(DD/MM/AAAA) - Data do evento. |
| cabecalho.horEve | String | Opcional | (Obrigatório) - Time(hh:mm) - Hora do evento. |
| cabecalho.desCor | String | Opcional | (Obrigatório) - String(999) - Descrição da correção a ser considerada. |
| cabecalho.tipGer | Integer | Opcional | (Obrigatório) - String(001) - Tipo da geração da CC-e(1 = Gerar XML, 2 = Comunicação WS eDocs, 3 = Nada a fazer). |
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:EmitirCartaCorrecaoResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<Retornos>
<tipRet>Integer</tipRet>
<cnpjFil>String</cnpjFil>
<codEmp>Integer</codEmp>
<codFIl>Integer</codFIl>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<codEdc>String</codEdc>
<codSel>String</codSel>
<sitDoe>Integer</sitDoe>
<chvDoe>String</chvDoe>
<datEve>DateTime</datEve>
<horEve>Time</horEve>
<desCor>String</desCor>
<tipGer>Integer</tipGer>
<numPrt>String</numPrt>
<datAut>DateTime</datAut>
<horAut>Integer</horAut>
<codRej>String</codRej>
<msgRet>String</msgRet>
</Retornos>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:EmitirCartaCorrecaoResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| tipoRetorno | Integer | Opcional | (Obrigatório) - Number(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
| retornos | Set | Opcional | (Obrigatório) - Lista de retorno das requisições. |
| retornos.tipRet | Integer | Opcional | (Obrigatório) - Number(001) - Retorno da requisição(0 = Sucesso, -1 = Houve erros) |
| retornos.cnpjFil | String | Opcional | (Opcional) - String(015) - CNPJ da filial da empresa(orbigatório caso não identificar a pela chave a filial). |
| retornos.codEmp | Integer | Opcional | (Opcional) - Number(004) - Código da empresa(obrigatório caso não informar o CNPJ ou chave do documento eletrônico). |
| retornos.codFIl | Integer | Opcional | (Opcional) - Number(005) - Código da filial(obrigatório caso não informar o CNPJ ou chave do documento eletrônico). |
| retornos.codSnf | String | Opcional | (Opcional) - String(003) - Código da série da nota fiscal(obrigatório caso nao informar a chave do documento eletrônico). |
| retornos.numNfv | Integer | Opcional | (Opcional) - Number(009) - Número da nota fiscal de saída(obrigatório caso nao informar a chave do documento eletrônico). |
| retornos.codSel | String | Opcional | (Obrigatório) - String(003) - Código da Série Legal |
| retornos.sitDoe | Integer | Opcional | (Obrigatório) - String(001) - Situação do documento eletrônico (0 = Não se aplica 1 = Não Enviada; 2 = Enviada; 3 = Autorizada; 4 = Rejeitada; 5 = Denegada; 6 = Solicitado Inutilização; 7 = Solicitado Cancelamento; 8 = Inutilizada; 9 = Cancelada; 10 = Erro Geração; 11 = Erro Solicitação Cancelamento; 12 = Erro Solicitação Inutilização; 13 = Pendente de Cancelamento; 16 = Autorizado em Contingência (utilizado apenas para retorno WebService); 17= Evento registrado (evento pror. suspensão ICMS - utilizado apenas Web Service); 18 = Deferido parcial (evento pror. suspensão ICMS - utilizado apenas no Web Service); 19 = Indeferido (evento prorrogação suspensão ICMS - utilizado apenas no Web Service)) |
| retornos.chvDoe | String | Opcional | (Opcional) - String(060) - Chave do documento eletrônico(obrigatório caso não informar CNPJ e/ou não identificar pela chave a nota). |
| retornos.datEve | DateTime | Opcional | (Obrigatório) - DateTime(DD/MM/AAAA) - Data do evento. |
| retornos.horEve | Time | Opcional | (Obrigatório) - Time(hh:mm) - Hora do evento. |
| retornos.desCor | String | Opcional | (Obrigatório) - String(999) - Descrição da correção a ser considerada. |
| retornos.tipGer | Integer | Opcional | (Obrigatório) - String(001) - Tipo da geração da CC-e(1 = Gerar XML, 2 = Comunicação WS eDocs, 3 = Nada a fazer). |
| retornos.numPrt | String | Opcional | String(015) - Número do protocolo de autorização ou recebimento. |
| retornos.datAut | DateTime | Opcional | Date(DD/MM/YYYY) - Data do protocolo de autorização. |
| retornos.horAut | Integer | Opcional | Number(005) - Hora do protocolo de autorização. |
| retornos.codRej | String | Opcional | (Obrigatório) - String(003) - Código de rejeição da Sefaz. |
| retornos.msgRet | String | Opcional | (Obrigatório) - String(999) - Mensagem de retorno da requisição. |
| mensagemRetorno | String | Opcional | (Obrigatório) - String(255) - Mensagem de retorno da situação da execução do serviço |
| erroExecucao | String | Opcional | 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. |
EmitirReferenciado
Serviço que permite a geração de um documento fiscal de modelo 55 (NF-e) com base em um documento fiscal de modelo 65 (NFC-e).
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Versão atual: 1
Classe do sistema ERP que implementa a porta do web service: TSr140EmissaoDocumentoFiscalReferenciado.
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:EmitirReferenciado>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<Cabecalho>
<identificadorCliente>String</identificadorCliente>
<chvDoe>String</chvDoe>
<indPdf>String</indPdf>
</Cabecalho>
</parameters>
</ser:EmitirReferenciado>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| cabecalho | Set | Opcional | (Obrigatório) - Set - Lista das notas fiscais referenciadas |
| cabecalho.identificadorCliente | String | Opcional | (Obrigatório) - String - Identificação do cliente (CNPJ, CPF ou documento de identificação de consumidor estrangeiro) |
| cabecalho.chvDoe | String | Opcional | (Obrigatório) - String - Chave do documento eletrônico |
| cabecalho.indPdf | String | Opcional | (Opcional) - String(001) - Indica se vai incluir o PDF em formato BASE64 no retorno |
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:EmitirReferenciadoResponse>
<result>
<Erros>
<mensagemErro>String</mensagemErro>
</Erros>
<tipoRetorno>Integer</tipoRetorno>
<RetornosDocumentoFiscal55>
<aguardandoSEFAZ>String</aguardandoSEFAZ>
<cnpjFil>String</cnpjFil>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<codEdc>String</codEdc>
<codSel>String</codSel>
<sitDoe>Integer</sitDoe>
<chvDoe>String</chvDoe>
<mensagemRetorno>String</mensagemRetorno>
<codigoRejeicao>String</codigoRejeicao>
<xMLRetorno>String</xMLRetorno>
<urlDanfe>String</urlDanfe>
<pdfB64>String</pdfB64>
<itens55>
<itemFiscal>String</itemFiscal>
<seqItem>Integer</seqItem>
</itens55>
</RetornosDocumentoFiscal55>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:EmitirReferenciadoResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| erros | Set | Opcional | (Opcional) - Set - Lista dos erros |
| erros.mensagemErro | String | Opcional | (Opcional) - Itens da lista de erros |
| tipoRetorno | Integer | Opcional | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
| retornosDocumentoFiscal55 | Set | Opcional | (Obrigatório) - Set - Lista de documentos fiscais de modelo 55 (NF-e) |
| retornosDocumentoFiscal55.aguardandoSEFAZ | String | Opcional | (Obrigatório) - String(001) - Indicativo se o documento fiscal foi enviado a SEFAZ e não obteve retorno imediato (requisições assíncronas) (0 = Não aguardando; 1 = Aguardando) |
| retornosDocumentoFiscal55.cnpjFil | String | Opcional | (Obrigatório) - String(014) - CNPJ da filial |
| retornosDocumentoFiscal55.codEmp | Integer | Opcional | (Obrigatório) - String(004) - Código da empresa do documento fiscal |
| retornosDocumentoFiscal55.codFil | Integer | Opcional | (Obrigatório) - String(004) - Código da filial do documento fiscal |
| retornosDocumentoFiscal55.codSnf | String | Opcional | (Obrigatório) - String(003) - Código da série fiscal do documento fiscal |
| retornosDocumentoFiscal55.numNfv | Integer | Opcional | (Obrigatório) - String(009) - Número do documento fiscal |
| retornosDocumentoFiscal55.codEdc | String | Opcional | (Obrigatório) - String(003) - Espécie de documento para fins fiscais |
| retornosDocumentoFiscal55.codSel | String | Opcional | (Obrigatório) - String(003) - Código da Série Legal |
| retornosDocumentoFiscal55.sitDoe | Integer | Opcional | (Obrigatório) - String(001) - Situação do documento eletrônico (0 = Não se aplica 1 = Não Enviada; 2 = Enviada; 3 = Autorizada; 4 = Rejeitada; 5 = Denegada; 6 = Solicitado Inutilização; 7 = Solicitado Cancelamento; 8 = Inutilizada; 9 = Cancelada; 10 = Erro Geração; 11 = Erro Solicitação Cancelamento; 12 = Erro Solicitação Inutilização; 13 = Pendente de Cancelamento; 16 = Autorizado em Contingência (utilizado apenas para retorno WebService); 17= Evento registrado (evento pror. suspensão ICMS - utilizado apenas Web Service); 18 = Deferido parcial (evento pror. suspensão ICMS - utilizado apenas no Web Service); 19 = Indeferido (evento prorrogação suspensão ICMS - utilizado apenas no Web Service)) |
| retornosDocumentoFiscal55.chvDoe | String | Opcional | (Obrigatório) - String(050) - Chave do documento eletrônico |
| retornosDocumentoFiscal55.mensagemRetorno | String | Opcional | (Obrigatório) - String(255) - Mensagem de retorno da situação da execução do serviço |
| retornosDocumentoFiscal55.codigoRejeicao | String | Opcional | (Opcional) - String(003) - Código da rejeição retornada pela SEFAZ |
| retornosDocumentoFiscal55.xMLRetorno | String | Opcional | (Obrigatório) - String(1000) - XML do documento fiscal autorizado |
| retornosDocumentoFiscal55.urlDanfe | String | Opcional | (Obrigatório) - String(1000) - URL para consulta do DANFE |
| itens | Set | Opcional | (Obrigatório) - Lista com os dados dos itens da venda vinculados ao documento fiscal gerado no modelo 55 (Nota Fiscal Eletrônica) |
| itens.itemFiscal | String | Opcional | (Obrigatório) - String(060) - Código fiscal do item da venda |
| itens.seqItem | Integer | Opcional | (Obrigatório) - Number(004) - Sequência do item da venda |
| mensagemRetorno | String | Opcional | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| erroExecucao | String | Opcional | 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. |
Imprimir
Serviço para impressão de documentos fiscais de saída. Após executar o web service, será retornado o caminho do arquivo que foi gerado para cada documento informado.
Importante
Para notas fiscais do modelo 55 (NF-e) não há a possibilidade de impressão de um arquivo em diretório. Neste caso, o sistema faz a comunicação com o eDocs através da parametrização da tela F191CPT para o grupo Documentos Fiscais de Saída, subgrupo Modelo 55, campo URL para consulta do DANFE e, após a execução do web service, retorna no campo urlDanfe a URL de acesso ao eDocs. Ao colar essa URL no navegador, será feito o download do .PDF, desde que o eDocs esteja parametrizado para utilizar o web service de download. Saiba mais em Configurações Gerais do eDocs.
Se o objetivo é imprimir uma NF com base em informações do ERP através de um relatório para o modelo de NF 55 (NF-e), recomendamos utilizar o web service próprio para impressão de relatórios: com.senior.g5.co.ger.relatorio, porta Executar.
Necessita autenticação: sim.
Situação de versão: atual.
Versão: 1.
Versão atual: 1.
Classe do sistema ERP que implementa a porta do web service: TSr140ImpressaoDocumentosFiscais.
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Imprimir>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<Cabecalho>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<caminhoGeracao>String</caminhoGeracao>
<cnpjFil>String</cnpjFil>
<numInt>String</numInt>
<chvDoe>String</chvDoe>
<tipImp>String</tipImp>
<impEnv>String</impEnv>
<endEnv>String</endEnv>
<indPdf>String</indPdf>
</Cabecalho>
</parameters>
</ser:Imprimir>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| cabecalho | Set | Opcional | (Obrigatório) - Lista com os dados dos documentos fiscais que serão impressos |
| cabecalho.codEmp | Integer | Opcional | (Opcional) - Number(004) - Código da empresa |
| cabecalho.codFil | Integer | Opcional | (Opcional) - Number(005) - Código da filial |
| cabecalho.codSnf | String | Opcional | (Opcional) - String(3) - Série da nota fiscal |
| cabecalho.numNfv | Integer | Opcional | (Opcional) - Number(009) - Número da nota fiscal |
| cabecalho.caminhoGeracao | String | Opcional | (Opcional) - String(1000) - Caminho para geração do arquivo |
| cabecalho.cnpjFil | String | Opcional | (Opcional) - String(014) - CNPJ da filial. Quando informado o CNPJ, o sistema considera somente as filiais que não são consolidadoras de movimentos de impostos |
| cabecalho.numInt | String | Opcional | (Opcional) - String(100) - Número do documento externo (integrado) |
| cabecalho.chvDoe | String | Opcional | (Opcional) - String(045) - Chave eletrônica do documento fiscal |
| cabecalho.tipImp | String | Opcional | (Opcional) - String(001) - (Obrigatório) - String(001) - Tipo de impressão do DANFE NFC-e (1 = Completo; 2 = Resumido) |
| cabecalho.impEnv | String | Opcional | (Obrigatório) - String(001) - Indica tipo de processamento do documento (I = Impressão; E = Envio de e-mail) |
| cabecalho.endEnv | String | Opcional | (Opcional) - String(100) - Endereço de e-mail para envio do documento |
| cabecalho.indPdf | String | Opcional | (Opcional) - String(001) - Indica se vai incluir o PDF em formato BASE64 no retorno |
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:ImprimirResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<Retornos>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codSnf>String</codSnf>
<numNfv>Integer</numNfv>
<cnpjFil>String</cnpjFil>
<numInt>String</numInt>
<chvDoe>String</chvDoe>
<retorno21>
<tipoRetorno>String</tipoRetorno>
<cnpjFil>Double</cnpjFil>
<codEmp>String</codEmp>
<codFil>String</codFil>
<codSnf>String</codSnf>
<numNfv>String</numNfv>
<codEdc>String</codEdc>
<codSel>String</codSel>
<urlPdf>String</urlPdf>
<numInt>String</numInt>
<pdfB64>String</pdfB64>
<itens21>
<itemFiscal>String</itemFiscal>
</itens21>
<erros21>
<mensagem>String</mensagem>
</erros21>
</retorno21>
<retorno55>
<tipoRetorno>String</tipoRetorno>
<cnpjFil>Double</cnpjFil>
<codEmp>String</codEmp>
<codFil>String</codFil>
<codSnf>String</codSnf>
<numNfv>String</numNfv>
<codEdc>String</codEdc>
<codSel>String</codSel>
<sitDoe>Integer</sitDoe>
<chvDoe>String</chvDoe>
<numInt>String</numInt>
<urlDanfe>String</urlDanfe>
<itens55>
<itemFiscal>String</itemFiscal>
</itens55>
<erros55>
<mensagem>String</mensagem>
</erros55>
</retorno55>
<retorno65>
<tipoRetorno>String</tipoRetorno>
<cnpjFil>Double</cnpjFil>
<codEmp>String</codEmp>
<codFil>String</codFil>
<codSnf>String</codSnf>
<numNfv>String</numNfv>
<codEdc>String</codEdc>
<codSel>String</codSel>
<sitDoe>Integer</sitDoe>
<chvDoe>String</chvDoe>
<numInt>String</numInt>
<docImp>String</docImp>
<itens65>
<itemFiscal>String</itemFiscal>
</itens65>
<erros65>
<mensagem>String</mensagem>
</erros65>
</retorno65>
<retornoGerais>
<tipoRetorno>String</tipoRetorno>
<cnpjFil>Double</cnpjFil>
<codEmp>String</codEmp>
<codFil>String</codFil>
<codSnf>String</codSnf>
<numNfv>String</numNfv>
<codEdc>String</codEdc>
<codSel>String</codSel>
<urlPdf>String</urlPdf>
<numInt>String</numInt>
<pdfB64>String</pdfB64>
<itensGerais>
<itemFiscal>String</itemFiscal>
</itensGerais>
<errosGerais>
<mensagem>String</mensagem>
</errosGerais>
</retornoGerais>
<retornoComum>
<tipoRetorno>String</tipoRetorno>
<errosComum>
<mensagem>String</mensagem>
</errosComum>
</retornoComum>
</Retornos>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ImprimirResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| tipoRetorno | Integer | Opcional | (Obrigatório) - Número(001) - Tipo de retorno de processamento (0 = Processado com sucesso, -1 = Processado com falhas) |
| retornos | Set | Opcional | (Obrigatório) - Lista com os dados de retorno da impressão dos documentos fiscais |
| retornos.codEmp | Integer | Opcional | (Obrigatório) - Number(004) - Código da empresa |
| retornos.codFil | Integer | Opcional | (Obrigatório) - Number(005) - Código da filial |
| retornos.codSnf | String | Opcional | (Obrigatório) - String(3) - Série da nota fiscal |
| retornos.numNfv | Integer | Opcional | (Obrigatório) - Number(009) - Número da nota fiscal |
| retornos.cnpjFil | String | Opcional | (Obrigatório) - String(014) - CNPJ da filial |
| retornos.numInt | String | Opcional | (Obrigatório) - String(100) - Número do documento externo (integrado) |
| retornos.chvDoe | String | Opcional | (Obrigatório) - String(045) - Chave eletrônica do documento fiscal |
| retorno21 | Set | Opcional | (Obrigatório) - Lista com os dados de retorno da impressão dos documentos fiscais no modelo 21 (Nota Fiscal de Comunicação) |
| retorno21.tipoRetorno | String | Opcional | (Obrigatório) - String(001) - Tipo de retorno de processamento (0 = Processado com sucesso, -1 = Processado com falhas) |
| retorno21.cnpjFil | Double | Opcional | (Obrigatório) - Number(014) - CNPJ da filial |
| retorno21.codEmp | String | Opcional | (Obrigatório) - Number(004) - Código da empresa |
| retorno21.codFil | String | Opcional | (Obrigatório) - Number(005) - Código da filial |
| retorno21.codSnf | String | Opcional | (Obrigatório) - String(003) - Código da série fiscal |
| retorno21.numNfv | String | Opcional | (Obrigatório) - Number(009) - Número da nota fiscal |
| retorno21.codEdc | String | Opcional | (Obrigatório) - String(003) - Espécie do documento fiscal (modelo) |
| retorno21.codSel | String | Opcional | (Obrigatório) - String(003) - Código da série legal |
| retorno21.urlPdf | String | Opcional | (Obrigatório) - String(1000) - Caminho do PDF impresso |
| retorno21.numInt | String | Opcional | (Obrigatório) - String(100) - Número do documento externo (integrado) |
| retorno21.pdfB64 | String | Opcional | (Opcional) - String - PDF em formato BASE64 |
| itens21 | Set | Opcional | (Obrigatório) - Lista com os itens do documento fiscal no modelo 21 |
| itens21.itemFiscal | String | Opcional | (Obrigatório) - String(060) - Código fiscal do item |
| erros21 | Set | Opcional | (Obrigatório) - Lista com os erros ocorridos na impressão do documento fiscal no modelo 21 |
| erros21.mensagem | String | Opcional | (Obrigatório) - String(1000) - Mensagem de erro |
| retorno55 | Set | Opcional | (Obrigatório) - Lista com os dados de retorno da impressão dos documentos fiscais no modelo 55 (Nota Fiscal Eletrônica) |
| retorno55.tipoRetorno | String | Opcional | (Obrigatório) - String(001) - Tipo de retorno de processamento (0 = Processado com sucesso, -1 = Processado com falhas) |
| retorno55.cnpjFil | Double | Opcional | (Obrigatório) - Number(014) - CNPJ da filial |
| retorno55.codEmp | String | Opcional | (Obrigatório) - Number(004) - Código da empresa |
| retorno55.codFil | String | Opcional | (Obrigatório) - Number(005) - Código da filial |
| retorno55.codSnf | String | Opcional | (Obrigatório) - String(003) - Código da série fiscal |
| retorno55.numNfv | String | Opcional | (Obrigatório) - Number(009) - Número da nota fiscal |
| retorno55.codEdc | String | Opcional | (Obrigatório) - String(003) - Espécie do documento fiscal (modelo) |
| retorno55.codSel | String | Opcional | (Obrigatório) - String(003) - Código da série legal |
| retorno55.sitDoe | Integer | Opcional | (Obrigatório) - String(001) - Situação do documento eletrônico (0 = Não se aplica 1 = Não Enviada; 2 = Enviada; 3 = Autorizada; 4 = Rejeitada; 5 = Denegada; 6 = Solicitado Inutilização; 7 = Solicitado Cancelamento; 8 = Inutilizada; 9 = Cancelada; 10 = Erro Geração; 11 = Erro Solicitação Cancelamento; 12 = Erro Solicitação Inutilização; 13 = Pendente de Cancelamento; 16 = Autorizado em Contingência (utilizado apenas para retorno WebService); 17= Evento registrado (evento pror. suspensão ICMS - utilizado apenas Web Service); 18 = Deferido parcial (evento pror. suspensão ICMS - utilizado apenas no Web Service); 19 = Indeferido (evento prorrogação suspensão ICMS - utilizado apenas no Web Service)) |
| retorno55.chvDoe | String | Opcional | (Obrigatório) - String(050) - Chave do documento eletrônico |
| retorno55.numInt | String | Opcional | (Obrigatório) - String(100) - Número do documento externo (integrado) |
| retorno55.urlDanfe | String | Opcional | (Obrigatório) - String(1000) - URL para consulta do DANFE |
| itens55 | Set | Opcional | (Obrigatório) - Lista com os itens do documento fiscal no modelo 55 |
| itens55.itemFiscal | String | Opcional | (Obrigatório) - String(060) - Código fiscal do item |
| erros55 | Set | Opcional | (Obrigatório) - Lista com os erros ocorridos na impressão do documento fiscal no modelo 55 |
| erros55.mensagem | String | Opcional | (Obrigatório) - String(1000) - Mensagem de erro |
| retorno65 | Set | Opcional | (Obrigatório) - Lista com os dados de retorno da impressão dos documentos fiscais no modelo 65 (Nota Fiscal de Consumidor Eletrônica) |
| retorno65.tipoRetorno | String | Opcional | (Obrigatório) - String(001) - Tipo de retorno de processamento (0 = Processado com sucesso, -1 = Processado com falhas) |
| retorno65.numInt | String | Opcional | (Obrigatório) - String(100) - Número do documento externo (integrado) |
| retorno65.codEmp | String | Opcional | (Obrigatório) - Number(004) - Código da empresa |
| retorno65.codFil | String | Opcional | (Obrigatório) - Number(005) - Código da filial |
| retorno65.codSnf | String | Opcional | (Obrigatório) - String(003) - Código da série fiscal |
| retorno65.numNfv | String | Opcional | (Obrigatório) - Number(009) - Número da nota fiscal |
| retorno65.codEdc | String | Opcional | (Obrigatório) - String(003) - Espécie do documento fiscal (modelo) |
| retorno65.codSel | String | Opcional | (Obrigatório) - String(003) - Código da série legal |
| retorno65.sitDoe | Integer | Opcional | (Obrigatório) - String(001) - Situação do documento eletrônico (0 = Não se aplica 1 = Não Enviada; 2 = Enviada; 3 = Autorizada; 4 = Rejeitada; 5 = Denegada; 6 = Solicitado Inutilização; 7 = Solicitado Cancelamento; 8 = Inutilizada; 9 = Cancelada; 10 = Erro Geração; 11 = Erro Solicitação Cancelamento; 12 = Erro Solicitação Inutilização; 13 = Pendente de Cancelamento; 16 = Autorizado em Contingência (utilizado apenas para retorno WebService); 17= Evento registrado (evento pror. suspensão ICMS - utilizado apenas Web Service); 18 = Deferido parcial (evento pror. suspensão ICMS - utilizado apenas no Web Service); 19 = Indeferido (evento prorrogação suspensão ICMS - utilizado apenas no Web Service)) |
| retorno65.chvDoe | String | Opcional | (Obrigatório) - String(050) - Chave do documento eletrônico |
| retorno65.cnpjFil | Double | Opcional | (Obrigatório) - Number(014) - CNPJ da filial |
| retorno65.docImp | String | Opcional | (Obrigatório) - String(1000) - Documento para impressão |
| itens65 | Set | Opcional | (Obrigatório) - Lista com os itens do documento fiscal no modelo 65 |
| itens65.itemFiscal | String | Opcional | (Obrigatório) - String(060) - Código fiscal do item |
| erros65 | Set | Opcional | (Obrigatório) - Lista com os erros ocorridos na impressão do documento fiscal no modelo 65 |
| erros65.mensagem | String | Opcional | (Obrigatório) - String(1000) - Mensagem de erro |
| retornoGerais | Set | Opcional | (Obrigatório) - Lista com os dados de retorno da impressão dos documentos fiscais (Modelos gerais) |
| retornoGerais.tipoRetorno | String | Opcional | (Obrigatório) - String(001) - Tipo de retorno de processamento (0 = Processado com sucesso, -1 = Processado com falhas) |
| retornoGerais.cnpjFil | Double | Opcional | (Obrigatório) - Number(014) - CNPJ da filial |
| retornoGerais.codEmp | String | Opcional | (Obrigatório) - Number(004) - Código da empresa |
| retornoGerais.codFil | String | Opcional | (Obrigatório) - Number(005) - Código da filial |
| retornoGerais.codSnf | String | Opcional | (Obrigatório) - String(003) - Código da série fiscal |
| retornoGerais.numNfv | String | Opcional | (Obrigatório) - Number(009) - Número da nota fiscal |
| retornoGerais.codEdc | String | Opcional | (Obrigatório) - String(003) - Espécie do documento (modelo) |
| retornoGerais.codSel | String | Opcional | (Obrigatório) - String(003) - Código da série |
| retornoGerais.urlPdf | String | Opcional | (Obrigatório) - String(1000) - Caminho do PDF impresso |
| retornoGerais.numInt | String | Opcional | (Obrigatório) - String(100) - Número do documento externo (integrado) |
| retornoGerais.pdfB64 | String | Opcional | (Opcional) - String - PDF em formato BASE64 |
| itensGerais | Set | Opcional | (Obrigatório) - Lista com os itens dos documentos fiscais |
| itensGerais.itemFiscal | String | Opcional | (Obrigatório) - String(060) - Código fiscal do item |
| errosGerais | Set | Opcional | (Obrigatório) - Lista com os erros ocorridos na impressão documentos fiscais |
| errosGerais.mensagem | String | Opcional | (Obrigatório) - String(1000) - Mensagem de erro |
| retornoComum | Set | Opcional | (Obrigatório) - Lista com os dados de retorno comuns a todos os modelos de documentos fiscais |
| retornoComum.tipoRetorno | String | Opcional | (Obrigatório) - String(001) - Tipo de retorno de processamento (0 = Processado com sucesso, -1 = Processado com falhas) |
| errosComum | Set | Opcional | (Obrigatório) - Lista com os erros comuns a todos os modelos de documentos fiscais |
| errosComum.mensagem | String | Opcional | (Obrigatório) - String(1000) - Mensagem de erro |
| mensagemRetorno | String | Opcional | (Obrigatório) - String(1000) - Mensagem de retorno de processamento |
| erroExecucao | String | Opcional | 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
English
Español


