DANFE NFCe (PDF).

Recupera a representação gráfica da NFCe, conhecida como DANFE (Documento Auxiliar da Nota Fiscal 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.

⚖️ VALIDADE JURÍDICA: O DANFE é apenas um documento auxiliar para facilitar a consulta e o transporte das mercadorias. Ele não substitui o arquivo XML, que é o documento fiscal eletrônico de existência apenas digital e valor jurídico real.

🧪 TESTE: Em ambiente de sandbox, o DANFE gerado conterá a marca d’água “SEM VALOR FISCAL - AMBIENTE DE HOMOLOGAÇÃO”, conforme exigência da SEFAZ para testes.

🔍 DISPONIBILIDADE: O documento só poderá ser gerado para chaves de acesso que possuam o status de Autorizada ou Cancelada na base de dados.

get

Path Parameters

tipoDanfestringrequired

Tipo de danfe para NFCe.

Allowed values:Danfe56mmDanfe80mm

formatostringrequired

Formato do DANFE

Allowed values:HtmlPdf

filtrostringrequired

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

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

string
get/api/v1/Nfce/{filtro}/ObterDanfe/{tipoDanfe}/{formato}
 

Obter XML (procNFCe).

Recupera o arquivo XML de distribuição da nota fiscal de consumidor eletrônica. Este é o documento oficial com validade jurídica, contendo o protocolo de autorização da SEFAZ.

⚖️ GUARDA FISCAL: Conforme a legislação vigente, o emitente e o destinatário devem manter os arquivos digitais das NF-e/NFCe pelo prazo decadencial estabelecido na lei tributária (geralmente 5 anos), sendo este endpoint a ferramenta ideal para o download e arquivamento.

🛠️ ESTRUTURA: O retorno consiste no XML completo, incluindo as tags de assinatura digital e o nó protNFe (Protocolo de Autorização), caracterizando o documento como processado e apto para a escrituração contábil.

🧪 TESTE: Em ambiente de homologação, o XML retornado possui as tags de ambiente identificadas como tpAmb = 2, indicando que o documento não possui validade comercial ou fiscal.

get

Path Parameters

filtrostringrequired

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

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

string
get/api/v1/Nfce/{filtro}/ObterXml
 

Cancelamento de NFCe.

Registra um Evento de Cancelamento para uma nota fiscal de consumidor eletrônica (NFCe). Esta operação invalida a existência jurídica do documento perante a SEFAZ.

⚠️ NOTAS REJEITADAS: Caso o documento fiscal esteja com status de Rejeitado, o processo de cancelamento nesta API acionará automaticamente a Inutilização de Numeração. Isso garante que a sequência numérica do emissor permaneça íntegra e em conformidade com as normas da SEFAZ, evitando “buracos” na numeração fiscal.

⏳ PRAZO LEGAL: O cancelamento deve respeitar o prazo regulamentar definido pela legislação estadual vigente (geralmente 24h para NF-e). Após este período, a operação poderá exigir procedimentos administrativos ou estar sujeita a penalidades por cancelamento extemporâneo.

📄 CONDIÇÃO DE USO: Só é possível cancelar uma nota que tenha sido Autorizada ou Rejeitada (via inutilização), e cujo Fato Gerador (saída da mercadoria) ainda não tenha ocorrido.

🧪 TESTE: Em ambiente de homologação, o cancelamento é processado junto aos servidores de teste, permitindo validar a estrutura da justificativa (mínimo 15 caracteres) e o comportamento da inutilização para números rejeitados.

post

Path Parameters

filtrostringrequired

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

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Body

Dados para o cancelamento da nota fiscal.

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/Nfce/{filtro}/Cancelar

Body

{ "justificativa": "justificativa" }
 

Nfse

Controlador de Notas Fiscais de Serviço Eletrônicas (NFSe) da Stone Tax API.

Centraliza os recursos destinados à emissão, cancelamento e gestão de notas fiscais de serviços (NFSe).
Fornece abstrações para simplificar a complexidade de comunicação com as Secretarias da Fazenda (SEFAZ).

Através desta controller, é possível gerenciar todo o ciclo de vida de um documento fiscal: desde a emissão até a obtenção de artefatos finais como o XML e o DANFE.

Operações de escrita (emissão/cancelamento) exigem assinatura digital e observância ao contexto do
Emissor configurado, garantindo a validade jurídica perante o Fisco.

Emitir NFS-e - Modo Prestador.

Realiza a emissão completa de uma Nota Fiscal de Serviços Eletrônica (NFS-e) junto ao ADN (Ambiente de Desenvolvimento Nacional), atuando o emissor como o prestador do serviço.

O recurso assegura que o contexto tributário do prestador seja validado e que as regras fiscais do município correspondente sejam aplicadas durante a emissão do documento.

O processo segue o fluxo:

  1. Geração e assinatura digital do XML da DPS (Declaração de Prestação de Serviços).

  2. Persistência com status Pendente.

  3. Transmissão ao ADN e atualização do status para Autorizada ou Rejeitada.

🔁 IDEMPOTÊNCIA: O campo codigoErp identifica a nota unicamente por emissor. Em caso de reenvio (nota Pendente ou Rejeitada), os dados são atualizados e a DPS é retransmitida sem duplicar registros.

⚙️ SEQUÊNCIA: A série e o número da DPS são gerenciados automaticamente com base nos parâmetros de NFS-e configurados para o emissor. Para sequência manual, informe serie e numeroDps.

⚠️ ATENÇÃO: Certifique-se de que o documento do emissor configurado no cabeçalho corresponda ao perfil tributário do prestador do serviço antes de efetuar a chamada.

post

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Body

Dados para emissão da NFS-e.

EmitirNfseModoPrestadorInputModel

Dados para emissão de uma Nota Fiscal de Serviço Eletrônica (NFS-e) no modo prestador.

* Additional properties are NOT allowed.
codigoErpstringrequired

Código de identificação interno do ERP do cliente. Utilizado para idempotência e reemissão.

>= 1 characters<= 60 characters

seriestring | null

Série da DPS (até 5 dígitos numéricos). Informar somente quando a sequência for manual.

numeroDpsinteger | null(int64)

Número sequencial da DPS (nDPS). Informar somente quando a sequência for manual.

dataCompetenciastring | null

Mês de competência da prestação do serviço no formato “AAAA-MM”.
Deve ser igual ou anterior ao mês de emissão.
Quando não informado, assume o mês/ano atual.

substituicaoobject

Dados da NFS-e substituída (subst).

* Additional properties are NOT allowed.
Show Child Parameters
tomadorobjectrequired

Dados do tomador de serviços (toma).

* Additional properties are NOT allowed.
Show Child Parameters
servicoobjectrequired

Dados do serviço prestado (serv).
Informar CodigoMunicipioLocalizacao (nacional) OU CodigoPaisLocalizacao (exterior), nunca ambos.

* Additional properties are NOT allowed.
Show Child Parameters
valoresobjectrequired

Valores do serviço prestado e tributação ISSQN para NFS-e no modo prestador.

* Additional properties are NOT allowed.
Show Child Parameters
ibsCbsobject

Dados de tributação do IBS (Imposto sobre Bens e Serviços) e CBS (Contribuição sobre Bens e Serviços)
da reforma tributária para a NFS-e. Obrigatório para Lucro Real e Lucro Presumido; opcional para Simples Nacional e MEI.

* Additional properties are NOT allowed.
Show Child Parameters

Response

OK

EmissaoNotaFiscalServicoViewModel

Dados de retorno da emissão de Nota Fiscal de Serviço Eletrônica (NFS-e).

* Additional properties are NOT allowed.
sucessoboolean

Indica se a NFS-e foi autorizada pelo ADN.

codigoStatusinteger(int32)

Código de status retornado pelo ADN.

mensagemSefazstring | null

Mensagem de retorno do ADN.

seriestring | null

Série da DPS emitida.

numeroDpsinteger(int64)

Número sequencial da DPS.

numeroNfseinteger | null(int64)

Número sequencial da NFS-e gerado pelo ADN. Disponível após autorização.

chaveNfsestring | null

Chave da NFS-e. Disponível após autorização.

alertasarray | null[object]

Mensagem de processamento retornada pelo ADN.

* Additional properties are NOT allowed.
Show Child Parameters
errosarray | null[object]

Mensagem de processamento retornada pelo ADN.

* Additional properties are NOT allowed.
Show Child Parameters
post/api/v1/Nfse/Prestador/Emitir

Body

{ "codigoErp": "codigoErp", "tomador": { "documento": "documento", "nome": "nome", "endereco": {} }, "servico": { "codigoServicoCtn": "codigoServicoCtn", "descricaoServico": "descricaoServico", "codigoNbs": "codigoNbs" }, "valores": { "valorServico": 0 } }