TF Fiscal
开发文档

NFS-e

查询进项 NFS-e

一张进项 NFS-e 的详情:往来方、金额、来源、下载链接与本主体的表态。

GET/openapi/v2/empresas/{empresaId}/nfse/recebidas/{chaveAcesso}
需要 token、timestamp、sign 三个签名头,参见认证与签名。

按访问密钥返回一张本主体作为接收方或中介方收到的服务发票。响应结构与进项 NFS-e 列表的条目一致,并且多返回列表项没有的 eventos 数组。登记表态见进项 NFS-e 表态。密钥不在本主体的进项里时回 404。

路径参数

empresaId*
string主体标识
chaveAcesso*
string访问密钥

* 必填字段

200
进项单据存在。
chaveAcesso
string访问密钥
numero
int票号
codigoVerificacao
string核验码
status
string单据状态
papel
string本主体角色
origem
string行来源
dataEmissao
string开票时间
dataAutorizacao
string授权时间
competencia
string服务归属月
object开票方
object接收方
object中介方
codigoTributacaoNacional
string国家服务码
discriminacao
string服务描述
valorServico
number服务金额
valorLiquido
number净额
valorIss
numberISS 税额
issRetido
boolISS 是否代扣
chaveSubstituida
string被替代的旧票密钥
chaveSubstituta
string替代本票的新票密钥
dataUltimoEvento
string最近事件时刻
dataRecebimento
string到达平台时刻
object本主体表态
linkXml
stringXML 原件下载链接
linkDanfse
stringDANFSe 下载链接
array票上事件

进项票经全国分发到达。圣保罗主体另有一条直连来源:每轮同步之后平台再向圣保罗市政系统拉本主体收到的票,转录票尚未到达时就能先看到。PrefeituraSP 行在转录票到达后自动变为 `ADN`,合并为同一行而不是多出一行;此时 chaveAcesso 由临时密钥换成官方密钥,两个链接换成国家布局原件与 DANFSe。请以 prestador.cpfCnpj + numero 作为跨同步稳定的标识,不要把临时密钥当永久主键。

全国分发到达的行

最终形态:官方密钥,国家布局原件与 DANFSe 都可下载。

json
{
"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行来源
chaveAcesso*
string官方密钥

* 必填字段

圣保罗直连取回的行

只有圣保罗主体在合并前会看到。临时密钥是 3550308 + 0 + 开票方 14 位 CNPJ + 票号左补零到 28 位,第 8 位为 0 即可识别;它可用于详情与表态路径。linkXml 指向市政系统原文,linkDanfse 暂为 null。

json
{
"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行来源
chaveAcesso*
string临时密钥
codigoVerificacao*
string市政核验码

* 必填字段