Stone Tax API

Cancelar NFS-e.

Inicia o processo de cancelamento de uma Nota Fiscal de Serviços Eletrônica (NFS-e) junto ao ADN.

⚠️ RESTRIÇÕES: Somente NFS-e com status Autorizada podem ser canceladas.

O campo filtro aceita ChaveNfse ou Código ERP.

post

Path Parameters

filtrostringrequired

ChaveNfse ou Código ERP.

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Body

Dados para o cancelamento da nota fiscal de serviço.

CancelarNotaFiscalInputModel

Dados para cancelamento de nota fiscal (NFe ou NFCe).

* Additional properties are NOT allowed.
justificativastringrequired

Justificativa do cancelamento. (Mínimo de 15 caracteres)

>= 15 characters<= 255 characters

Response

No Content

post/api/v1/Nfse/{filtro}/Cancelar

Body

{ "justificativa": "justificativa" }
 

Listar NFSe´s.

Fornece uma listagem detalhada das Notas Fiscais de Serviços Eletrônicas (NFSe Nacional) 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 da DPS, chave, nome e documento do tomador e prestador, descrição do serviço).

📑 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

notaFiscalServicoIdstring(uuid)

Filtrar pelo identificador único da nota fiscal de serviço no sistema.

codigoErpstring

Filtrar pelo código ERP.

buscastring

Filtrar pelo termo de busca genérica.

numeroDpsstring

Filtrar pelo número sequencial da DPS.

seriestring

Filtrar pela série da DPS.

chavesarray[string]

Filtrar pela lista de chaves (ChaveDps — 45 chars, ou ChaveNfse — 53 chars).

documentoTomadorstring

Filtrar pelo documento (CPF/CNPJ) do tomador do serviço.

nomeTomadorstring

Filtrar pelo nome ou razão social do tomador do serviço.

documentoPrestadorstring

Filtrar pelo documento (CPF/CNPJ) do prestador do serviço.

nomePrestadorstring

Filtrar pelo nome ou razão social do prestador do serviço.

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.

valorServicoInicialnumber(double)

Filtrar pelo valor mínimo do serviço.

valorServicoFinalnumber(double)

Filtrar pelo valor máximo do serviço.

statusstring

Status da nota fiscal de serviço.

Allowed values:PendenteAutorizadaCanceladaRejeitadaEmCancelamentoSubstituidaInutilizada

ordenarPorstring

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

Allowed values:DataEmissaoSerieNumeracaoNomeTomador

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

ListarNotasFiscaisServicoViewModelListPaginationResponse

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

Dados de listagem de notas fiscais de serviço eletrônicas (NFS-e Nacional).

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

Resumo de NFSe´s.

Fornece dados totalizados e consolidados de notas fiscais de serviço 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.

Os totais são agrupados por status: Aprovadas, Canceladas, Rejeitadas, Pendentes e Substituídas.

get

Query Parameters

notaFiscalServicoIdstring(uuid)

Filtrar pelo identificador único da nota fiscal de serviço no sistema.

codigoErpstring

Filtrar pelo código ERP.

buscastring

Filtrar pelo termo de busca genérica.

numeroDpsstring

Filtrar pelo número sequencial da DPS.

seriestring

Filtrar pela série da DPS.

chavesarray[string]

Filtrar pela lista de chaves (ChaveDps — 45 chars, ou ChaveNfse — 53 chars).

documentoTomadorstring

Filtrar pelo documento (CPF/CNPJ) do tomador do serviço.

nomeTomadorstring

Filtrar pelo nome ou razão social do tomador do serviço.

documentoPrestadorstring

Filtrar pelo documento (CPF/CNPJ) do prestador do serviço.

nomePrestadorstring

Filtrar pelo nome ou razão social do prestador do serviço.

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.

valorServicoInicialnumber(double)

Filtrar pelo valor mínimo do serviço.

valorServicoFinalnumber(double)

Filtrar pelo valor máximo do serviço.

statusstring

Status da nota fiscal de serviço.

Allowed values:PendenteAutorizadaCanceladaRejeitadaEmCancelamentoSubstituidaInutilizada

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

ObterTotalizacaoListagemNfseViewModel

Dados totalizados da listagem de notas fiscais de serviço (NFS-e Nacional).

* Additional properties are NOT allowed.
quantidadeTotalNotasinteger(int32)

Quantidade total de notas.

quantidadeTotalNotasAprovadasinteger(int32)

Quantidade total de notas autorizadas.

quantidadeTotalNotasCanceladasinteger(int32)

Quantidade total de notas canceladas.

quantidadeTotalNotasRejeitadasinteger(int32)

Quantidade total de notas rejeitadas.

quantidadeTotalNotasPendentesinteger(int32)

Quantidade total de notas pendentes de emissão.

quantidadeTotalNotasSubstituidasinteger(int32)

Quantidade total de notas substituídas por nova emissão.

valorTotalNotasnumber(double)

Valor total em notas fiscais de serviço.

valorTotalNotasAprovadasnumber(double)

Valor total de notas autorizadas.

valorTotalNotasCanceladasnumber(double)

Valor total de notas canceladas.

valorTotalNotasRejeitadasnumber(double)

Valor total de notas rejeitadas.

valorTotalNotasPendentesnumber(double)

Valor total de notas pendentes de emissão.

valorTotalNotasSubstituidasnumber(double)

Valor total de notas substituídas por nova emissão.

get/api/v1/Nfse/Resumo
 

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

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
 

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

OK

string
get/api/v1/Nfse/{filtro}/ObterDanfe