NFS-e
Consultar NFS-e recebida
Detalhe de uma NFS-e recebida: partes, valores, origem, links e a manifestação desta empresa.
/openapi/v2/empresas/{empresaId}/nfse/recebidas/{chaveAcesso}token, timestamp e sign, veja Autenticação.Devolve uma nota de serviço em que esta empresa é tomadora ou intermediária, pela chave de acesso. A resposta tem a mesma forma dos itens de NFS-e recebidas e ainda traz o array eventos, que os itens da lista não trazem. Para registrar uma manifestação use Manifestar sobre NFS-e recebida. Uma chave que não está entre as recebidas desta empresa devolve 404.
Parâmetros de caminho
empresaId* | string | Identificador da empresa |
chaveAcesso* | string | Chave de acesso |
* Campo obrigatório
chaveAcesso | string | Chave de acesso |
numero | int | Número da NFS-e |
codigoVerificacao | string | Código de verificação |
status | string | Status do documento |
papel | string | Papel desta empresa |
origem | string | Origem da linha |
dataEmissao | string | Data de emissão |
dataAutorizacao | string | Data de autorização |
competencia | string | Competência |
| object | Prestador |
| object | Tomador do serviço |
| object | Intermediário |
codigoTributacaoNacional | string | Código nacional do serviço |
discriminacao | string | Descrição do serviço |
valorServico | number | Valor do serviço |
valorLiquido | number | Valor líquido |
valorIss | number | Valor do ISS |
issRetido | bool | ISS retido |
chaveSubstituida | string | Chave da nota substituída |
chaveSubstituta | string | Chave da nota substituta |
dataUltimoEvento | string | Último evento |
dataRecebimento | string | Momento do recebimento |
| object | Manifestação desta empresa |
linkXml | string | Link do XML oficial |
linkDanfse | string | Link da DANFSe |
| array | Eventos da nota |
As notas recebidas chegam pela distribuição nacional. Uma empresa de São Paulo tem uma segunda fonte: depois de cada sincronização a plataforma também busca no sistema municipal de São Paulo as notas que esta empresa recebeu, e elas ficam visíveis antes de a transcrição nacional chegar. Uma linha PrefeituraSP vira `ADN` sozinha quando a transcrição chega, sem gerar uma segunda linha; nesse momento chaveAcesso troca a chave temporária pela oficial e os links passam a ser o original nacional e a DANFSe. Use prestador.cpfCnpj + numero como identificador estável entre sincronizações e nunca trate a chave temporária como chave primária permanente.
Linha vinda da distribuição nacional
A forma definitiva: chave oficial, original em layout nacional e DANFSe disponíveis.
{"chaveAcesso": "35503082406730610001340000000000000000000000000077","numero": 77,"codigoVerificacao": null,"origem": "ADN","prestador": { "cpfCnpj": "40673061000134" },"linkXml": "https://api.v2.tffiscal.com/openapi/files/xml/9101?token=...","linkDanfse": "https://api.v2.tffiscal.com/openapi/files/danfse/35503082406730610001340000000000000000000000000077?token=..."}
origem* | string | Origem |
chaveAcesso* | string | Chave oficial |
* Campo obrigatório
Linha vinda direto do sistema de São Paulo
Só para empresas de São Paulo, antes da fusão. A chave temporária é 3550308 + 0 + o CNPJ do prestador com 14 dígitos + o número da nota preenchido com zeros à esquerda até 28 dígitos, reconhecível pelo 0 na posição 8; ela funciona nos caminhos de detalhe e de manifestação. linkXml aponta para o original do sistema municipal e linkDanfse ainda é null.
{"chaveAcesso": "35503080406730610001340000000000000000000000000077","numero": 77,"codigoVerificacao": "A1B2C3D4","origem": "PrefeituraSP","prestador": { "cpfCnpj": "40673061000134" },"linkXml": "https://api.v2.tffiscal.com/openapi/files/xml/9099?token=...","linkDanfse": null}
origem* | string | Origem |
chaveAcesso* | string | Chave temporária |
codigoVerificacao* | string | Código de verificação municipal |
* Campo obrigatório
O status da nota recebida continua sendo Autorizada / Cancelada / Substituida; a manifestação desta empresa fica separada no bloco manifestacao, e cada parte manifesta uma única vez por nota, enquanto ela estiver Autorizada. O significado de cada estado está na enumeração.
(sem manifestação, filtro Pendente) ──┬──► Confirmada├──► Rejeitada ──► RejeicaoAnulada└──► ConfirmacaoTacita
statusStatus do documento
| Valores | Significado |
|---|---|
| Autorizada | Válida na autoridade |
| Cancelada | Cancelada pelo prestador ou de ofício pelo município |
| Substituida | Substituída por outra nota; chaveSubstituta traz a nova chave |
papelPapel desta empresa
| Valores | Significado |
|---|---|
| Tomador | Tomador do serviço; manifesta com 203202 (confirmação) ou 203206 (rejeição) |
| Intermediario | Intermediário do serviço; manifesta com 204203 (confirmação) ou 204207 (rejeição) |
origemOrigem da linha
| Valores | Significado |
|---|---|
| ADN | Distribuída pela distribuição nacional |
| PrefeituraSP | Buscada direto no sistema municipal de São Paulo; só empresas de São Paulo; vira ADN quando a transcrição chega |
manifestacao.statusEstado da manifestação
null no campo significa sem manifestação; no filtro da lista esse caso é Pendente.
| Valores | Significado |
|---|---|
| Confirmada | Confirmada por esta empresa (203202 / 204203); terminal |
| Rejeitada | Rejeitada por esta empresa (203206 / 204207); o município ainda pode anular |
| ConfirmacaoTacita | Confirmação tácita do município por falta de manifestação no prazo (205204); terminal |
| RejeicaoAnulada | O município anulou a rejeição desta empresa (205208); terminal |
manifestacao.codigoEventoCódigo do evento de manifestação
| Valores | Significado |
|---|---|
| 203202 | Confirmação pelo tomador |
| 204203 | Confirmação pelo intermediário |
| 203206 | Rejeição pelo tomador |
| 204207 | Rejeição pelo intermediário |
| 205204 | Confirmação tácita pelo município |
| 205208 | Rejeição anulada pelo município |
manifestacao.codigoMotivoCódigo do motivo da rejeição
| Valores | Significado |
|---|---|
| 1 | Nota em duplicidade |
| 2 | O tomador já emitiu a nota por conta própria |
| 3 | O fato gerador não ocorreu, o serviço não foi prestado |
| 4 | Parte responsável errada |
| 5 | Valor ou dados incorretos |
| 9 | Outros; explique em motivo |
eventos[].tipoTipo do evento
A lista acompanha os eventos oficiais e pode crescer.
| Valores | Significado |
|---|---|
| Cancelamento | Cancelamento registrado pelo prestador (101101) |
| CancelamentoPorSubstituicao | Cancelada por ter sido substituída por outra nota (105102) |
| PedidoAnalise | Pedido de análise fiscal de cancelamento (101103) |
| AnaliseDeferida | Município deferiu o cancelamento (105104) |
| AnaliseIndeferida | Município indeferiu o cancelamento (105105) |
| CancelamentoDeOficio | Cancelamento de ofício pelo município (305101) |
| Bloqueio | Bloqueio de ofício pelo município (305102) |
| Desbloqueio | Desbloqueio de ofício pelo município (305103) |
| Confirmacao | Uma das partes confirmou a nota, ou confirmação tácita do município (202201 / 203202 / 204203 / 205204) |
| Rejeicao | Uma das partes rejeitou a nota (202205 / 203206 / 204207) |
| RejeicaoAnulada | Município anulou uma rejeição (205208) |
| Outro | Evento oficial ainda não modelado; o código real fica em status |
eventos[].codigoCódigo oficial do evento
| Valores | Significado |
|---|---|
| 101101 | Cancelamento pelo prestador |
| 105102 | Cancelamento por substituição |
| 101103 | Pedido de análise fiscal de cancelamento |
| 105104 | Análise deferida |
| 105105 | Análise indeferida |
| 305101 | Cancelamento de ofício |
| 305102 | Bloqueio de ofício |
| 305103 | Desbloqueio de ofício |
| 202201 | Confirmação pelo prestador |
| 203202 | Confirmação pelo tomador |
| 204203 | Confirmação pelo intermediário |
| 205204 | Confirmação tácita pelo município |
| 202205 | Rejeição pelo prestador |
| 203206 | Rejeição pelo tomador |
| 204207 | Rejeição pelo intermediário |
| 205208 | Rejeição anulada pelo município |
| 000000 | Evento oficial ainda não modelado; o código real fica em status |
| Código | HTTP | |
|---|---|---|
| 10018003 | 404 | A chave não está entre as notas recebidas desta empresa. Verifique chaveAcesso e empresaId, e lembre que a sincronização corre a cada 15 minutos por padrão. |
| 10003000 | 404 | empresaId não existe ou não pertence a esta aplicação. |
