Operações relacionadas ao SPED (Sistema Público de Escrituração Digital), ao SINTEGRA e ao FCI.
O que é o SPED
O SPED é um conjunto de obrigações acessórias eletrônicas utilizadas para padronizar, validar e transmitir informações fiscais das empresas aos órgãos governamentais, substituindo escriturações em papel.
A API é capaz de gerar automaticamente:
- SPED ICMS/IPI (EFD ICMS/IPI) – reúne operações e prestações que influenciam na apuração do ICMS e do IPI, incluindo entradas, saídas, inventário, apurações e ajustes fiscais.
- SPED PIS/COFINS (EFD Contribuições) – consolida operações relacionadas às contribuições de PIS e COFINS, abrangendo documentos fiscais, créditos, débitos e bases de cálculo.
O que é o SINTEGRA
O SINTEGRA (Sistema Integrado de Informações sobre Operações Interestaduais com Mercadorias e Serviços) é um arquivo magnético exigido por algumas UFs para informar operações de entrada e saída de mercadorias.
O que é o FCI
A FCI (Ficha de Conteúdo de Importação) é uma declaração obrigatória para mercadorias industrializadas com insumos importados, informando o percentual de conteúdo de importação utilizado na produção.
Fluxo assíncrono
A geração de arquivos SPED é assíncrona: o endpoint de geração retorna um código de processamento, que deve ser consultado posteriormente em outro endpoint para obter o arquivo finalizado. Isso permite processar grandes volumes sem bloquear a chamada original.
O que esta seção cobre
- Geração de arquivos SPED (ICMS/IPI e PIS/COFINS).
- Unificação de múltiplos arquivos SPED PIS/COFINS em um único arquivo.
- Recriação de arquivos SPED a partir de geração anterior.
- Download do arquivo SPED gerado.
- Geração de arquivo SINTEGRA.
- Geração de arquivo FCI.
Nota: O tempo de geração varia conforme o volume de documentos do período. A consulta posterior usando o código de processamento é obrigatória para recuperar o arquivo final.
Gerar Arquivo SPED
Inicia a geração de um arquivo SPED (ICMS/IPI ou PIS/COFINS) com base nos dados fiscais da empresa no período informado.
Como funciona na API
- O sistema valida e organiza as informações fiscais do período.
- Inicia a rotina de geração do arquivo SPED solicitado.
- Retorna um código de processamento indicando que o arquivo está sendo preparado.
- O cliente usa esse código no endpoint Obter Arquivo SPED para consultar o status e baixar o arquivo final quando pronto.
Quando usar
- Gerar o SPED periódico exigido pela legislação.
- Automatizar rotinas de escrituração fiscal.
- Integrar o SPED diretamente ao ERP, sem intervenções manuais.
Retorno
O endpoint não retorna o arquivo imediatamente. Retorna um identificador que, quando consultado posteriormente, entrega:
- O arquivo SPED ICMS/IPI (.txt) ou
- O arquivo SPED PIS/COFINS (.txt)
- Logs de processamento, caso haja erros.
Nota: O fluxo assíncrono e os tipos de SPED suportados estão descritos na visão geral da seção.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Gerar Arquivo SPED › Request Body
TipoArquivoTipo do arquivo EFD (Padrão 1).
Valores Possíveis:
1: SPED EFD FISCAL ICMS/IPI
2: SPED EFD CONTRIBUIÇÕES PIS/COFINS
CRTCódigo do regime tributável (Padrão 3).
Valores Possíveis:
1: Simples Nacional
2: Simples Nacional, excesso sublimite de receita bruta
3: Regime Normal
AmbienteNotasSaidasAmbiente de emissão das notas de saída (Padrão 1).
Valores Possíveis:
1: Ambiente de Produção
2: Ambiente de Homologação
IncluirNotasSaidasIndica se deve incluir notas de saídas no SPED (Padrão true).
DtInicioData de início do período do SPED.
DtFimData de fim do período do SPED.
Informações específicas para EFD ICMS/IPI.
Informações específicas para EFD Contribuições PIS/COFINS.
Lista de Documentos Fiscais Eletrônicos (DFes) a serem incluídos.
Dados do Contabilista responsável.
Lista de ajustes de impostos a serem aplicados aos itens.
Lista de faixas de numeração de documentos fiscais inutilizadas.
Gerar Arquivo SPED › Responses
Successful operation
StatusStatus do processamento.
Valores Possíveis:
1: Processado com sucesso
2: Em processamento
3: Erro no processamento
4: Não encontrado
CodigoCódigo único para consultar o status e o resultado do processamento.
RegistrosConteúdo do arquivo SPED (quando Status for 1).
UrlURL para visualização do processo no painel.
ErrorDescrição do erro, caso o Status seja 3.
AvisosLista de avisos não-bloqueantes do processamento (vazia em sucesso sem ressalvas).
Detalhes específicos do processamento fiscal.
Unificar Arquivo SPED
Este método realiza a unificação de múltiplos arquivos SPED PIS/COFINS (EFD Contribuições), permitindo consolidar diversos arquivos em um único resultado final.
Os arquivos podem ser informados de duas maneiras:
- Através dos códigos de processamento retornados por gerações anteriores.
- Fornecendo diretamente o conteúdo Base64 dos arquivos SPED individuais.
Como funciona o processamento
A operação é assíncrona. Ao iniciar a unificação, o serviço:
- Valida os arquivos fornecidos.
- Inicia a rotina de unificação.
- Retorna um código de processamento, que deve ser usado posteriormente para obter o resultado final.
Para que serve?
Este endpoint é útil para:
- Consolidar múltiplos arquivos SPED PIS/COFINS em um único arquivo.
- Agrupar escrituração de períodos fragmentados.
- Gerar um arquivo final padronizado para envio ao Fisco.
- Automatizar conciliações e retificações.
O que é retornado?
O endpoint não retorna o arquivo imediatamente. Em vez disso, ele entrega um identificador de processamento, que deve ser consultado em um endpoint de monitoramento para obter:
- O arquivo SPED PIS/COFINS unificado (.txt).
- Logs do processo, se houver falhas.
Nota: Este método é exclusivo para SPED PIS/COFINS (EFD Contribuições).
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Unificar Arquivo SPED › Request Body
CodigosLista de códigos de solicitações SPED geradas anteriormente que serão unificadas. Utilizado como identificador de referência para cada arquivo SPED unificado.
Base64SpedsLista com o conteúdo dos arquivos SPED em formato Base64 a serem unificados. O conteúdo deve ser o arquivo SPED completo codificado.
Unificar Arquivo SPED › Responses
Successful operation
StatusStatus do processamento.
Valores Possíveis:
1: Processado com sucesso
2: Em processamento
3: Erro no processamento
4: Não encontrado
CodigoCódigo único para consultar o status e o resultado do processamento.
RegistrosConteúdo do arquivo SPED (quando Status for 1).
UrlURL para visualização do processo no painel.
ErrorDescrição do erro, caso o Status seja 3.
AvisosLista de avisos não-bloqueantes do processamento (vazia em sucesso sem ressalvas).
Detalhes específicos do processamento fiscal.
Recriar Arquivo SPED
Este método permite recriar um arquivo SPED, reenfileirando um processo de geração que já foi concluído (Status 1). Ele é útil quando é necessário reprocessar os mesmos dados sem reenviar o payload original.
Ao utilizar este endpoint, o sistema recupera o JSON de envio utilizado na solicitação original e cria automaticamente uma nova solicitação de geração, iniciando um novo processamento assíncrono.
Quando usar?
Use este método quando for necessário:
- Regenerar um arquivo SPED a partir dos mesmos dados já enviados.
- Corrigir erros ou divergências na geração anterior sem montar um novo JSON.
- Reemitir o arquivo para auditoria, retificação ou testes internos.
- Gerar uma nova versão do SPED após ajustes no sistema de escrituração.
Como funciona
- Informe o código de processamento já concluído (Status 1).
- O sistema localiza o JSON original da solicitação.
- Uma nova solicitação é criada automaticamente.
- O endpoint retorna um novo código de processamento, que deve ser consultado no endpoint de busca de SPED.
O que é retornado?
- Um novo identificador de processamento (código).
- Informações complementares sobre o reprocessamento.
Nota: Este método não permite alterar os dados enviados anteriormente. Ele apenas replica a geração utilizando o mesmo conteúdo da solicitação original.
path Parameters
codigoCódigo da solicitação retornado pelos métodos GerarArquivoSped ou UnificarArquivoSped
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Recriar Arquivo SPED › Responses
Successful operation
StatusStatus do processamento.
Valores Possíveis:
1: Processado com sucesso
2: Em processamento
3: Erro no processamento
4: Não encontrado
CodigoCódigo único para consultar o status e o resultado do processamento.
RegistrosConteúdo do arquivo SPED (quando Status for 1).
UrlURL para visualização do processo no painel.
ErrorDescrição do erro, caso o Status seja 3.
AvisosLista de avisos não-bloqueantes do processamento (vazia em sucesso sem ressalvas).
Detalhes específicos do processamento fiscal.
Obter Arquivo SPED
Este método permite consultar o status e o resultado de uma solicitação de geração de arquivo SPED, seja uma geração individual (ICMS/IPI ou PIS/COFINS) ou uma geração unificada (exclusiva para SPED PIS/COFINS), utilizando o código de processamento retornado anteriormente.
Para que serve?
Use este endpoint para acompanhar solicitações assíncronas de geração de SPED, verificando:
- Se o processamento já foi concluído.
- Se houve erros ou pendências.
- Se o arquivo já está disponível para download.
O que é retornado?
Ao consultar o código de processamento, a resposta pode incluir:
- Status atual da solicitação (em processamento, concluído, erro, etc.).
- Mensagens de log informativas ou de falha.
- O arquivo SPED final, quando concluído, em formato Base64 (.txt).
- Informações complementares sobre a geração ou unificação.
Quando usar?
Este endpoint deve ser utilizado após iniciar:
- A geração de um SPED ICMS/IPI.
- A geração de um SPED PIS/COFINS.
- A unificação de arquivos SPED PIS/COFINS.
Funcionamento
- Você envia uma solicitação de geração ou unificação.
- O sistema retorna um código de processamento.
- Este endpoint é chamado repetidamente até que o arquivo esteja pronto.
- Quando concluído, retorna o SPED final ou os detalhes do erro.
Nota: Como o processamento pode levar tempo dependendo do volume de dados, recomenda-se consultar em intervalos regulares até que o arquivo esteja disponível.
path Parameters
codigoCódigo da solicitação retornado pelos métodos GerarArquivoSped ou UnificarArquivoSped
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Obter Arquivo SPED › Responses
Successful operation
StatusStatus do processamento.
Valores Possíveis:
1: Processado com sucesso
2: Em processamento
3: Erro no processamento
4: Não encontrado
CodigoCódigo único para consultar o status e o resultado do processamento.
RegistrosConteúdo do arquivo SPED (quando Status for 1).
UrlURL para visualização do processo no painel.
ErrorDescrição do erro, caso o Status seja 3.
AvisosLista de avisos não-bloqueantes do processamento (vazia em sucesso sem ressalvas).
Detalhes específicos do processamento fiscal.
Gerar Arquivo SINTEGRA
Este método gera o arquivo Sintegra com base nos documentos fiscais e no inventário informados. O processamento é síncrono, ou seja, o arquivo é retornado imediatamente após a conclusão da geração.
O que é o Sintegra?
O Sintegra (Sistema Integrado de Informações sobre Operações Interestaduais com Mercadorias e Serviços) foi um dos primeiros modelos de escrituração eletrônica adotados pelos estados brasileiros. O Sintegra ainda é exigido por alguns órgãos estaduais e por sistemas internos de auditoria.
O arquivo Sintegra consolida:
- Operações de entrada e saída de mercadorias.
- Inventário de estoque.
- Informações cadastrais e fiscais.
- Registros específicos para apuração estadual.
Como funciona o método
Ao chamar este endpoint:
- O sistema processa os documentos fiscais fornecidos.
- Inclui os dados de inventário quando enviados.
- Monta o arquivo Sintegra de acordo com o layout oficial.
- Retorna o arquivo final.
Quando usar?
Este método é útil para:
- Entregar obrigações estaduais que ainda exigem Sintegra.
- Gerar arquivos para sistemas de auditoria ou conciliação.
- Reprocessar dados fiscais de forma padronizada.
- Informações complementares usadas na geração.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Gerar Arquivo SINTEGRA › Request Body
DtInicioData de início do período para a geração do arquivo.
DtFimData final do período para a geração do arquivo.
CRTCódigo do regime tributável.
Valores Possíveis:
1: Simples Nacional
2: Simples Nacional, excesso sublimite de receita bruta
3: Regime Normal
CodIdConvenioCódigo de identificação da estrutura do arquivo magnético entregue.
Valores Possíveis:
1: Estrutura conforme Convênio ICMS 57/95, versão Convênio ICMS 31/99.
2: Estrutura conforme Convênio ICMS 57/95, versão Convênio ICMS 69/02.
3: Estrutura conforme Convênio ICMS 57/95, versão Convênio ICMS 76/03.
CodIdNaturezaOperacaoCódigo da identificação da natureza das operações informadas.
Valores Possíveis:
1: Interestaduais somente operações sujeitas ao regime de Substituição Tributária
2: Interestaduais - operações com ou sem Substituição Tributária
3: Totalidade das operações do informante
CodFinalidadeFinalidade da apresentação do arquivo magnético.
Valores Possíveis:
1: Normal
2: Retificação total de arquivo
3: Retificação aditiva de arquivo
5: Desfazimento
IncluirNotasSaidasIndica se deve incluir as notas de saídas emitidas no período.
Lista de Documentos Fiscais Eletrônicos (DFes).
Lista de itens do Inventário.
Gerar Arquivo SINTEGRA › Responses
Successful operation
CodigoCódigo de controle da requisição.
StatusIndica se a operação foi bem-sucedida.
RegistrosConteúdo do arquivo Sintegra gerado (geralmente em formato texto/base64, dependendo da implementação).
ErrorDescrição do erro, caso ocorra.
AvisosLista de avisos, caso existam.
Informações detalhadas sobre os valores totais dos documentos fiscais processados.
Gerar Arquivo FCI
Esta seção descreve o método para geração da Ficha de Conteúdo de Importação (FCI), um documento digital obrigatório para contribuintes do ICMS que industrializam produtos utilizando insumos importados em qualquer etapa da cadeia produtiva.
O que é a FCI?
A FCI identifica o percentual de conteúdo importado presente no produto final. Essa informação é essencial para a correta aplicação da alíquota interestadual de 4% do ICMS, conforme determina a Resolução nº 13/2012 do Senado Federal.
Finalidade
A FCI permite:
- Determinar de forma oficial o índice de conteúdo importado de cada produto.
- Atender à legislação que exige a indicação desse percentual na NF-e.
- Garantir o cálculo correto da alíquota interestadual de 4%.
Como funciona o processo
O método realiza:
- A montagem de um arquivo TXT contendo os produtos, valores totais, valores importados e demais informações exigidas.
- A preparação dos dados para envio ao sistema validador da SEFAZ.
- A geração de um arquivo pronto para transmissão.
Após o envio e validação do arquivo no sistema oficial, é gerado um número de controle da FCI, que deve ser informado obrigatoriamente nos campos específicos da Nota Fiscal Eletrônica (NF-e) referente aos produtos declarados.
Resultado
Este endpoint retorna o arquivo TXT estruturado conforme o layout oficial, pronto para ser transmitido e validado pelas autoridades fiscais.
Nota: A geração deste arquivo não realiza a transmissão para a SEFAZ. O arquivo deve ser enviado e validado no ambiente oficial para obtenção do número de controle da FCI.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Gerar Arquivo FCI › Request Body
ValidarCodigosQuando verdadeiro, retorna um erro se forem enviados produtos com códigos repetidos (Padrão - true).
Lista dos produtos a serem processados.
Gerar Arquivo FCI › Responses
Successful operation
StatusIndica se a operação foi bem-sucedida.
RegistrosConteúdo do arquivo FCI gerado.
ErrorDescrição do erro, caso ocorra.
AvisosLista de avisos, caso existam.

