Systax DF-e -Manual de Configuração - Webservice
Manual de configuração do Webservice Systax DF-e - versão 09.1 - 08/07/2026
- versão 09.1 - 08/07/2026 - inclusão do manual API - Registro de eventos de Apuração - RTC
- Introdução
- Webservice
- AtualizaColunaERP
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Tabela de código (campos "sucesso" e "descrição" do retorno)
- Exemplo de chamada
- Exemplo de retorno
- ConsultaStatus
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Tabela de status (campo "ConsultaStatusResult" do retorno)
- Exemplo de chamada
- Exemplo de retorno
- ConsultaStatusGoverno
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Tabela de código (campos "código" e "mensagem" do retorno)
- Exemplos de chamada
- Exemplo de retorno
- ConsultaStatusManifesto
- Detalhes dos campos de chamada
- Detalhes dos campos de retorno
- Tabela de código (campos "código" e "mensagem" do retorno)
- Tabela de código (campos "mensagemRetorno " e "status" do retorno)
- Exemplo de chamada
- Exemplo de retorno
- DesacordoCTe
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Tabela de código (campos "código" e "mensagem" do retorno)
- Exemplo de chamada
- Exemplo de retorno
- Download
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Tabela de código (campos "código" e "mensagem" do retorno)
- Exemplo de chamada
- Exemplo de retorno
- DownloadEventos
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Tabela de código (campos "código" e "mensagem" do retorno)
- Tabela de eventos (campo "descrição" do retorno)
- Exemplo de chamada
- Exemplo de retorno
- DownloadFiltrado
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Tabela de código (campos "código" e "mensagem" do retorno)
- Exemplo de chamada
- Exemplos de retorno
- DownloadLote
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Tabela de código (campos "código" e "mensagem" do retorno)
- Exemplo de chamada
- Exemplo de retorno
- GerarDanfeDacte
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Tabela de código (campos "código" e "mensagem" do retorno)
- Exemplo de chamada
- Exemplo de retorno
- GerarDanfeDactePorXml
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Tabela de código (campos "código" e "mensagem" do retorno)
- Exemplo de chamada
- Exemplo de retorno
- GetStatusDFe
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Exemplo de chamada
- Exemplo de retorno
- Inclusão (Upload)
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Tabela de código (campos "código" e "mensagem" do retorno)
- Exemplo de chamada
- Exemplo de retorno
- Manifestação
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Tabela de código (campos "código" e "mensagem" do retorno)
- Exemplo de chamada
- Exemplo de retorno
- API - Registro de eventos de Apuração - RTC
- Objetivo
- Pré-Requisitos da integração
- Conceito Tributário Essencial
- Autenticação
- Acessos
- Sobre a API de Eventos de Apuração
- Campos da Chamada
- Campos do Retorno
- Eventos disponíveis
- Detalhamento por evento
- Cancelamento do Evento de Apuração
- Boas práticas de integração
- Observações sobre prazos e regras legais
- Tratamento de erros
- Consulta dos Eventos de Apuração registrados
Introdução
Este documento destina-se à equipe de desenvolvimento responsável por integrar aplicações internas aos Webservices do Systax DF-e. Com o objetivo de facilitar o processo de integração, a Systax possui um módulo construído na forma de um Webservice, o que garante a interoperabilidade com sistemas desenvolvidos em linguagens e plataformas diversas.
Através deste Link, você pode assistir um vídeo que explica conceitos importantes para uso dessa solução.
Webservice
Para acessar a coleção de chamadas Clique Aqui.
Padrão de comunicação: O meio físico de comunicação será a internet, sendo o modelo de comunicação o padrão de webservices definido pelo WS-I Basic Profile, utilizando SOAP na troca de mensagens entre as aplicações, com XML no padrão Style/Enconding: Document/Literal, wrapped.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
AtualizaColunaERP
Descrição: Atualiza a coluna "ERP" no DFE com as definições de "Integrado" ou "Não Integrado".
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Descrição dos campos de chamada
|
Campo |
Tipo |
Descrição |
Obrigatório |
|
usuario |
string |
Usuário do DFE |
Sim |
|
senha |
string |
Senha do usuário |
Sim |
|
ambiente |
string |
Identificação do ambiente de origem: |
Não |
|
chave |
string |
Chave do documento fiscal |
Sim |
|
acao |
integer |
0-Atualiza a coluna para "Não Integrado" 1-Atualiza a coluna para "Integrado" |
Sim |
Descrição dos campos de retorno
|
Campo |
Mensagem |
|
sucesso |
Código de status de requisição |
|
descricao |
Mensagem de status de requisição |
Tabela de código (campos "sucesso" e "descrição" do retorno)
|
Sucesso |
Descrição |
|
true |
Executado sem erros |
|
false |
Usuário ou senha inválidos |
|
Nota indisponível no DFe |
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:AtualizaColunaERP>
<tem:usuario>usuário</tem:usuario>
<tem:senha>senha</tem:senha>
<tem:chave>35201271784045000142550010000347741907283020</tem:chave>
<tem:acao>1</tem:acao>
</tem:AtualizaColunaERP>
</soapenv:Body>
</soapenv:Envelope>
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AtualizaColunaERPResponse xmlns="http://tempuri.org/">
<AtualizaColunaERPResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:descricao>Executado sem erros</a:descricao>
<a:sucesso>true</a:sucesso>
</AtualizaColunaERPResult>
</AtualizaColunaERPResponse>
</s:Body>
</s:Envelope>
ConsultaStatus
Descrição: Retorna se o DF-e está cancelado. A consulta é feita na tabela de documentos fiscais eletrônicos cancelados do DFE.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Descrição dos campos de chamada
|
Campo |
Tipo |
Descrição |
Obrigatório |
|
usuario |
string |
Usuário do DFE |
Sim |
|
senha |
string |
Senha do usuário |
Sim |
|
ambiente |
string |
Identificação do ambiente de origem: |
Não |
|
chave |
string |
Chave do documento fiscal |
Sim |
|
modDoc |
inter |
Modelo do Documento NF-e = 55 NFC-e = 65 CT-e = 57 CT-eOS = 67 |
Não |
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="http://tempuri.org/"> |
|
<soapenv:Header/> |
|
<soapenv:Body> |
|
<tem:ConsultaStatus> |
|
<tem:usuario>usuario</tem:usuario> |
|
<tem:senha>senha</tem:senha> |
|
<tem:ambiente></tem:ambiente> |
|
<tem:chave>35201208736011000227550010005459701018541522</tem:chave> |
|
<tem:modDoc></tem:modDoc> |
|
</tem:ConsultaStatus> |
|
</soapenv:Body> |
|
</soapenv:Envelope> |
Exemplo de retorno
|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> |
|
<s:Body> |
|
<ConsultaStatusResponse xmlns="http://tempuri.org/"> |
|
<ConsultaStatusResult>OK</ConsultaStatusResult> |
|
</ConsultaStatusResponse> |
|
</s:Body> |
|
</s:Envelope> |
ConsultaStatusGoverno
Descrição: Retorna o status do DF-e do portal da Sefaz.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Atenção: A Sefaz permite a consulta do Status Governo por até 6 meses a partir da data de emissão do documento, caso passe dos 6 meses não retornará mais atualização desse status. Nessa rotina fazemos a consulta 1 vez a cada hora nas primeiras 24 horas, passado 1 dia até o 7º dia a consulta é realizada 1 vez por dia e do 8º até o 35º a consulta é realizada a cada 2 dias. Caso esse limite seja excedido, o usuário é bloqueado. Por isso, caso queira retornar o status de um DF-e sem limitações, orientamos utilizar o método "ConsultaStatus" descrito nesse documento.
Descrição dos campos de chamada
|
Campo |
Tipo |
Descrição |
Obrigatório |
|
usuario |
stirng |
Usuário do DFE |
Sim |
|
senha |
string |
Senha do usuário |
Sim |
|
chave |
string |
Chave do documento fiscal |
Sim |
|
modDoc |
inter |
Modelo do Documento NF-e = 55 NFC-e = 65 CT-e = 57 CT-eOS = 67 |
Não |
Descrição dos campos de retorno
|
Campo |
Descrição |
|
codigo |
Código de status de requisição |
|
mensagem |
Mensagem de status de requisição |
|
xmlRetorno |
XML de retorno do DF-e consultado na Sefaz |
|
mensagemRetorno |
Mensagem de retorno da Sefaz |
|
status |
Código de retorno da Sefaz |
Tabela de código (campos "código" e "mensagem" do retorno)
|
Código |
Mensagem |
|
0 |
Consulta de status realizada com sucesso |
|
1 |
Chamada incompleta |
|
2 |
Usuário e/ou senha inválidos |
|
Login falhou, usuário com mais de 1 cliente cadastrado. Contate os administradores |
|
|
3 |
Erro na consulta de status |
|
Documento " + chamada.chave + " não encontrado na DFe |
|
|
999 |
A operação não pode ser concluída. Contate os administradores |
Exemplos de chamada
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe.chamada"> |
|
<soapenv:Header/> |
|
<soapenv:Body> |
|
<tem:ConsultaStatusGoverno> |
|
<tem:chamadaConsultaStatus> |
|
<wsd:usuario>usuário</wsd:usuario> |
|
<wsd:senha>senha</wsd:senha> |
|
<wsd:chave>35201208736011000227550010005459701018541123</wsd:chave> |
|
<wsd:modDoc>XX</wsd:modDoc> |
|
</tem:chamadaConsultaStatus> |
|
</tem:ConsultaStatusGoverno> |
|
</soapenv:Body> |
|
</soapenv:Envelope>
|
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ConsultaStatusGovernoResponse xmlns="http://tempuri.org/">
<ConsultaStatusGovernoResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:statusGeral>
<a:codigo>0</a:codigo>
<a:mensagem>Consulta de Status realizada com sucesso.</a:mensagem>
</a:statusGeral>
<a:xmlRetorno><![CDATA[<retConsSitNFe versao="4.00" xmlns="http://www.portalfiscal.inf.br/nfe"><tpAmb>1</tpAmb><verAplic>SP_NFE_PL009_V4</verAplic><cStat>100</cStat><xMotivo>Autorizado o uso da NF-e</xMotivo><cUF>35</cUF><dhRecbto>2020-12-14T13:50:36-03:00</dhRecbto><chNFe>35201208736011000227550010005459701018541072</chNFe><protNFe versao="4.00"><infProt><tpAmb>1</tpAmb><verAplic>SP_NFE_PL009_V4</verAplic><chNFe>35201208736011000227550010005459701018541072</chNFe><dhRecbto>2020-12-01T17:23:21-03:00</dhRecbto><nProt>135201122922050</nProt><digVal>iwtGKkKhkXgFN4FdW1HIKKMqo4k=</digVal><cStat>100</cStat><xMotivo>Autorizado o uso da NF-e</xMotivo></infProt></protNFe></retConsSitNFe>]]></a:xmlRetorno>
<a:mensagemRetorno>100 - Autorizado o uso da NF-e</a:mensagemRetorno>
<a:status>100</a:status>
</ConsultaStatusGovernoResult>
</ConsultaStatusGovernoResponse>
</s:Body>
</s:Envelope>
ConsultaStatusManifesto
Descrição: Retorna o status da Manifestação do Documento Fiscal Eletrônico.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Detalhes dos campos de chamada
|
Campo |
Tipo |
Descrição |
Obrigatório |
|
usuario |
string |
Usuário do DFE |
Sim |
|
senha |
string |
Senha do usuário |
Sim |
|
chave |
string |
Chave do documento Fiscal |
Sim |
|
modDoc |
inter |
Modelo do Documento NF-e = 55 NFC-e = 65 CT-e = 57 CT-eOS = 67 |
Não |
Detalhes dos campos de retorno
|
Campo |
Descrição |
|
codigo |
Código de status de requisição |
|
mensagem |
Mensagem de status de requisição |
|
mensagemRetorno |
Descrição do status do DF-e |
|
status |
Código do status do DF-e |
Tabela de código (campos "código" e "mensagem" do retorno)
|
codigo |
mensagem |
|
0 |
Consulta de Status Manifestado realizada com sucesso |
|
1 |
Chamada incompleta |
|
2 |
Usuário e/ou senha inválidos |
|
Login falhou, usuário com mais de 1 cliente cadastrado. Contate os administradores |
|
|
3 |
"Documento " + chamada.chave + " não encontrado na DFe |
|
999 |
A operação não pode ser concluída. Contate os administradores |
Tabela de código (campos "mensagemRetorno " e "status" do retorno)
|
status |
mensagemRetorno |
|
-2 |
Manifestação realizada fora do DFe |
|
210200 |
Confirmação da Operação |
|
0 |
|
|
210210 |
Ciência da Operação |
|
1 |
|
|
210220 |
Desconhecimento da operação |
|
2 |
|
|
210240 |
Operação não Realizada |
|
3 |
Exemplo de chamada
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe.chamada"> |
|
<soapenv:Header/> |
|
<soapenv:Body> |
|
<tem:ConsultaStatusManifesto> |
|
<tem:chamadaConsultaStatus> |
|
<wsd:usuario>usuário</wsd:usuario> |
|
<wsd:senha>senha</wsd:senha> |
|
<wsd:chave>35141147960950089785550060008460881023361622</wsd:chave> |
|
<wsd:modDoc>XX</wsd:modDoc> |
|
</tem:chamadaConsultaStatus> |
|
</tem:ConsultaStatusManifesto> |
|
</soapenv:Body> |
|
</soapenv:Envelope> |
Exemplo de retorno
|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> |
|
<s:Body> |
|
<ConsultaStatusManifestoResponse xmlns="http://tempuri.org/"> |
|
<ConsultaStatusManifestoResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> |
|
<a:statusGeral> |
|
<a:codigo>0</a:codigo> |
|
<a:mensagem>Consulta de Status Manifestado realizada com sucesso.</a:mensagem> |
|
</a:statusGeral> |
|
<a:mensagemRetorno>Desconhecimento da operação</a:mensagemRetorno> |
|
<a:status>2</a:status> |
|
</ConsultaStatusManifestoResult> |
|
</ConsultaStatusManifestoResponse> |
|
</s:Body> |
|
</s:Envelope> |
DesacordoCTe
Descrição: Gera um desacordo de CT-e.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Descrição dos campos de chamada
|
Parâmetro |
Tipo |
Descrição |
Obrigatório |
|
usuario |
string |
Usuário do DFE |
Sim |
|
senha |
string |
Senha do usuário |
Sim |
|
chave |
string |
Chave do CT-e em desacordo |
Sim |
|
obs |
string |
Justificativa |
Sim |
Descrição dos campos de retorno
|
Campo |
Descrição |
|
codigo |
Código de status de requisição |
|
mensagemRetorno |
Mensagem de status de requisição |
|
xmlEnvio |
xml de envio da manifestação |
|
xmlRetorno |
xml de envio de retorno da manifestação |
|
numeroProtocolo |
número de protocolo |
|
dataHoraProtocolo |
data e hora do protocolo |
|
status |
Código do status da solicitação |
Tabela de código (campos "código" e "mensagem" do retorno)
|
Codigo |
Mensagem |
|
1 |
Chamada incompleta |
|
Tipo de documento inválido, desacordo permitido apenas para CTe |
|
|
2 |
Usuário e/ou senha inválidos |
|
Login falhou, usuário com mais de 1 cliente cadastrado. Contate os administradores |
|
|
3 |
Erro no desacordo do documento " + chave |
|
Documento " + chamada.chave + " não encontrado na DFe ou desacordo já realizado |
|
|
999 |
A operação não pode ser concluída. Contate os administradores |
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe.chamada">
<soapenv:Header/>
<soapenv:Body>
<tem:DesacordoCTe>
<tem:chamadaDesacordo>
<tem:usuario>usuário</tem:usuario>
<tem:senha>senha</tem:senha>
<wsd:chave>chave do CT-e</wsd:chave>
<wsd:obs>justificativa</wsd:obs>
</tem:chamadaDesacordo>
</tem:DesacordoCTe>
</soapenv:Body>
</soapenv:Envelope>
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<DesacordoCTeResponse xmlns="http://tempuri.org/">
<DesacordoCTeResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:statusGeral>
<a:codigo>135</a:codigo>
</a:statusGeral>
<a:xmlEnvio>xml de envio</a:xmlEnvio>
<a:xmlRetorno>xml de retorno</a:xmlRetorno>
<a:mensagemRetorno>Lote de evento processado</a:mensagemRetorno>
<a:status>135</a:status>
<a:numeroProtocolo>637464536373635</a:numeroProtocolo>
<a:dataHoraProtocolo>2021-01-05T13:21:25-03:00</a:dataHoraProtocolo>
</DesacordoCTeResult>
</DesacordoCTeResponse>
</s:Body>
</s:Envelope>
Download
Descrição: Retorna um ou mais (lote) *.xml de acordo com a NSU ou chave informada. Nessa modalidade os XML são disponibilizados sem estar em um zip.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Descrição dos campos de chamada
|
Campo |
Tipo |
Descrição |
Obrigatório |
Observação |
|
usuario |
string |
Usuário do DFE |
Sim |
|
|
senha |
string |
Senha do usuário |
Sim |
|
|
chave |
string |
Chave do documento fiscal |
Sim |
Obrigatório se, “nsuDfe” não estiver preenchido. |
|
nsuDfe |
string |
Identificador único do DF-e |
Sim |
Obrigatório se, “chave” não estiver preenchido. |
|
dataInicio |
string |
Data de início no formato |
Não |
|
|
tipoDocumento |
string |
Tipo de documento: 0-Recebido 1-Emitido 3 – Terceiro 999 - Todos |
Sim |
|
|
apenasTransportador |
boolean |
Filtro pela transportadora (quando o cliente está como transportador) |
Não |
|
|
modDoc |
inter |
Modelo do Documento NF-e = 55 NFC-e = 65 CT-e = 57 CT-eOS = 67 |
Não |
|
|
cnpjfilial |
string |
Número do CNPJ |
Não |
|
Descrição dos campos de retorno
|
Campo |
Descrição |
|
chaveDfe |
Chave do DF-e |
|
dfe |
XML do DF-e |
|
nsuDfe |
NSU do DF-e |
|
codigo |
Código de status de requisição |
|
mensagem |
Mensagem de status de requisição |
|
ultNsu |
último NSU gerado (ponteiro) |
Tabela de código (campos "código" e "mensagem" do retorno)
|
Código |
Mensagem |
|
0 |
Consulta de status realizada com sucesso |
|
1 |
Chamada incompleta |
|
2 |
Usuário e/ou senha inválidos |
|
Login falhou, usuário com mais de 1 cliente cadastrado. Contate os administradores. |
|
|
3 |
Erro na consulta de status |
|
Documento " + chamada.chave + " não encontrado na DFe |
|
|
999 |
A operação não pode ser concluída. Contate os administradores |
Exemplo de chamada
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe"> |
|
<soapenv:Header/> |
|
<soapenv:Body> |
|
<tem:Download> |
|
<tem:chamadaDownload> |
|
<wsd:usuario>usuário</wsd:usuario> |
|
<wsd:senha>senha</wsd:senha> |
|
<wsd:chave>35201208736011000227550010005459701018544588</wsd:chave> |
|
<wsd:nsuDfe></wsd:nsuDfe> |
|
<wsd:dataInicio>2020-12-01</wsd:dataInicio> |
|
<wsd:tipoDocumento>1</wsd:tipoDocumento> |
|
<wsd:modDoc>XX</wsd:modDoc> |
|
<wsd:apenasTransportador>0</wsd:apenasTransportador> |
|
</tem:chamadaDownload> |
|
</tem:Download> |
|
</soapenv:Body> |
|
</soapenv:Envelope>
|
Exemplo de retorno
|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> |
|
<s:Body> |
|
<DownloadResponse xmlns="http://tempuri.org/"> |
|
<DownloadResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> |
|
<a:documentos> |
|
<a:Documento> |
|
<a:chaveDfe>35201208736011000227550010005459701018541455</a:chaveDfe> |
|
<a:dfe><![CDATA[xml do DF-e]]></a:dfe> |
|
<a:nsuDfe>146035024</a:nsuDfe> |
|
</a:Documento> |
|
</a:documentos> |
|
<a:statusGeral> |
|
<a:codigo>0</a:codigo> |
|
<a:mensagem>Operação realizada com sucesso.</a:mensagem> |
|
<a:ultNsu>148023961</a:ultNsu> |
|
</a:statusGeral> |
|
</DownloadResult> |
|
</DownloadResponse> |
|
</s:Body> |
|
</s:Envelope> |
DownloadEventos
Descrição: Retorna se o DF-e está associado a algum evento e a natureza dele.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Descrição dos campos de chamada
|
Campos |
Tipo |
Descrição |
Obrigatório |
Observação |
|
usuario |
string |
Usuário do DFE |
Sim |
|
|
senha |
string |
Senha do usuário |
Sim |
|
|
chave |
string |
Chave do documento fiscal |
Sim |
Obrigatório se, “nsuDfe” não estiver preenchido. |
|
nsuEvento |
string |
Identificador único do evento |
Sim |
Obrigatório se, “chave” não estiver preenchido. |
|
dataInicio |
string |
Data de início no formato |
Não |
|
|
tipoDocumento |
string |
Tipo de documento: 0-Recebido 1-Emitido 3 – Terceiro 999 - Todos |
Sim |
|
|
apenasCancelamento |
boolean |
Evento de cancelamento |
Sim |
|
|
modDoc |
inter |
Modelo do Documento NF-e = 55 NFC-e = 65 CT-e = 57 CT-eOS = 67 |
Não |
|
|
cnpjFilial |
string |
Número do CNPJ |
Não |
|
Descrição dos campos de retorno
|
Campos |
Descrição |
|
chave |
Chave do DF-e |
|
xml |
XML do DF-e |
|
descricao |
Mensagem do evento associado ao DF-e |
|
nsuEvento |
NSU do evento |
|
codigo |
Código de status de requisição |
|
mensagem |
Mensagem de status de requisição |
Tabela de código (campos "código" e "mensagem" do retorno)
|
Código |
Mensagem |
|
0 |
Consulta de status realizada com sucesso |
|
1 |
Chamada incompleta |
|
2 |
Usuário e/ou senha inválidos |
|
Login falhou, usuário com mais de 1 cliente cadastrado. Contate os administradores. |
|
|
3 |
Erro na consulta de status |
|
Documento " + chamada.chave + " não encontrado na DFe |
|
|
999 |
A operação não pode ser concluída. Contate os administradores |
Tabela de eventos (campo "descrição" do retorno)
|
Código |
Descrição do evento |
|
135 |
Evento registrado e vinculado |
|
136 |
MDF-e autorizado |
|
213 |
Rejeição: CNPJ-Base do emitente difere do CNPJ-Base do certificado Digital |
|
215 |
Rejeição: Falha no schema XML |
|
218 |
Rejeição: CT-e já está cancelada na base de dados da SEFAZ |
|
290 |
Rejeição: Certificado assinatura inválido |
|
296 |
Rejeição: Certificado assinatura erro no acesso a LCR |
|
493 |
Rejeição: Evento nao atende o schema XML específico |
|
573 |
Rejeição: Duplicidade de evento |
|
575 |
Rejeição: O autor do evento diverge do destinatario da NF-e |
|
596 |
Rejeição: O prazo limite para recepção do evento foi ultrapassado |
|
630 |
Rejeição: Falha no schema específico para o evento |
|
631 |
Rejeição: Duplicidade de evento |
|
650 |
Rejeição:Evento de ciência da operação para NF-e cancelada ou denegada |
|
651 |
Rejeição: Evento de cIência da operação informado após a manifestação final do destinatário |
|
655 |
Evento de Ciência da operação informado após a manifestação final do destinatário |
|
664 |
Rejeição: Evento não permitido para CT-e substituído/anulado |
|
787 |
Rejeição: Data do evento de prestação do serviço em desacordo deve ocorrer em até 45 dias da autorização do CT-e |
|
999 |
Falha |
|
110110 |
Carta de correção |
|
110111 |
Cancelamento |
|
110113 |
EPEC Registrado |
|
110140 |
EPEC |
|
110180 |
Comprovante de Entrega |
|
110181 |
Cancelamento do Comprovante de Entrega do CTe |
|
210200 |
Confirmação da Operação |
|
210210 |
Ciência da Operação |
|
210220 |
Desconhecimento da Operação |
|
210240 |
Operação Não Realizada |
|
240130 |
CTe Complementar Registrado |
|
240131 |
Cancelamento CTe Complementar Registrado |
|
240140 |
CT-e de Substituição Registrada |
|
240150 |
CT-e Anulado |
|
310610 |
MDF-e Autorizado |
|
310611 |
MDF-e Cancelado |
|
310620 |
Registro de Passagem |
|
440130 |
Autorizado o Redespacho CT-e |
|
440140 |
CT-e Redespacho Intermediário Registrado |
|
440150 |
CT-e Subcontratação Registrado |
|
440160 |
Serviço Vinculado Multimodal Registrado |
|
510620 |
Registro de Passagem Auto |
|
610110 |
CT-e Evento Prestação de Serviço em Desacordo |
|
610130 |
Comprovante de Entrega do CT-e |
|
610131 |
Cancelamento Comprovante de Entrega do CT-e |
|
610500 |
Registro Passagem NFe |
|
610500 |
Registro de Passagem Cancelamento |
|
610510 |
Registro de Passagem de NFe Propagado pelo MDF-e |
|
610514 |
Registro de Passagem de NFe Propagado pelo MDF-e/CT-e |
|
610550 |
Registro Passagem NFe |
|
610552 |
Registro Passagem Automático MDF-e |
|
610554 |
Registro Passagem Automático MDF-e/CT-e |
|
610600 |
Registro de Autorização de CT-e para NF-e |
|
610601 |
Registro de Cancelamento de CT-e para NF-e |
|
610610 |
MDF-e Autorizado |
|
610611 |
MDF-e Cancelado |
|
610614 |
MDF-e Autorizado com CT-e |
|
610615 |
Cancelamento de MDF-e Autorizado com CT-e |
|
790700 |
Averbação para Exportação |
|
990900 |
Vistoria SUFRAMA |
|
990910 |
Confirmação de Internalização da Mercadoria na SUFRAMA |
|
110190 |
Evento de Insucesso na Entrega do CT-e |
|
110191 |
Evento Cancelamento do Insucesso na Entrega do CT-e |
Exemplo de chamada
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe"> |
|
<soapenv:Header/> |
|
<soapenv:Body> |
|
<tem:DownloadEventos> |
|
<tem:chamadaDownloadEventos> |
|
<wsd:usuario>usuário</wsd:usuario> |
|
<wsd:senha>senha</wsd:senha> |
|
<wsd:chave>35190124692239000138550000000047241000710000</wsd:chave> |
|
<wsd:nsuEvento></wsd:nsuEvento> |
|
<wsd:dataInicio></wsd:dataInicio> |
|
<wsd:tipoDocumento>1</wsd:tipoDocumento> |
|
<wsd:apenasCancelamento>0</wsd:apenasCancelamento> |
|
</tem:chamadaDownloadEventos> |
|
<wsd:modDoc>XX</wsd:modDoc> |
|
</tem:DownloadEventos> |
|
</soapenv:Body> |
|
</soapenv:Envelope>
|
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<DownloadEventosResponse xmlns="http://tempuri.org/">
<DownloadEventosResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:documentos>
<a:Evento>
<a:chave>35190124692239000138550000000047241000712381</a:chave>
<a:xml><![CDATA[<retEnvEvento versao="1.00" xmlns="http://www.portalfiscal.inf.br/nfe"><idLote>000004724100200</idLote><tpAmb>1</tpAmb><verAplic>AN_1.0.0</verAplic><cOrgao>91</cOrgao><cStat>128</cStat><xMotivo>Lote de evento processado</xMotivo><retEvento versao="1.00"><infEvento><tpAmb>1</tpAmb><verAplic>AN_1.0.0</verAplic><cOrgao>91</cOrgao><cStat>596</cStat><xMotivo>Rejeicao: Evento apresentado apos o prazo permitido para o evento: [6 meses]</xMotivo><chNFe>35190124692239000138550000000047241000710000</chNFe><tpEvento>210200</tpEvento><xEvento>Confirmacao da Operacao</xEvento><nSeqEvento>1</nSeqEvento><dhRegEvento>2019-11-05T12:56:12-02:00</dhRegEvento></infEvento></retEvento></retEnvEvento>]]></a:xml>
<a:descricao>596 - Rejeicao: Evento apresentado apos o prazo permitido para o evento: [6 meses]</a:descricao>
<a:nsuEvento>228960931</a:nsuEvento>
</a:Evento>
</a:documentos>
<a:statusGeral>
<a:codigo>0</a:codigo>
<a:mensagem>Operação realizada com sucesso.</a:mensagem>
</a:statusGeral>
</DownloadEventosResult>
</DownloadEventosResponse>
</s:Body>
</s:Envelope>
DownloadFiltrado
Descrição: Retorna um *.xml de acordo com a NSU ou chave informada, com opções de filtros de CT-e, tomador de serviço e transportadora.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Descrição dos campos de chamada
|
Campo |
Tipo |
Descrição |
Obrigatório |
Observação |
|
usuario |
string |
Usuário do DFE |
Sim |
|
|
senha |
string |
Senha do usuário |
Sim |
|
|
chave |
string |
Chave do documento fiscal |
Sim |
Obrigatório se, “nsuDfe” não estiver preenchido. |
|
nsuDfe |
string |
Identificador único do DF-e |
Sim |
Obrigatório se, “chave” não estiver preenchido. |
|
dataInicio |
string |
Data de início da pesquisa no formato |
Não |
|
|
tipoDocumento |
string |
Tipo de documento: 0-Recebido 1-Emitido 3 – Terceiro 999 - Todos |
Não |
|
|
filtraCte |
boolean |
Filtro por CT-e |
|
|
|
filtroTomadora |
boolean |
Filtro pelo tomador de serviço |
|
|
|
apenasTransportadoras |
boolean |
Filtro pela transportadora (quando o cliente está como transportador) |
Não |
|
|
modDoc |
inter |
Modelo do Documento NF-e = 55 NFC-e = 65 CT-e = 57 CT-eOS = 67 |
Não |
|
|
cnpjfilial |
string |
Número do CNPJ |
Não |
|
Descrição dos campos de retorno
|
Campo |
Descrição |
|
chaveDfe |
Chave do DF-e |
|
dfe |
XML do DF-e |
|
nsuDfe |
NSU do DF-e |
|
codigo |
Código de status de requisição |
|
mensagem |
Mensagem de status de requisição |
|
ultNsu |
Último NSU gerado (ponteiro) |
Tabela de código (campos "código" e "mensagem" do retorno)
|
Código |
Mensagem |
|
0 |
Consulta de status realizada com sucesso |
|
1 |
Chamada incompleta |
|
2 |
Usuário e/ou senha inválidos |
|
Login falhou, usuário com mais de 1 cliente cadastrado. Contate os administradores. |
|
|
3 |
Erro na consulta de status |
|
Documento " + chamada.chave + " não encontrado na DFe |
|
|
999 |
A operação não pode ser concluída. Contate os administradores |
Exemplo de chamada
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe"> |
|
<soapenv:Header/> |
|
<soapenv:Body> |
|
<tem:DownloadFiltrado> |
|
<tem:chamadaDownload> |
|
<wsd:usuario>usuário</wsd:usuario> |
|
<wsd:senha>senha</wsd:senha> |
|
<wsd:chave>35201208736011000227550010005459701018548456</wsd:chave> |
|
<wsd:nsuDfe></wsd:nsuDfe> |
|
<wsd:dataInicio></wsd:dataInicio> |
|
<wsd:tipoDocumento>1</wsd:tipoDocumento> |
|
<wsd:filtraCte>0</wsd:filtraCte> |
|
<wsd:filtroTomadora>0</wsd:filtroTomadora> |
|
<wsd:apenasTransportadoras>0</wsd:apenasTransportadoras> |
|
<wsd:modDoc>XX</wsd:modDoc> |
|
</tem:chamadaDownload> |
|
</tem:DownloadFiltrado> |
|
</soapenv:Body> |
|
</soapenv:Envelope>
|
Exemplos de retorno
|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> |
|
<s:Body> |
|
<DownloadFiltradoResponse xmlns="http://tempuri.org/"> |
|
<DownloadFiltradoResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> |
|
<a:documentos> |
|
<a:Documento> |
|
<a:chaveDfe>352012087360110002275500100054597010185418456</a:chaveDfe> |
|
<a:dfe><![CDATA[xml do DF-e]]></a:dfe> |
|
<a:nsuDfe>146035024</a:nsuDfe> |
|
</a:Documento> |
|
</a:documentos> |
|
<a:statusGeral> |
|
<a:codigo>0</a:codigo> |
|
<a:mensagem>Operação realizada com sucesso.</a:mensagem> |
|
<a:ultNsu>148023961</a:ultNsu> |
|
</a:statusGeral> |
|
</DownloadFiltradoResult> |
|
</DownloadFiltradoResponse> |
|
</s:Body> |
|
</s:Envelope> |
DownloadLote
Descrição: Retorna um ou mais (lote) *.xml de acordo com a NSU ou chave informada. Nessa modalidade os XML são disponibilizados em um arquivo zip.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Descrição dos campos de chamada
|
Campo |
Tipo |
Descrição |
Obrigatório |
Observação |
|
usuario |
stirng |
Usuário do DFE |
Sim |
|
|
senha |
string |
Senha do usuário |
Sim |
|
|
chave |
string |
Chave do documento fiscal |
Sim |
Obrigatório se, “nsuDfe” não estiver preenchido. |
|
nsuDfe |
string |
Identificador único do DF-e |
Sim |
Obrigatório se, “chave” não estiver preenchido. |
|
dataInicio |
string |
Data de início da pesquisa no formato |
Não |
|
|
tipoDocumento |
string |
Tipo de documento: 0-Recebido 1-Emitido 3 – Terceiro 999 - Todos |
Sim |
|
|
apenasTransportador |
boolean |
Filtro pela transportadora (quando o cliente está como transportador) |
Não |
|
|
modDoc |
inter |
Modelo do Documento NF-e = 55 NFC-e = 65 CT-e = 57 CT-eOS = 67 |
Não |
|
|
cnpjfilial |
string |
Número do CNPJ |
Não |
|
Descrição dos campos de retorno
|
Campo |
descrição |
|
chaveDfe |
Chave do DF-e |
|
dfe |
Compactado com os XML´s slecionados |
|
nsuDfe |
NSU do DF-e |
|
codigo |
Código de status de requisição |
|
mensagem |
Mensagem de status de requisição |
|
ultNsu |
Último DF-e gerado (ponteiro) |
Tabela de código (campos "código" e "mensagem" do retorno)
|
Código |
Mensagem |
|
0 |
Consulta de status realizada com sucesso |
|
1 |
Chamada incompleta |
|
2 |
Usuário e/ou senha inválidos |
|
Login falhou, usuário com mais de 1 cliente cadastrado. Contate os administradores. |
|
|
3 |
Erro na consulta de status |
|
Documento " + chamada.chave + " não encontrado na DFe |
|
|
999 |
A operação não pode ser concluída. Contate os administradores |
Exemplo de chamada
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe"> |
|
<soapenv:Header/> |
|
<soapenv:Body> |
|
<tem:DownloadLote> |
|
<tem:chamadaDownloadLote> |
|
<wsd:usuario>usuário</wsd:usuario> |
|
<wsd:senha>senha</wsd:senha> |
|
<wsd:chave>35201208736011000227550010005459701018548496</wsd:chave> |
|
<wsd:nsuDfe></wsd:nsuDfe> |
|
<wsd:dataInicio></wsd:dataInicio> |
|
<wsd:tipoDocumento>1</wsd:tipoDocumento> |
|
<wsd:apenasTransportador>0</wsd:apenasTransportador> |
|
<wsd:modDoc>XX</wsd:modDoc> |
|
</tem:chamadaDownloadLote> |
|
</tem:DownloadLote> |
|
</soapenv:Body> |
|
</soapenv:Envelope>
|
Exemplo de retorno
|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> |
|
<s:Body> |
|
<DownloadLoteResponse xmlns="http://tempuri.org/"> |
|
<DownloadLoteResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> |
|
<a:documentos> |
|
<a:Documento> |
|
<a:chaveDfe>35201208736011000227550010005459701018543694</a:chaveDfe> |
|
<a:dfe>arquivo compactado</a:dfe> |
|
<a:nsuDfe>146035024</a:nsuDfe> |
|
</a:Documento> |
|
</a:documentos> |
|
<a:statusGeral> |
|
<a:codigo>0</a:codigo> |
|
<a:mensagem>Operação realizada com sucesso.</a:mensagem> |
|
<a:ultNsu>148023961</a:ultNsu> |
|
</a:statusGeral> |
|
</DownloadLoteResult> |
|
</DownloadLoteResponse> |
|
</s:Body> |
|
</s:Envelope> |
GerarDanfeDacte
GerarDanfeDacte: Retorna o DANFE, DACTE ou CT-eOS (representação simplificada) por PDF.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Descrição dos campos de chamada
|
Campo |
Tipo |
Descrição |
Obrigatório |
|
usuario |
string |
Usuário do DF-e |
Sim |
|
senha |
string |
Senha do usuário |
Sim |
|
chave |
string |
Chave do DF-e |
Sim |
Descrição dos campos de retorno
|
Campo |
Descrição |
|
Nome |
Nome do arquivo com a extensão *.pdf |
|
ArquivoBase64String |
Conteúdo do arquivo |
|
codigo |
Código de status de requisição |
|
mensagem |
Mensagem de status de requisição |
Tabela de código (campos "código" e "mensagem" do retorno)
|
Codigo |
Mensagem |
|
1 |
mensagemErro |
|
2 |
Usuário e/ou senha inválidos |
|
404 |
XML não encontrado |
|
200 |
OK |
|
999 |
A operação não pode ser concluída. Contate os administradores |
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe.chamada">
<soapenv:Header/>
<soapenv:Body>
<tem:GerarDanfeDacte>
<tem:gerarDanfeDacteModel>
<wsd:usuario>usuário</wsd:usuario>
<wsd:senha>senha</wsd:senha>
<wsd:chave>35201224230747000102570040005587611055877884</wsd:chave>
</tem:gerarDanfeDacteModel>
</tem:GerarDanfeDacte>
</soapenv:Body>
</soapenv:Envelope>
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GerarDanfeDacteResponse xmlns="http://tempuri.org/">
<GerarDanfeDacteResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:arquivo>
<a:Nome>57_e3f6c3e8-8918-4be7-8d50-c062e5a75b36.pdf</a:Nome>
<a:ArquivoBase64String>conteúdo do DACTE</a:ArquivoBase64String>
</a:arquivo>
<a:statusGeral>
<a:codigo>200</a:codigo>
<a:mensagem>OK</a:mensagem>
</a:statusGeral>
</GerarDanfeDacteResult>
</GerarDanfeDacteResponse>
</s:Body>
</s:Envelope>
GerarDanfeDactePorXml
GerarDanfeDactePorXml: Retorna o DANFE, DACTE ou CT-eOS (representação simplificada) por XML.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Descrição dos campos de chamada
|
Campo |
Tipo |
Descrição |
Obrigatório |
|
usuario |
string |
Usuário do DFE |
Sim |
|
senha |
string |
Senha do usuário |
Sim |
|
xml |
string |
XML do DF-e |
Sim |
|
modelo |
string |
Modelo do DF-e |
Sim |
Descrição dos campos de retorno
|
Campo |
Descrição |
|
Nome |
Nome do arquivo com a extensão *.pdf |
|
ArquivoBase64String |
Conteúdo do arquivo |
|
codigo |
Código de status de requisição |
|
mensagem |
Mensagem de status de requisição |
Tabela de código (campos "código" e "mensagem" do retorno)
|
codigo |
mensagem |
|
1 |
Chamada incompleta |
|
2 |
Usuário e/ou senha inválidos |
|
200 |
OK |
|
999 |
A operação não pode ser concluída. Contate os administradores |
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe.chamada">
<soapenv:Header/>
<soapenv:Body>
<tem:GerarDanfeDactePorXml>
<tem:gerarDanfeDacteModel>
<wsd:usuario>usuário</wsd:usuario>
<wsd:senha>senha</wsd:senha>
<wsd:xml><![CDATA[conteúdo do XML]]></wsd:xml>
<wsd:modelo>57</wsd:modelo>
</tem:gerarDanfeDacteModel>
</tem:GerarDanfeDactePorXml>
</soapenv:Body>
</soapenv:Envelope>
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GerarDanfeDactePorXmlResponse xmlns="http://tempuri.org/">
<GerarDanfeDactePorXmlResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:arquivo>
<a:Nome>57_3981594b-ec4c-41eb-b396-b6a66858ac41.pdf</a:Nome>
<a:ArquivoBase64String>conteúdo do DACTE</a:ArquivoBase64String>
</a:arquivo>
<a:statusGeral>
<a:codigo>200</a:codigo>
<a:mensagem>OK</a:mensagem>
</a:statusGeral>
</GerarDanfeDactePorXmlResult>
</GerarDanfeDactePorXmlResponse>
</s:Body>
</s:Envelope>
GetStatusDFe
Descrição: Retorna as inconsistências encontradas nas validações que o Systax DF-e realiza.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Descrição dos campos de chamada
|
Campo |
Tipo |
Descrição |
Obrigatório |
|
usuario |
string |
Usuário do DF-e |
Sim |
|
senha |
string |
Senha do usuário |
Sim |
|
chave |
string |
Chave do DF-e |
Sim |
Descrição dos campos de retorno
|
Campo |
Descrição |
|
chave |
Chave do DF-e |
|
dh_status_governo |
Data e hora do último status do DF-e na SEFAZ |
|
documento |
Tipo de documento: NF-e, NFC-e ou CT-e |
|
dt_inclusao |
Data de inclusão do documento no DFE |
|
modelo |
Modelo do DF-e |
|
status_geral |
Status geral do DF-e |
|
status_governo |
Código de status do DF-e na SEFAZ |
|
status_governo_desc |
Descrição do código de status na SEFAZ |
|
status_governo_detalhe |
Detalhe do status do DF-e na SEFAZ |
|
status_integridade |
Integridade do status do DF-e |
|
status_manifestacao |
Status da Manifestação |
|
codigo |
Código de status de requisição |
|
mensagem |
Mensagem de status de requisição |
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe">
<soapenv:Header/>
<soapenv:Body>
<tem:GetStatusDFe>
<tem:chamadaStatus>
<wsd:usuario>usuário</wsd:usuario>
<wsd:senha>senha</wsd:senha>
<wsd:documentos>
<wsd:DocumentoChamada>
<wsd:chave>35201208736011000227550010005459701018542369</wsd:chave>
</wsd:DocumentoChamada>
</wsd:documentos>
</tem:chamadaStatus>
</tem:GetStatusDFe>
</soapenv:Body>
</soapenv:Envelope>
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body
<GetStatusDFeResponse xmlns="http://tempuri.org/">
<GetStatusDFeResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:documentos>
<a:StatusDocumento>
<a:chave>35201208736011000227550010005459701018541078</a:chave>
<a:dh_status_governo>2020-12-16T15:55:05.490686</a:dh_status_governo>
<a:documento>nfe</a:documento>
<a:dt_inclusao>02/12/2020 09:31:45</a:dt_inclusao>
<a:modelo>55</a:modelo>
<a:status_geral>Ok</a:status_geral>
<a:status_governo>100</a:status_governo>
<a:status_governo_desc>100 - Autorizado o uso da NF-e</a:status_governo_desc>
<a:status_governo_detalhe i:nil="true"/>
<a:status_integridade>Ok</a:status_integridade>
<a:status_integridade_desc i:nil="true"/>
<a:status_manifestacao/>
</a:StatusDocumento>
</a:documentos>
<a:statusGeral>
<a:codigo>0</a:codigo>
<a:mensagem>Operação realizada com sucesso.</a:mensagem>
</a:statusGeral>
</GetStatusDFeResult>
</GetStatusDFeResponse>
</s:Body>
</s:Envelope>
Inclusão (Upload)
Inclusão: Fornece a chamada de inclusão de um DF-e no sistema.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Descrição dos campos de chamada
|
Campo |
Tipo |
Descrição |
Obrigatório |
|
usuario |
string |
Usuário do DFE |
Sim |
|
senha |
string |
Senha do usuário |
Sim |
|
documento |
string |
XML do DF-e |
Sim |
Descrição dos campos de retorno
|
Campo |
Descrição |
|
codigo |
Código de status de requisição |
|
mensagem |
Mensagem de status de requisição |
Tabela de código (campos "código" e "mensagem" do retorno)
|
Código |
Mensagem |
|
0 |
Operação realizada com sucesso |
|
1 |
Chamada incompleta |
|
2 |
Usuário e/ou senha inválidos |
|
3 |
DFe inválido |
|
999 |
A operação não pode ser concluída. Contate os administradores |
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe.chamada">
<soapenv:Header/>
<soapenv:Body>
<tem:Inclusao>
<tem:chamadaInclusao>
<wsd:usuario>usuário</wsd:usuario>
<wsd:senha>senha</wsd:senha>
<wsd:documento><![CDATA[xml do DF-e]]></wsd:documento>
</tem:chamadaInclusao>
</tem:Inclusao>
</soapenv:Body>
</soapenv:Envelope>
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<InclusaoResponse xmlns="http://tempuri.org/">
<InclusaoResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:statusGeral>
<a:codigo>0</a:codigo>
<a:mensagem>Operação realizada com sucesso.</a:mensagem>
</a:statusGeral>
</InclusaoResult>
</InclusaoResponse>
</s:Body>
</s:Envelope>
Manifestação
Descrição: Gera uma manifestação de um DF-e.
URL do WSDL: https://dfe.systax.com.br/WSDFe/DFe_Geral.svc?wsdl
Descrição dos campos de chamada
|
Campo |
Tipo |
Descrição |
Obrigatório |
Observação |
|
usuario |
string |
Usuário do DFE |
Sim |
|
|
senha |
string |
Senha do usuário |
Sim |
|
|
chave |
string |
Chave do DF-e em manifestação |
Sim |
|
|
tpEvento |
inteiro |
Tipo de evento: |
Sim |
|
|
0-Confirmacao da Operação |
||||
|
1-Ciência da Operação |
||||
|
2-Desconhecimento da operação |
||||
|
3-Operação Não Realizada |
||||
|
justificativa |
string |
Justificativa da manifestação |
Não |
Para a Manifestação de Operação Não Realizada é obrigatório a justificativa com no min. 15 caracteres. |
Descrição dos campos de retorno
|
Campo |
Descrição |
|
codigo |
Código de status de requisição |
|
mensagem |
Mensagem de status de requisição |
|
xmlEnvio |
xml de envio da manifestação |
|
xmlRetorno |
xml de envio de retorno da manifestação |
|
mensagemRetorno |
Mensagem do retorno |
|
status |
Mensagem de status |
|
numeroProtocolo |
número de protocolo |
|
dataHoraProtocolo |
data e hora do protocolo |
Tabela de código (campos "código" e "mensagem" do retorno)
|
Codigo |
Mensagem |
|
1 |
Chamada incompleta |
|
2 |
Usuário e/ou senha inválidos |
|
3 |
Tipo de documento inválido, manifestação permitida apenas para NFe |
|
"Erro na manifestação do documento " + chave |
|
|
Documento " + chave + " não encontrado na DFe ou manifestação já realizada |
|
|
999 |
A operação não pode ser concluída. Contate os administradores |
Exemplo de chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe.chamada">
<soapenv:Header/>
<soapenv:Body>
<tem:Manifestacao>
<tem:chamadaManifestacao>
<wsd:usuario>usuário</wsd:usuario>
<wsd:senha>senha</wsd:senha>
<wsd:chave>chave do NF-e</wsd:chave>
<wsd:tpEvento>3</wsd:tpEvento>
<wsd:justificativa>justificativa</wsd:justificativa>
</tem:chamadaManifestacao>
</tem:Manifestacao>
</soapenv:Body>
</soapenv:Envelope>
Exemplo de retorno
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ManifestacaoResponse xmlns="http://tempuri.org/">
<ManifestacaoResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:statusGeral>
<a:codigo>135</a:codigo>
<a:mensagem>Evento registrado e vinculado a NF-e</a:mensagem>
</a:statusGeral>
<a:xmlEnvio>xml de envio</a:xmlEnvio>
<a:xmlRetorno>xml de retorno</a:xmlRetorno>
<a:mensagemRetorno>135 - Evento registrado e vinculado a NF-e</a:mensagemRetorno>
<a:status>135</a:status>
<a:numeroProtocolo>891210084364156</a:numeroProtocolo>
<a:dataHoraProtocolo>2021-01-08T09:21:25-03:00</a:dataHoraProtocolo>
</ManifestacaoResult>
</ManifestacaoResponse>
</s:Body>
</s:Envelope>
API - Registro de eventos de Apuração - RTC
Este manual apresenta as APIs disponíveis para o envio de eventos de Apuração relacionados à Reforma Tributária do Consumo (RTC) no contexto dos Documentos Fiscais Eletrônicos (DF-e). Esses eventos permitem registrar, junto ao ambiente nacional, informações fiscais como consumo pessoal, crédito presumido, crédito de bens e serviços, crédito com combustíveis, notas de débito e crédito, imobilização de item, perecimento, perda, roubo ou furto, além da transferência de crédito referente ao IBS e à CBS.
Objetivo
Ao longo do documento, são descritas as orientações necessárias para integração com as APIs REST da plataforma Systax, incluindo autenticação, endpoints, estrutura das requisições e respostas, prazos legais aplicáveis e boas práticas para utilização dos serviços.
Pré-Requisitos da integração
Para utilização das APIs de Eventos de Apuração, é necessário que o cliente esteja previamente cadastrado e habilitado na plataforma Systax DF-e, possua certificado digital A1 válido e configurado para o CNPJ destinatário, tenha permissão de acesso aos recursos da API e utilize token JWT válido no cabeçalho da requisição.
Conceito Tributário Essencial
IBS e CBS — Reforma Tributária (EC 132/2023)
A Emenda Constitucional 132/2023 instituiu dois novos tributos sobre o consumo:
|
Tributo |
Substitui |
Competência |
|
IBS — Imposto sobre Bens e Serviços |
ICMS (estadual) + ISS (municipal) |
Estados e municípios / Comitê Gestor |
|
CBS — Contribuição sobre Bens e Serviços |
PIS + COFINS |
Federal / Receita Federal |
Para documentos fiscais sujeitos à reforma, o destinatário precisa registrar na SEFAZ a destinação fiscal dos itens recebidos e a apropriação dos créditos de IBS/CBS gerados pela operação.
Autenticação
A autenticação das APIs de envio de eventos de apuração para o DF-e é feita via JWT bearer token. Para mais detalhes de como obtê-la, acesse a última versão de documentação pelo link: https://documentacao.systax.com.br/books/manual-da-api-de-geracao-de-token
Base URL
|
Ambiente |
Base URL |
|
PRODUÇÃO |
https://apidfe.systax.com.br |
Headers Obrigatórios:
POST /api/eventos/credito-bens-servicos HTTP/1.1
Host: apidfe.systax.com.br
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json
Accept: application/json
Acessos
Swagger
O Swagger é uma estrutura de software de código aberto que permite aos desenvolvedores projetar, criar, documentar e consumir serviços da Web RESTful. Esse recurso facilita o trabalho dos desenvolvedores, fazendo com que eles tenham um entendimento do objetivo da API, permitindo executar chamadas sem a necessidade de desenvolvimento de códigos.
Link URL: https://apidfe.systax.com.br/swagger
Sobre a API de Eventos de Apuração
|
Ambiente |
Base URL |
|
PRODUÇÃO |
https://apidfe.systax.com.br |
A API de Eventos de Apuração suporta os Eventos da Reforma Tributária IBS/CBS (apuração e destinação de créditos, via API REST). Que é transmitido ao WebService NFeRecepcaoEvento4 da SEFAZ pela Systax, com certificado digital A1 do destinatário.
E possui as seguintes finalidades:
|
Característica |
Reforma Tributária (IBS/CBS) – Eventos de Apuração |
|
Finalidade |
Registrar destinação fiscal e apropriar créditos IBS/CBS |
|
Base legal |
EC 132/2023 + regulamentação SEFAZ |
|
Protocolo Systax |
API REST com JWT (apidfe.systax.com.br) |
|
Autenticação |
Bearer JWT no header HTTP |
|
Processamento |
Síncrono (retorna protocolo SEFAZ) |
|
Códigos de evento |
110001, 211110–212120 ... |
Campos da Chamada
|
Campo |
Tipo |
Obrigatório |
Formato/Valores |
Descrição |
|
chave |
string |
Sim |
44 dígitos |
Chave de acesso da NF-e vinculada ao evento. |
|
eventos |
array |
Sim |
Lista de códigos |
Lista de eventos a serem enviados. |
|
itens |
array |
Sim |
Lista de itens |
Lista de itens |
|
numeroItem |
integer |
Sim |
Número do item no XML |
Item da NF-e ao qual o evento se refere. |
|
numerosItem |
array |
Sim |
Lista dos números de item da NF-e |
Lista dos números dos itens da NF-e vinculados ao evento, indicando quais itens do documento fiscal geram direito à apropriação de crédito de IBS e CBS. |
|
indicadorAceitacao |
boolean |
Sim |
true/false |
Indica aceite ou não aceite. |
Obs.: Múltiplos eventos por chamada - Todos os endpoints aceitam múltiplos eventos no array eventos[]. Cada item é processado individualmente e retorna seu próprio resultado no array de resposta. Um item pode falhar sem cancelar o processamento dos demais.
Obs2.: Atualmente, o Governo permite o envio de eventos em lote limitado a até 20 eventos por chamada. No entanto, a recomendação é que o envio seja realizado individualmente, pois essa forma tende a ser exigida futuramente, conforme previsto na Nota Técnica 2025.002-RTC, versão 1.50, de junho de 2026.
Respostas:
|
Tipo de retorno |
Exemplo |
Significado |
|
HTTP 200 com sucesso true |
Evento autorizado |
A API processou e a SEFAZ registrou o evento. |
|
HTTP 200 com sucesso false |
Rejeição da SEFAZ |
A API processou a chamada, mas o evento foi rejeitado pelo ambiente fiscal. |
|
HTTP 400 |
Erro de requisição |
A estrutura enviada está inválida ou faltam campos obrigatórios. |
|
HTTP 401 |
Erro de autenticação |
Token ausente, expirado ou inválido. |
|
HTTP 403 |
Erro de permissão |
Cliente não habilitado para o recurso. |
|
HTTP 500 |
Erro interno |
Falha inesperada no processamento. |
Campos do Retorno
O campo xmlRetorno contém o XML de retorno gerado pelo ambiente fiscal após o processamento do evento. Nele constam informações como ambiente, órgão autorizador, código de status, motivo do processamento, chave da NF-e, tipo de evento, data/hora de registro e número do protocolo. Esse XML pode ser utilizado pelo integrador para armazenamento, auditoria e conciliação fiscal.
|
CAMPO |
DESCRIÇÃO |
|
id |
ID do evento gerado pela SEFAZ |
|
tipoEvento |
Código do evento contendo 6 dígitos, conforme tabela 8.1 da Nota Técnica da Reforma tributária |
|
dataRegistro |
Data de efetuação do registro do evento, formada por ano, mês, dia, hora e segundo |
|
chave |
Chave da NF-e cujo evento ocorreu |
|
xmlRetorno |
Dados do xml enviado para o ambiente nacional |
|
codigoStatusEvento |
Status do evento na Sefaz |
|
motivoEvento |
Informa o motivo do processamento retornado pelo ambiente fiscal. |
|
nProtocolo |
Número de protocolo retornado pelo ambiente fiscal após o registro do evento. |
|
sucesso |
Apresenta “True” para envio do registro de evento ou “False” caso alguma inconsistência seja verificada |
Eventos disponíveis
Existe uma API para cada tipo de evento da reforma tributária, com o intuito de enviar a informação para o ambiente nacional, e posteriormente receber o XML de retorno no Systax DF-e.
A plataforma Systax suporta 09 tipos de eventos de apuração IBS/CBS que são de responsabilidade do Destinatário. O processamento é síncrono: a resposta da API já contém o protocolo da SEFAZ.
Endpoints Disponíveis por evento:
|
Código |
Evento |
Rota |
|
211110 |
Solicitação de Apropriação de crédito presumido |
POST /api/eventos/credito-presumido |
|
211124 |
Perecimento, perda, roubo ou furto durante o transporte contratado pelo adquirente |
POST /api/eventos/perecimento-perda-roubo-furto |
|
211128 |
Aceite de débito na apuração por emissão de nota de crédito |
POST /api/eventos/debito-nota-credito |
|
211130 |
Imobilização de Item |
POST /api/eventos/imobilizacao-item |
|
211140 |
Solicitação de Apropriação de Crédito de Combustível |
POST /api/eventos/credito-combustivel |
|
211150 |
Solicitação de Apropriação de Crédito para bens e serviços que dependem de atividade do adquirente |
POST /api/eventos/credito-bens-servicos |
|
212110 |
Manifestação sobre Pedido de Transferência de Crédito de IBS em Operações de Sucessão |
POST /api/eventos/transferencia-credito-ibs |
|
212120 |
Manifestação sobre Pedido de Transferência de Crédito de CBS em Operações de Sucessão |
POST /api/eventos/transferencia-credito-cbs |
|
110001 |
Cancelamento de Evento |
POST /api/eventos/cancelamento |
Detalhamento por evento
Nesta seção, são apresentados os detalhes de chamada e retorno de cada evento, incluindo os campos que devem ser enviados na requisição, suas respectivas descrições e exemplos de uso.
211110 - Solicitação de Apropriação de crédito presumido
Descrição: Registra a apropriação de crédito presumido de IBS/CBS concedido por legislação específica a determinados setores ou operações. O destinatário informa os itens da NF-e que se enquadram no benefício e os códigos de regime tributário.
ü Método da API: POST
ü Endpoint: https://apidfe.systax.com.br/api/eventos/credito-presumido
Campos da chamada:
|
CAMPO |
DESCRIÇÃO |
|
numeroItem |
Número de ordem do item apresentado no XML, ao qual ocorreu o evento |
|
codigoIbs |
Código de Crédito Presumido da IBS (cCredPres), conforme anexo IV da nota técnica da RT, ao qual pode ser consultado no portal NF-e (Documento/ Diversos/ Tabela de código de crédito presumido do IBS e CBS) |
|
codigoCbs |
Código de Crédito Presumido da CBS (cCredPres), conforme anexo IV da nota técnica da RT, ao qual pode ser consultado no portal NF-e (Documento/ Diversos/ Tabela de código de crédito presumido do IBS e CBS) |
Exemplo de chamada
|
{ "eventos": [ { "chave": "35260712345678000195550010000012341000012345", "itens": [ { "numeroItem": 1, "codigoIbs": "000001", "codigoCbs": "000002" } ] } ] }
|
Exemplo de retorno
|
[ { "id": 475702, "tipoEvento": "211110", "dataRegistro": "2026-03-23T14:51:46", "chave": "35260712345678000195550010000012341000012345", "xmlRetorno": "<retEvento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infEvento><tpAmb>2</tpAmb><verAplic>SVRS2602051011</verAplic><cOrgao>43</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e vinculado a NF-e</xMotivo><chNFe>35260712345678000195550010000012341000012345</chNFe><tpEvento>211110</tpEvento><nSeqEvento>1</nSeqEvento><CNPJDest>12345678000195</CNPJDest><dhRegEvento>2026-03-23T14:51:46-03:00</dhRegEvento><nProt>143260000271302</nProt></infEvento></retEvento>", "codigoStatusEvento": "135", "motivoEvento": "Evento registrado e vinculado a NF-e", "nProtocolo": "143260000271302", "sucesso": true } ] |
211124 - Perecimento, perda, roubo ou furto durante o transporte contratado pelo adquirente
Descrição: Evento utilizado para registrar a ocorrência de perecimento, perda, roubo ou furto de mercadoria durante transporte contratado pelo adquirente. Permite informar os itens e quantidades afetadas, para fins de ajuste da destinação fiscal e da apuração dos créditos de IBS e CBS, conforme as regras da Reforma Tributária do Consumo e da legislação tributária aplicável.
ü Método da API: POST
ü Endpoint: https://apidfe.systax.com.br/api/eventos/perecimento-perda-roubo-furto
Campos da chamada
|
CAMPO |
DESCRIÇÃO |
|
numeroItem |
Número de ordem do item apresentado no XML, ao qual ocorreu o evento |
|
quantidadePerecimento |
Quantidade do item afetada por perecimento, perda, roubo ou furto durante o transporte contratado pelo adquirente. |
Exemplo de chamada
|
{ "eventos": [ { "chave": "35260712345678000195550010000012341000012345", "itens": [ { "numeroItem": 1, "quantidadePerecimento": 1 } ] } ] } |
Exemplo de retorno
|
[ { "id": 466095, "tipoEvento": "211124", "dataRegistro": "2026-03-23T15:21:40", "chave": "35260712345678000195550010000012341000012345", "xmlRetorno": "<retEvento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infEvento><tpAmb>2</tpAmb><verAplic>SVRS2602051011</verAplic><cOrgao>43</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e vinculado a NF-e</xMotivo><chNFe>35260712345678000195550010000012341000012345</chNFe><tpEvento>211124</tpEvento><nSeqEvento>1</nSeqEvento><CNPJDest>12345678000195</CNPJDest><dhRegEvento>2026-03-23T15:21:40-03:00</dhRegEvento><nProt>143260000271449</nProt></infEvento></retEvento>", "codigoStatusEvento": "135", "motivoEvento": "Evento registrado e vinculado a NF-e", "nProtocolo": "143260000271449", "sucesso": true } ] |
211128 - Aceite de débito na apuração por emissão de nota de crédito
Descrição: Evento utilizado para registrar o débito de IBS e CBS decorrente de Nota de Crédito vinculada à NF-e. Permite ao destinatário informar a aceitação ou não dos valores lançados na apuração assistida, ajustando os débitos tributários conforme as regras da Reforma Tributária do Consumo e da legislação aplicável.
ü Método da API: POST
ü Endpoint: https://apidfe.systax.com.br/api/eventos/debito-nota-credito
Campos da chamada:
|
CAMPO |
DESCRIÇÃO |
|
indicadorAceitacao |
Indica se o destinatário aceita o débito gerado pela nota de crédito na apuração assistida. Valores: false = não aceite; true=aceite. |
Exemplo de chamada
|
{ "eventos": [ { "chave": "35260712345678000195550010000012341000012345", "indicadorAceitacao": true } ] }
|
Exemplo de retorno
|
[ { "id": 475695, "tipoEvento": "211128", "dataRegistro": "2026-07-07T11:21:06", "chave": "35260712345678000195550010000012341000012345", "xmlRetorno": "<retEvento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infEvento><tpAmb>2</tpAmb><verAplic>SVRS2607061411</verAplic><cOrgao>33</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e vinculado a NF-e</xMotivo><chNFe>35260712345678000195550010000012341000012345</chNFe><tpEvento>211128</tpEvento><nSeqEvento>1</nSeqEvento><CNPJDest>12345678000195</CNPJDest><dhRegEvento>2026-07-07T11:21:06-03:00</dhRegEvento><nProt>333260000303674</nProt></infEvento></retEvento>", "codigoStatusEvento": "135", "motivoEvento": "Evento registrado e vinculado a NF-e", "nProtocolo": "333260000303674", "sucesso": true } ] |
211130 - Imobilização de item
Descrição: Evento utilizado para registrar que determinado item da NF-e foi destinado ao ativo imobilizado do adquirente. Deve ser informado quando o item da NF-e for incorporado ao ativo imobilizado do adquirente, permitindo o correto tratamento fiscal dos créditos de IBS e CBS.
ü Método da API: POST
ü Endpoint: https://apidfe.systax.com.br/api/eventos/imobilizacao-item
Campos da chamada
|
CAMPO |
DESCRIÇÃO |
|
numeroItem |
Número de ordem do item apresentado no XML, ao qual ocorreu o evento |
|
quantidadeImobilizada |
Quantidade de itens a serem informados no processo de integração ao ativo imobilizado da empresa |
Exemplo de chamada
|
{ "eventos": [ { "chave": "35260712345678000195550010000012341000012345", "itens": [ { "numeroItem": 1, "quantidadeImobilizada": 1 } ] } ] } |
Exemplo de retorno
|
[ { "id": 466094, "tipoEvento": "211130", "dataRegistro": "2026-03-23T15:16:59", "chave": "35260712345678000195550010000012341000012345", "xmlRetorno": "<retEvento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infEvento><tpAmb>2</tpAmb><verAplic>SVRS2602051011</verAplic><cOrgao>43</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e vinculado a NF-e</xMotivo><chNFe>35260712345678000195550010000012341000012345</chNFe><tpEvento>211130</tpEvento><nSeqEvento>1</nSeqEvento><CNPJDest>12345678000195</CNPJDest><dhRegEvento>2026-03-23T15:16:59-03:00</dhRegEvento><nProt>143260000271410</nProt></infEvento></retEvento>", "codigoStatusEvento": "135", "motivoEvento": "Evento registrado e vinculado a NF-e", "nProtocolo": "143260000271410", "sucesso": true } ]
|
211140 - Registro de crédito com combustíveis
Descrição: evento utilizado para registrar a apropriação de créditos de IBS e CBS relacionados à aquisição de combustíveis informados na NF-e. O registro permite indicar os itens e quantidades de combustível que geram direito ao crédito, conforme as regras da Reforma Tributária do Consumo e da legislação tributária aplicável.
ü Método da API: POST
ü Endpoint: https://apidfe.systax.com.br/api/eventos/credito-combustivel
Campos da chamada
|
CAMPO |
DESCRIÇÃO |
|
numeroItem |
Número de ordem do item apresentado no XML, ao qual ocorreu o evento |
|
quantidadeCombustivel |
Quantidade do combustível consumido |
Exemplo de chamada
|
{ "eventos": [ { "chave": "35260712345678000195550010000012341000012345", "itens": [ { "numeroItem": 1, "quantidadeCombustivel": 1 } ] } ] }
|
Exemplo de retorno
|
[ { "id": 466093, "tipoEvento": "211140", "dataRegistro": "2026-03-23T15:04:52", "chave": "35260712345678000195550010000012341000012345", "xmlRetorno": "<retEvento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infEvento><tpAmb>2</tpAmb><verAplic>SVRS2602051011</verAplic><cOrgao>43</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e vinculado a NF-e</xMotivo><chNFe>35260712345678000195550010000012341000012345</chNFe><tpEvento>211140</tpEvento><nSeqEvento>1</nSeqEvento><CNPJDest>12345678000195</CNPJDest><dhRegEvento>2026-03-23T15:04:52-03:00</dhRegEvento><nProt>143260000271357</nProt></infEvento></retEvento>", "codigoStatusEvento": "135", "motivoEvento": "Evento registrado e vinculado a NF-e", "nProtocolo": "143260000271357", "sucesso": true } ]
|
211150 - Registro de Crédito de Bens e Serviços
Descrição: Evento utilizado para registrar a apropriação de créditos de IBS e CBS pelo adquirente, vinculados aos bens ou serviços informados na NF-e. O registro permite indicar os itens da operação que geram direito a crédito, conforme as regras da Reforma Tributária do Consumo e da legislação aplicável;
ü Método da API: POST
ü Endpoint: https://apidfe.systax.com.br/api/eventos/credito-bens-servicos
Campos da chamada:
|
CAMPO |
DESCRIÇÃO |
|
numerosItens |
Lista dos números dos itens da NF-e vinculados ao evento, indicando quais itens do documento fiscal geram direito à apropriação de crédito de IBS e CBS. |
Exemplo de chamada
|
{ "eventos": [ { "chave": "35260712345678000195550010000012341000012345", "numerosItens": [1, 2] } ] }
|
Exemplo de retorno
|
[ { "id": 466092, "tipoEvento": "211150", "dataRegistro": "2026-03-23T15:00:15", "chave": "35260712345678000195550010000012341000012345", "xmlRetorno": "<retEvento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infEvento><tpAmb>2</tpAmb><verAplic>SVRS2602051011</verAplic><cOrgao>43</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e vinculado a NF-e</xMotivo><chNFe>35260712345678000195550010000012341000012345</chNFe><tpEvento>211150</tpEvento><nSeqEvento>1</nSeqEvento><CNPJDest>12345678000195</CNPJDest><dhRegEvento>2026-03-23T15:00:15-03:00</dhRegEvento><nProt>143260000271336</nProt></infEvento></retEvento>", "codigoStatusEvento": "135", "motivoEvento": "Evento registrado e vinculado a NF-e", "nProtocolo": "143260000271336", "sucesso": true } ]
|
212110 - Manifestação sobre Pedido de Transferência de Crédito de IBS em Operações de Sucessão
Descrição: Evento utilizado para registrar a manifestação do contribuinte sucessor sobre o pedido de transferência de créditos de IBS decorrente de operações de sucessão empresarial, como fusão, incorporação, cisão ou extinção. Permite indicar o aceite ou não da transferência dos saldos credores, conforme as regras da Reforma Tributária do Consumo e da legislação tributária aplicável.
ü Método da API: POST
ü Endpoint: https://apidfe.systax.com.br/api/eventos/transferencia-credito-ibs
Campos da chamada
|
CAMPO |
DESCRIÇÃO |
|
indicadorAceitacao |
Indica se o contribuinte sucessor aceita ou rejeita o pedido de transferência de crédito em operação de sucessão. Valores: false = não aceite; true = aceite |
Exemplo de chamada
|
{ "eventos": [ { "chave": "35260712345678000195550010000012341000012345", "indicadorAceitacao": true } ] }
|
Exemplo de retorno
|
[ { "id": 475696, "tipoEvento": "212110", "dataRegistro": "2026-07-07T11:42:44", "chave": "35260712345678000195550010000012341000012345", "xmlRetorno": "<retEvento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infEvento><tpAmb>2</tpAmb><verAplic>SVRS2607061411</verAplic><cOrgao>33</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e vinculado a NF-e</xMotivo><chNFe>35260712345678000195550010000012341000012345</chNFe><tpEvento>212110</tpEvento><nSeqEvento>1</nSeqEvento><CNPJDest>12345678000195</CNPJDest><dhRegEvento>2026-07-07T11:42:44-03:00</dhRegEvento><nProt>333260000303737</nProt></infEvento></retEvento>", "codigoStatusEvento": "135", "motivoEvento": "Evento registrado e vinculado a NF-e", "nProtocolo": "333260000303737", "sucesso": true } ] |
212120 - Manifestação sobre Pedido de Transferência de Crédito de CBS em Operações de Sucessão
Descrição: Evento utilizado para registrar a manifestação do contribuinte sucessor sobre o pedido de transferência de créditos de CBS decorrente de operações de sucessão empresarial, como fusão, incorporação, cisão ou extinção. Permite indicar o aceite ou não da transferência dos saldos credores, conforme as regras da Reforma Tributária do Consumo e da legislação tributária aplicável.
ü Método da API: POST
ü Endpoint: https://apidfe.systax.com.br/api/eventos/transferencia-credito-cbs
Campos da chamada
|
CAMPO |
DESCRIÇÃO |
|
indicadorAceitacao |
Indica se o contribuinte sucessor aceita ou rejeita o pedido de transferência de crédito em operação de sucessão. Valores: false = não aceite; true = aceite |
Exemplo de chamada
|
{ "eventos": [ { "chave": "35260712345678000195550010000012341000012345", "indicadorAceitacao": true } ] } |
Exemplo de retorno
|
[ { "id": 475699, "tipoEvento": "212120", "dataRegistro": "2026-07-07T11:47:52", "chave": "35260712345678000195550010000012341000012345", "xmlRetorno": "<retEvento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infEvento><tpAmb>2</tpAmb><verAplic>SVRS2607061411</verAplic><cOrgao>33</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e vinculado a NF-e</xMotivo><chNFe>35260712345678000195550010000012341000012345</chNFe><tpEvento>212120</tpEvento><nSeqEvento>1</nSeqEvento><CNPJDest>12345678000195</CNPJDest><dhRegEvento>2026-07-07T11:47:52-03:00</dhRegEvento><nProt>333260000303746</nProt></infEvento></retEvento>", "codigoStatusEvento": "135", "motivoEvento": "Evento registrado e vinculado a NF-e", "nProtocolo": "333260000303746", "sucesso": true } ] |
Cancelamento do Evento de Apuração
110001 - Cancelamento de Evento
Descrição: Evento utilizado para cancelar um evento de apuração anteriormente registrado e vinculado à NF-e, quando houver necessidade de desfazer ou retificar a informação transmitida. O cancelamento deve referenciar o evento original e observar as regras e prazos aplicáveis, preservando a rastreabilidade do registro perante o ambiente fiscal.
ü Método da API: POST
ü Endpoint: https://apidfe.systax.com.br/api/eventos/cancelamento
Campos da chamada
|
CAMPO |
DESCRIÇÃO |
|
idEvento |
O campo idEvento deve corresponder ao identificador retornado pela API no registro do evento original. |
|
chave |
A chave informada na requisição de cancelamento deve corresponder à mesma NF-e vinculada ao evento que será cancelado. |
Exemplo de chamada
{
"eventos": [
{
"chave": "35260712345678000195550010000012341000012345",
"idEvento": "475699"
}
]
}
Exemplo de retorno
[
{
"id": 475702,
"tipoEvento": "110001",
"dataRegistro": "2026-07-07T11:59:16",
"chave": "35260712345678000195550010000012341000012345",
"xmlRetorno": "<retEvento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infEvento><tpAmb>2</tpAmb><verAplic>SVRS2607061411</verAplic><cOrgao>33</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e vinculado a NF-e</xMotivo><chNFe>35260712345678000195550010000012341000012345</chNFe><tpEvento>110001</tpEvento><nSeqEvento>1</nSeqEvento><CNPJDest>12345678000195</CNPJDest><dhRegEvento>2026-07-07T11:59:16-03:00</dhRegEvento><nProt>333260000303791</nProt></infEvento></retEvento>",
"codigoStatusEvento": "135",
"motivoEvento": "Evento registrado e vinculado a NF-e",
"nProtocolo": "333260000303791",
"sucesso": true
}
]
Boas práticas de integração
Recomenda-se que o sistema integrador armazene o identificador do evento, o protocolo de autorização, o código de status, o motivo do processamento e o XML de retorno. Essas informações são importantes para rastreabilidade, auditoria, conciliação fiscal e eventual cancelamento do evento.
Boas práticas sugeridas:
- validar a chave da NF-e antes do envio;
- armazenar o retorno completo da API;
- tratar individualmente cada item retornado no array;
- reenviar apenas eventos com falha;
- evitar duplicidade de envio;
- controlar o status de cada evento no sistema integrador;
- manter logs de requisição e resposta;
- observar os prazos legais e regras da Nota Técnica vigente.
Observações sobre prazos e regras legais
Os eventos de apuração devem observar os prazos, regras de validação, leiautes e tabelas oficiais definidos na Nota Técnica vigente da Reforma Tributária do Consumo. A Systax acompanha as atualizações legais para realizar os ajustes necessários na plataforma; no entanto, o controle e o cumprimento dos prazos de envio dos eventos são de responsabilidade do cliente usuário. Caso seja identificada alguma divergência ou atualização normativa não refletida no manual, recomenda-se informar a Systax para análise das publicações mais recentes.
Tratamento de erros
Orientação prática sobre o que fazer em cada cenário de erro:
Exemplo:
|
Situação |
Ação recomendada |
|
Token expirado |
Gerar novo token e reenviar a requisição. |
|
Campo obrigatório ausente |
Corrigir o payload antes de reenviar. |
|
Rejeição da SEFAZ |
Analisar codigoStatusEvento e motivoEvento. |
|
Evento duplicado |
Verificar se o evento já foi registrado anteriormente. |
|
Falha parcial em lote |
Reprocessar apenas os itens com sucesso = false. |
Consulta dos Eventos de Apuração registrados
Para consultar eventos de apuração que já foram registrados e acatados pelo ambiente fiscal, o sistema integrador deve utilizar o Web Service SOAP de Download de Eventos. Esse serviço deve ser acionado quando houver necessidade de recuperar o XML do evento, validar o protocolo retornado pela SEFAZ ou armazenar as informações do evento para fins de auditoria, conciliação fiscal e rastreabilidade.
A documentação técnica para consumo desse Web Service está disponível no manual de configuração do Download de Eventos: