Systax DF-e -Manual de Configuração - Webservice
Manual de configuração do Webservice Systax DF-e - versão 8.0 - 04.07.25
Introdução
Este documento destina-se à equipe de desenvolvimento responsável por integrar aplicações interna...
Webservice
Para acessar a coleção de chamadas Clique Aqui.Padrão de comunicação: O meio físico de comunicaçã...
AtualizaColunaERP
Descrição: Atualiza a coluna "ERP" no DFE com as definições de "Integrado" ou "Não Integrado". ...
Descrição dos campos de chamada
Campo Tipo Descrição Obrigatório usuario string Usuário...
Descrição dos campos de retorno
Campo Mensagem sucesso Código de status de requisição descric...
Tabela de código (campos "sucesso" e "descrição" do retorno)
Sucesso Descrição true Executado sem erros false Usuário...
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tem...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <AtualizaColunaE...
ConsultaStatus
Descrição: Retorna se o DF-e está cancelado. A consulta é feita na tabela de documentos fiscais e...
Descrição dos campos de chamada
Campo Tipo Descrição Obrigatório usuario string Usuário...
Descrição dos campos de retorno
Campo Descrição ConsultaStatusResult Mensagem de retorno
Tabela de status (campo "ConsultaStatusResult" do retorno)
Descrição OK Cancelada
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="ht...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> ...
ConsultaStatusGoverno
Descrição: Retorna o status do DF-e do portal da Sefaz. URL do WSDL: https://dfe.systax.com.br/W...
Descrição dos campos de chamada
Campo Tipo Descrição Obrigatório usuario stirng Usuári...
Descrição dos campos de retorno
Campo Descrição codigo Código de status de requisição mensage...
Tabela de código (campos "código" e "mensagem" do retorno)
Código Mensagem 0 Consulta de status realizada com sucesso 1 ...
Exemplos de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="ht...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultaStatusG...
ConsultaStatusManifesto
Descrição: Retorna o status da Manifestação do Documento Fiscal Eletrônico. URL do WSDL: https:/...
Detalhes dos campos de chamada
Campo Tipo Descrição Obrigatório usuario string Usuário...
Detalhes dos campos de retorno
Campo Descrição codigo Código de status de requisição mensage...
Tabela de código (campos "código" e "mensagem" do retorno)
codigo mensagem 0 Consulta de Status Manifestado realizada com sucesso...
Tabela de código (campos "mensagemRetorno " e "status" do retorno)
status mensagemRetorno -2 Manifestação realizada fora do DFe ...
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="ht...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> ...
DesacordoCTe
Descrição: Gera um desacordo de CT-e. URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc...
Descrição dos campos de chamada
Parâmetro Tipo Descrição Obrigatório usuario string Usu...
Descrição dos campos de retorno
Campo Descrição codigo Código de status de requisição mensage...
Tabela de código (campos "código" e "mensagem" do retorno)
Codigo Mensagem 1 Chamada incompleta Tipo de documento inváli...
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tem...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <DesacordoCTeRes...
Download
Descrição: Retorna um ou mais (lote) *.xml de acordo com a NSU ou chave informada. Nessa modalida...
Descrição dos campos de chamada
Campo Tipo Descrição Obrigatório Observação usuario str...
Descrição dos campos de retorno
Campo Descrição chaveDfe Chave do DF-e dfe XML do DF-e ...
Tabela de código (campos "código" e "mensagem" do retorno)
Código Mensagem 0 Consulta de status realizada com sucesso 1 ...
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="ht...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> ...
DownloadEventos
Descrição: Retorna se o DF-e está associado a algum evento e a natureza dele. URL do WSDL: https...
Descrição dos campos de chamada
Campos Tipo Descrição Obrigatório Observação usuario st...
Descrição dos campos de retorno
Campos Descrição chave Chave do DF-e xml XML do DF-e ...
Tabela de código (campos "código" e "mensagem" do retorno)
Código Mensagem 0 Consulta de status realizada com sucesso 1 ...
Tabela de eventos (campo "descrição" do retorno)
Código Descrição do evento 135 Evento registrado e vinculado ...
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="ht...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <DownloadEventos...
DownloadFiltrado
Descrição: Retorna um *.xml de acordo com a NSU ou chave informada, com opções de filtros de CT-e...
Descrição dos campos de chamada
Campo Tipo Descrição Obrigatório Observação usuario str...
Descrição dos campos de retorno
Campo Descrição chaveDfe Chave do DF-e dfe XML do DF-e ...
Tabela de código (campos "código" e "mensagem" do retorno)
Código Mensagem 0 Consulta de status realizada com sucesso 1 ...
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="ht...
Exemplos de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> ...
DownloadLote
Descrição: Retorna um ou mais (lote) *.xml de acordo com a NSU ou chave informada. Nessa modalida...
Descrição dos campos de chamada
Campo Tipo Descrição Obrigatório Observação usuario sti...
Descrição dos campos de retorno
Campo descrição chaveDfe Chave do DF-e dfe Compactado co...
Tabela de código (campos "código" e "mensagem" do retorno)
Código Mensagem 0 Consulta de status realizada com sucesso 1 ...
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="ht...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> ...
GerarDanfeDacte
GerarDanfeDacte: Retorna o DANFE, DACTE ou CT-eOS (representação simplificada) por PDF. URL do ...
Descrição dos campos de chamada
Campo Tipo Descrição Obrigatório usuario string Usuári...
Descrição dos campos de retorno
Campo Descrição Nome Nome do arquivo com a extensão *.pdf Arq...
Tabela de código (campos "código" e "mensagem" do retorno)
Codigo Mensagem 1 mensagemErro 2 Usuário e/ou senha invá...
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tem...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GerarDanfeDacte...
GerarDanfeDactePorXml
GerarDanfeDactePorXml: Retorna o DANFE, DACTE ou CT-eOS (representação simplificada) por XML. U...
Descrição dos campos de chamada
Campo Tipo Descrição Obrigatório usuario string Usuári...
Descrição dos campos de retorno
Campo Descrição Nome Nome do arquivo com a extensão *.pdf Arq...
Tabela de código (campos "código" e "mensagem" do retorno)
codigo mensagem 1 Chamada incompleta 2 Usuário e/ou senh...
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tem...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GerarDanfeDacte...
GetStatusDFe
Descrição: Retorna as inconsistências encontradas nas validações que o Systax DF-e realiza. URL...
Descrição dos campos de chamada
Campo Tipo Descrição Obrigatório usuario string Usuári...
Descrição dos campos de retorno
Campo Descrição chave Chave do DF-e dh_status_governo Da...
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tem...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body<GetStatusDFeResponse x...
Inclusão (Upload)
Inclusão: Fornece a chamada de inclusão de um DF-e no sistema. URL do WSDL: https://dfe.systax....
Descrição dos campos de chamada
Campo Tipo Descrição Obrigatório usuario string Usuári...
Descrição dos campos de retorno
Campo Descrição codigo Código de status de requisição mensage...
Tabela de código (campos "código" e "mensagem" do retorno)
Código Mensagem 0 Operação realizada com sucesso 1 Chama...
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tem...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <InclusaoRespons...
Manifestação
Descrição: Gera uma manifestação de um DF-e. URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Ge...
Descrição dos campos de chamada
Campo Tipo Descrição Obrigatório Observação usuario str...
Descrição dos campos de retorno
Campo Descrição codigo Código de status de requisição mensage...
Tabela de código (campos "código" e "mensagem" do retorno)
Codigo Mensagem 1 Chamada incompleta 2 Usuário e/ou senh...
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tem...
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ManifestacaoRes...