Status da NFS-e.
Retorna o status de uma nota fiscal de serviço identificada pelo filtro.
🔍 IDENTIFICAÇÃO: O filtro aceita a ChaveNfse ou o Código ERP informado pelo integrador no momento da emissão.
📋 RETORNO: Inclui série, número da DPS, número da NFS-e, chaves, status, protocolo de autorização e mensagem do ADN.
get
Path Parameters
filtrostringrequired
ChaveNfse ou Código ERP.
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Response
Response
OK
ObterStatusFiscalNfseViewModel
Dados fiscais de uma nota fiscal de serviço identificada pelo filtro.
* Additional properties are NOT allowed.
codigoErpstring | null
Identificador da operação fiscal no ERP.
seriestring | null
Série da DPS.
numeroDpsinteger(int64)
Número sequencial da DPS.
numeroNfseinteger | null(int64)
Número sequencial da NFS-e gerado pelo ADN após autorização.
chaveNfsestring | null
Chave de acesso da NFS-e.
dataEmissaostring(date-time)
Data de emissão da DPS.
dataCompetenciastring | null
Mês de competência da prestação do serviço (formato “AAAA-MM”).
tipoAmbientestring
Tipo de ambiente da SEFAZ.
Allowed values:ProducaoHomologacao
statusstring
Status da nota fiscal de serviço.
Allowed values:PendenteAutorizadaCanceladaRejeitadaEmCancelamentoSubstituidaInutilizada
ultimoCstatinteger | null(int32)
Último código de status retornado pela sefaz.
mensagemSefazstring | null
Última mensagem retornada pelo ADN.
protocoloAutorizacaostring | null
Protocolo de autorização emitido pelo ADN.
get/api/v1/Nfse/{filtro}/StatusFiscal
Authentication
Path Parameters
Headers
DANFE NFS-e (PDF).
Recupera a representação gráfica da NFS-e, conhecida como DANFE (Documento Auxiliar da Nota Fiscal de Serviços Eletrônica).
📄 FORMATO DE SAÍDA: O recurso retorna o arquivo em formato PDF, codificado em Base64. Para a visualização, o sistema consumidor deve realizar o decode da string e salvar o binário com a extensão .pdf.
🔍 DISPONIBILIDADE: O documento só poderá ser obtido para notas com status Autorizada, Em Cancelamento ou Substituída.
O campo filtro aceita ChaveNfse ou Código ERP.
get
Path Parameters
filtrostringrequired
ChaveNfse ou Código ERP.
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Response
Response
OK
string
get/api/v1/Nfse/{filtro}/ObterDanfe
Authentication
Path Parameters
Headers
Obter XML da NFS-e.
Retorna o XML mais relevante para o status atual da nota fiscal de serviço:
- Pendente / Rejeitada: XML da DPS assinada.
- Autorizada / Em Cancelamento / Substituída: XML da NFS-e retornado pelo ADN.
- Cancelada: XML do evento de cancelamento.
O campo filtro aceita ChaveNfse ou Código ERP.
get
Path Parameters
filtrostringrequired
ChaveNfse ou Código ERP.
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Response
Response
OK
string
get/api/v1/Nfse/{filtro}/ObterXml
Authentication
Path Parameters
Headers
DocumentoFiscal
Controlador de Serviços de Documentos Fiscais da Stone Tax API.
Atua como uma camada de apoio e auditoria, fornecendo recursos para a gestão de artefatos
e rastreabilidade operacional de documentos fiscais eletrônicos (NF-e, NFC-e, NFS-e, etc).
Esta controller centraliza funcionalidades genéricas que permitem a extração de XMLs em massa
e a consulta ao histórico completo de eventos (como autorizações, cancelamentos e correções)
processados pela plataforma, garantindo conformidade técnica e fiscal.
Todos os recursos operam sob o contexto do Emissor informado no cabeçalho,
permitindo que o sistema consumidor monitore o ciclo de vida dos documentos e recupere dados históricos para fins contábeis.
Download de XMLs - Solicitar.
Inicia o processo de geração e recuperação de arquivos XML das notas fiscais de forma assíncrona.
Devido ao volume de dados, a requisição não retorna os arquivos imediatamente, mas sim um identificador de solicitação.
⚠️ ATENÇÃO: O ticket (ID) retornado deve ser utilizado posteriormente no endpoint de consulta de status para verificar se o pacote de arquivos já está disponível para download.
⚙️ PROCESSAMENTO: O tempo de geração pode variar conforme o intervalo de datas e a quantidade de documentos filtrados. Recomenda-se evitar solicitações com intervalos superiores a 30 dias para otimizar a performance.
📅 RESTRIÇÃO DE PERÍODO: O sistema processa solicitações com um intervalo máximo de 90 dias entre a data inicial e final. Solicitações que excedam este limite retornarão erro de validação.
📂 CONTEÚDO: O arquivo final será disponibilizado em formato compactado (.zip) contendo os XMLs autorizados que atendam aos critérios informados.
post
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Body
Body
Filtros e critérios para a extração dos arquivos XML.
SolicitarDownloadXmlInputModel
Filtros solicitados para download de arquivos xmls.
* Additional properties are NOT allowed.
dataIniciostring(date)required
Filtrar pela data de emissão da nota “a partir de”.
>= 1 characters
Example:2025-03-31
dataFimstring(date)required
Filtrar pela data de emissão da nota “até”.
>= 1 characters
Example:2025-03-31
inscricaoEstadualstring | null
Filtrar pela inscrição estadual do emissor da nota fiscal.
buscastring | null
Filtro de busca genérica (dados do destinatário, transportador, chave de acesso, intermediador ou número do documento).
modelosDocumentoarray | null[string]
Modelo de documentos solicitados para download.
Allowed values:NfeNfce
urlCallbackstring | null
URL de callback para disparar notificação após conclusão do processamento da solicitação.
Response
Response
OK
string(uuid)
post/api/v1/DocumentoFiscal/DownloadXml/Solicitar
Authentication
Headers
Body
{
"dataInicio": "2025-03-31",
"dataFim": "2025-03-31"
}