Emitir NFe - Devolução via XML.

Permite a emissão de uma Nota Fiscal Eletrônica (NFe) de devolução utilizando como base o arquivo XML da nota de origem.

O recurso realiza a leitura do arquivo fornecido, correlaciona os itens para estorno e aplica as regras fiscais de devolução
conforme o regime tributário do emissor e a natureza da operação.

Este endpoint simplifica o processo de devolução ao extrair dados diretamente do XML original, exigindo apenas a relação de itens e quantidades a serem devolvidas.

⚠️ ATENÇÃO: O arquivo XML deve ser enviado em formato Base64. Certifique-se de que a nota de origem esteja autorizada na SEFAZ, pois chaves de acesso inexistentes ou canceladas impedirão a emissão.

⚙️ REGRA DE NEGÓCIO: Caso a devolução seja parcial, informe apenas os itens e quantidades correspondentes no objeto de itens. Para devolução total, a lista deve refletir exatamente o conteúdo da nota de origem.

🧪 TESTE: Em ambiente de homologação, as notas emitidas possuem sem valor jurídico e não afetam o estoque real ou limites fiscais junto à SEFAZ.

post

Headers

danfestring

Tipo de arquivo DANFE gerado na emissão.

Allowed values:HtmlPdfNenhum

tipoDanfeNfestring

Tipo de danfe para NFe.

Allowed values:RetratoSimplificado

DocumentoEmissorstringrequired

Documento do emissor.

Body

multipart/form-data
CodigoErpstringrequired

Identificador da operação fiscal no ERP.

>= 1 characters

Seriestring

Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).

NumeroDocumentointeger(int64)

Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).

ModeloDocumentoFiscalDevolvidostring

Modelo de nota fiscal.

Allowed values:NfeNfce

ArquivoXmlstringrequired

Arquivo XML da nota fiscal.

TipoEmissaostring

Tipo de emissão de NFe.

Allowed values:AutomaticaNormalContingenciaFsdaContingenciaSvcanContingenciaSvcrs

Destinatario.TipoDocumentostring

Tipo de documento.

Allowed values:CpfCnpjIdEstrangeiro

Destinatario.Documentostring

Documento do destinatário.

Destinatario.Nomestring

Nome do destinatário.

Destinatario.Endereco.Logradourostring

Logradouro.

Destinatario.Endereco.Numerostring

Número.

Destinatario.Endereco.Complementostring

Complemento.

Destinatario.Endereco.Bairrostring

Bairro.

Destinatario.Endereco.CodigoMunicipiostring

Código do município.

Destinatario.Endereco.NomeMunicipiostring

Nome do município.

Destinatario.Endereco.Ufstring

Lista de Unidades Federativas para Nota Fiscal incluíndo exterior.

Allowed values:ROACAMRRPAAPTOMAPICERNPBPEALSEBAMGESRJSPPRSCRSMSMTGODFEX

Destinatario.Endereco.Cepstring

CEP.

Destinatario.Endereco.CodigoPaisstring

Código do país.

Destinatario.Endereco.Paisstring

Nome do país.

Destinatario.Telefonestring

Telefone do destinatário.

Destinatario.InscricaoEstadualstring

Inscrição estadual do destinatário.

Destinatario.InscricaoSuframastring

Inscrição SUFRAMA.

Destinatario.InscricaoMunicipalstring

Inscrição municipal.

Destinatario.Emailstring

Email do destinatário.

AutXmlarray[object]

Documentos autorizados a capturar e visualizar a NFe.

* Additional properties are NOT allowed.
Show Child Parameters
ItensDevolvidosarray[object]

Dados de devolução do item da nota.

* Additional properties are NOT allowed.
Show Child Parameters

Response

OK

EmissaoNotaFiscalViewModel

Dados de retorno da emissão de nota fiscal.

* Additional properties are NOT allowed.
sucessoboolean

Indica se a nota foi autorizada pela sefaz ou não.

codigoStatusinteger(int32)

Código de status de envio para a sefaz.

mensagemSefazstring | null

Mensagem de retorno da sefaz.

seriestring | null

Série da nota fiscal.

numeroDocumentointeger(int64)

Número do documento.

chaveAcessostring | null

Chave de acesso da nota fiscal.

numeroProtocolostring | null

Número do protocolo de autorização da nota fiscal.

linkQrcodestring | null

Link de acesso a nota fiscal (Apenas para NFC-e).

danfestring | null

Arquivo DANFE solicitado (HTML ou PDF Base64).

emitidaEmContingenciaboolean

Indica se a nota foi emitida em modo contingência.

post/api/v1/Nfe/Xml/Devolucao/Emitir

Body

No file selected
 
Error initializing code snippet

Transmitir Contingência.

Realiza a transmissão de uma NFe que foi emitida previamente sob o regime de contingência offline.
Este recurso é essencial para regularizar a situação fiscal de documentos gerados sem comunicação prévia com a SEFAZ devido a problemas técnicos.

⚠️ ATENÇÃO: A transmissão deve ser realizada respeitando os prazos legais estabelecidos pelo ajuste SINIEF para evitar penalidades. Certifique-se de que os dados do XML transmitido são idênticos aos do documento entregue ao consumidor.

⚙️ PROCESSAMENTO: O sistema validará a assinatura digital e o status do documento antes de submeter o lote para autorização. Caso o documento já tenha sido autorizado anteriormente, o serviço retornará o protocolo existente.

post

Path Parameters

filtrostringrequired

Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

EmissaoNotaFiscalViewModel

Dados de retorno da emissão de nota fiscal.

* Additional properties are NOT allowed.
sucessoboolean

Indica se a nota foi autorizada pela sefaz ou não.

codigoStatusinteger(int32)

Código de status de envio para a sefaz.

mensagemSefazstring | null

Mensagem de retorno da sefaz.

seriestring | null

Série da nota fiscal.

numeroDocumentointeger(int64)

Número do documento.

chaveAcessostring | null

Chave de acesso da nota fiscal.

numeroProtocolostring | null

Número do protocolo de autorização da nota fiscal.

linkQrcodestring | null

Link de acesso a nota fiscal (Apenas para NFC-e).

danfestring | null

Arquivo DANFE solicitado (HTML ou PDF Base64).

emitidaEmContingenciaboolean

Indica se a nota foi emitida em modo contingência.

post/api/v1/Nfe/{filtro}/ContingenciaOffline/Transmitir
 

Listar NFe´s.

Fornece uma listagem detalhada das Notas Fiscais Eletrônicas (NFe) emitidas ou processadas pelo Emissor.

🔍 CAPACIDADE DE BUSCA: O recurso suporta filtros complexos que permitem a extração de relatórios e a reconciliação fiscal. O campo busca realiza uma varredura genérica em múltiplos campos (número, série, chave e participantes).

📑 PAGINAÇÃO: A API utiliza o modelo de offset e limit. Recomendamos o uso de limites baixos (ex: 50 registros) para garantir a performance da resposta e economia de banda.

⚖️ CONTEXTO FISCAL: Os resultados refletem o estado atual dos documentos na base da Stone Tax, permitindo filtrar por status específicos (Autorizada, Cancelada, Rejeitada, etc.) e intervalos de valores ou datas.

get

Query Parameters

notaFiscalIdstring(uuid)

Filtrar pelo identificador único da nota fiscal no sistema.

codigoErpstring

Filtrar pelo código ERP.

buscastring

Filtrar pelo termo de busca genérica.

inscricaoEstadualEmissorstring

Filtrar pela inscrição estadual do emissor do documento.

numeroDocumentostring

Filtrar pelo número sequencial do documento fiscal.

seriestring

Filtrar pela série do documento fiscal.

chaveAcessoarray[string]

Filtrar pel lista de chaves de acesso (44 dígitos).

documentoParticipantestring

Filtrar pelo documento (CPF/CNPJ) do participante.

nomeParticipantestring

Filtrar pel nome ou razão social do participante.

dataEmissaoInicialstring(date-time)

Filtrar documentos emitidos a partir desta data.

dataEmissaoFinalstring(date-time)

Filtrar documentos emitidos até esta data.

dataCancelamentoInicialstring(date-time)

Filtrar documentos cancelados a partir desta data.

dataCancelamentoFinalstring(date-time)

Filtrar documentos cancelados até esta data.

valorDocumentoInicialnumber(double)

Filtrar pelo valor mínimo do documento.

valorDocumentoFinalnumber(double)

Filtrar pel valor máximo do documento.

statusstring

Status do documento eletrônico.

Allowed values:PendenteAutorizadaCanceladaInutilizadaRejeitadaDenegadaEmCancelamentoEmContingenciaSubstituida

consumidorFinalboolean

Filtrar pelo indicador do documento emitido para consumidor final.

documentoTransportadorstring

Filtrar pelo documento (CPF/CNPJ) da transportadora.

nomeTransportadorstring

Filtrar pelo nome ou razão Social da transportadora.

modalidadeFretestring

Modalidade de frete.

Allowed values:CifFobFretePorContaDeTerceirosTransporteProprioRemetenteTransporteProprioDestinatarioSemOcorrenciaDeTransporte

documentoIntermediadorstring

Filtrar pelo documento (CPF/CNPJ) do intermediador.

identificadorIntermediadorstring

Filtrar pelo identificador do intermediador na plataforma.

modoContingenciaOfflineboolean

Filtrar por notas que foram geradas em modo de contingência offline, ou seja, sem comunicação com a SEFAZ no momento da emissão.

ordenarPorstring

Campo pelo qual a listagem de notas fiscais será ordenada.

Allowed values:DataEmissaoSerieNumeracaoNomeDestinatario

ordemDecrescenteboolean

Define se a ordenação é decrescente. Padrão: true.

Default:true

offsetinteger(int32)

Paginação da listagem - offset.

Default:1

limitinteger(int32)

Paginação da listagem - limit.

Default:10

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

ListarNotasFiscaisViewModelListPaginationResponse

* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]

Dados de listagem de notas fiscais eletrônicas (NFe e NFCe).

* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/Nfe/Listar
 

Resumo de NFe´s.

Fornece dados totalizados e consolidados de notas fiscais com base nos filtros aplicados.
Este recurso é ideal para alimentar dashboards, painéis de conferência ou indicadores financeiros (KPIs),
permitindo uma visão macro do volume de documentos e valores sem a necessidade de processar a listagem completa.

A consulta suporta múltiplos critérios de filtragem, abrangendo desde dados básicos do documento (número, série, chave)
até informações de atores envolvidos (participante, transportador e intermediador).

🔍 DICA DE PERFORMANCE: Para consultas em grandes volumes de dados, priorize o uso da Chave de Acesso
ou o intervalo de Data de Emissão para garantir maior agilidade no retorno.

get

Query Parameters

notaFiscalIdstring(uuid)

Filtrar pelo identificador único da nota fiscal no sistema.

codigoErpstring

Filtrar pelo código ERP.

buscastring

Filtrar pelo termo de busca genérica.

inscricaoEstadualEmissorstring

Filtrar pela inscrição estadual do emissor do documento.

numeroDocumentostring

Filtrar pelo número sequencial do documento fiscal.

seriestring

Filtrar pela série do documento fiscal.

chaveAcessoarray[string]

Filtrar pel lista de chaves de acesso (44 dígitos).

documentoParticipantestring

Filtrar pelo documento (CPF/CNPJ) do participante.

nomeParticipantestring

Filtrar pel nome ou razão social do participante.

dataEmissaoInicialstring(date-time)

Filtrar documentos emitidos a partir desta data.

dataEmissaoFinalstring(date-time)

Filtrar documentos emitidos até esta data.

dataCancelamentoInicialstring(date-time)

Filtrar documentos cancelados a partir desta data.

dataCancelamentoFinalstring(date-time)

Filtrar documentos cancelados até esta data.

valorDocumentoInicialnumber(double)

Filtrar pelo valor mínimo do documento.

valorDocumentoFinalnumber(double)

Filtrar pel valor máximo do documento.

statusstring

Status do documento eletrônico.

Allowed values:PendenteAutorizadaCanceladaInutilizadaRejeitadaDenegadaEmCancelamentoEmContingenciaSubstituida

consumidorFinalboolean

Filtrar pelo indicador do documento emitido para consumidor final.

documentoTransportadorstring

Filtrar pelo documento (CPF/CNPJ) da transportadora.

nomeTransportadorstring

Filtrar pelo nome ou razão Social da transportadora.

modalidadeFretestring

Modalidade de frete.

Allowed values:CifFobFretePorContaDeTerceirosTransporteProprioRemetenteTransporteProprioDestinatarioSemOcorrenciaDeTransporte

documentoIntermediadorstring

Filtrar pelo documento (CPF/CNPJ) do intermediador.

identificadorIntermediadorstring

Filtrar pelo identificador do intermediador na plataforma.

modoContingenciaOfflineboolean

Filtrar por notas que foram geradas em modo de contingência offline, ou seja, sem comunicação com a SEFAZ no momento da emissão.

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

ObterTotalizacaoListagemViewModel

Dados totalizados da listagem de notas fiscais.

* Additional properties are NOT allowed.
quantidadeTotalNotasinteger(int32)

Quantidade total de notas.

quantidadeTotalNotasAprovadasinteger(int32)

Quantidade total de notas aprovadas.

quantidadeTotalNotasCanceladasinteger(int32)

Quantidade total de notas canceladas, em cancelamento ou inutilizadas.

quantidadeTotalNotasRejeitadasinteger(int32)

Quantidade total de notas rejeitadas.

quantidadeTotalNotasPendentesinteger(int32)

Quantidade total de notas pendentes de emissão.

quantidadeTotalNotasEmContingenciainteger(int32)

Quantidade total de notas geradas em contingência pendentes de transmissão.

quantidadeTotalNotasSubstituidasinteger(int32)

Quantidade total de notas substituidas por nota em contingencia devido a timed out na emissão.

valorTotalNotasnumber(double)

Valor total em notas fiscais.

valorTotalNotasAprovadasnumber(double)

Valor total de notas aprovadas.

valorTotalNotasCanceladasnumber(double)

Valor total de notas canceladas, em cancelamento ou inutilizadas.

valorTotalNotasRejeitadasnumber(double)

Valor total de notas rejeitadas.

valorTotalNotasPendentesnumber(double)

Valor total de notas pendentes de emissão.

valorTotalNotasEmContingencianumber(double)

Valor total de notas geradas em contingência pendentes de transmissão.

valorTotalNotasSubstituidasnumber(double)

Valor total de notas substituidas por nota em contingencia devido a timed out na emissão.

get/api/v1/Nfe/Resumo
 

Status da NFe.

Retorna o status de uma nota fiscal identificada pelo código ERP ou chave de acesso.

🔍 IDENTIFICAÇÃO: O filtro aceita a chave de acesso da nota fiscal (44 dígitos numéricos) ou o código ERP informado pelo integrador no momento da emissão.

📋 RETORNO: Inclui modelo, série, número, chave de acesso, status, protocolos de autorização/cancelamento e mensagem da SEFAZ.

get

Path Parameters

filtrostringrequired

Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

ObterStatusFiscalViewModel

Dados fiscais de uma nota fiscal identificada pelo código ERP.

* Additional properties are NOT allowed.
codigoErpstring | null

Identificador da operação fiscal no ERP.

modelostring

Modelo de nota fiscal.

Allowed values:NfeNfce

seriestring | null

Série do documento fiscal.

numeroDocumentointeger(int64)

Número do documento fiscal.

chaveAcessostring | null

Chave de acesso do documento fiscal.

dataEmissaostring(date-time)

Data de emissão do documento fiscal.

naturezaOperacaostring | null

Natureza da operação.

tipoAmbientestring

Tipo de ambiente da SEFAZ.

Allowed values:ProducaoHomologacao

statusstring

Status do documento eletrônico.

Allowed values:PendenteAutorizadaCanceladaInutilizadaRejeitadaDenegadaEmCancelamentoEmContingenciaSubstituida

ultimoCstatinteger | null(int32)

Último código de status retornado pela sefaz.

mensagemSefazstring | null

Última mensagem retornada pela SEFAZ.

qrcodeLinkstring | null

Link do QR Code da NFC-e.

protocoloAutorizacaostring | null

Protocolo de autorização emitido pela SEFAZ.

protocoloCancelamentostring | null

Protocolo de cancelamento emitido pela SEFAZ.

get/api/v1/Nfe/{filtro}/StatusFiscal