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 | number | ISS 税额 |
issRetido | bool | ISS 是否代扣 |
chaveSubstituida | string | 被替代的旧票密钥 |
chaveSubstituta | string | 替代本票的新票密钥 |
dataUltimoEvento | string | 最近事件时刻 |
dataRecebimento | string | 到达平台时刻 |
| object | 本主体表态 |
linkXml | string | XML 原件下载链接 |
linkDanfse | string | DANFSe 下载链接 |
| 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 | 市政核验码 |
* 必填字段
进项票的 status 沿用 Autorizada / Cancelada / Substituida;本主体对它的表态另记在 manifestacao 块,一张票每方只能表态一次,且只在票为 Autorizada 时可表态。各状态含义见枚举。
text
(未表态,列表过滤值 Pendente)──┬──► Confirmada├──► Rejeitada ──► RejeicaoAnulada└──► ConfirmacaoTacita
status单据状态
| 取值 | 含义 |
|---|---|
| Autorizada | 在发行方有效 |
| Cancelada | 被开票方取消或市镇依职权取消 |
| Substituida | 已被替代票取代,chaveSubstituta 为新票密钥 |
papel本主体角色
| 取值 | 含义 |
|---|---|
| Tomador | 服务接收方;表态用 203202 确认或 203206 拒绝 |
| Intermediario | 服务中介方;表态用 204203 确认或 204207 拒绝 |
origem行来源
| 取值 | 含义 |
|---|---|
| ADN | 全国分发到达 |
| PrefeituraSP | 圣保罗市政系统直连取回;只有圣保罗主体;转录票到达后变为 ADN |
manifestacao.status表态状态
字段为 null 表示未表态;列表过滤时这一情形用 Pendente。
| 取值 | 含义 |
|---|---|
| Confirmada | 本方已确认(203202 / 204203);终态 |
| Rejeitada | 本方已拒绝(203206 / 204207);市镇仍可作废 |
| ConfirmacaoTacita | 期限内未表态,市镇默示确认(205204);终态 |
| RejeicaoAnulada | 市镇作废了本方的拒绝(205208);终态 |
manifestacao.codigoEvento表态事件码
| 取值 | 含义 |
|---|---|
| 203202 | 接收方确认 |
| 204203 | 中介方确认 |
| 203206 | 接收方拒绝 |
| 204207 | 中介方拒绝 |
| 205204 | 市镇默示确认 |
| 205208 | 市镇作废拒绝 |
manifestacao.codigoMotivo拒绝原因码
| 取值 | 含义 |
|---|---|
| 1 | 票重复 |
| 2 | 接收方已自行开票 |
| 3 | 应税事实未发生,服务没有提供 |
| 4 | 责任方错误 |
| 5 | 金额或数据错误 |
| 9 | 其他,在 motivo 里说明 |
eventos[].tipo事件类型
该表跟随官方事件演进,可能增加取值。
| 取值 | 含义 |
|---|---|
| Cancelamento | 开票方登记的取消(101101) |
| CancelamentoPorSubstituicao | 因被替代票取代而取消(105102) |
| PedidoAnalise | 取消的税务分析申请(101103) |
| AnaliseDeferida | 市镇准予取消(105104) |
| AnaliseIndeferida | 市镇驳回取消(105105) |
| CancelamentoDeOficio | 市镇依职权取消(305101) |
| Bloqueio | 市镇依职权封锁(305102) |
| Desbloqueio | 市镇依职权解封(305103) |
| Confirmacao | 票上某一方确认或市镇默示确认(202201 / 203202 / 204203 / 205204) |
| Rejeicao | 票上某一方拒绝(202205 / 203206 / 204207) |
| RejeicaoAnulada | 市镇作废拒绝(205208) |
| Outro | 尚未建模的官方事件,真实码在 status |
eventos[].codigo官方事件码
| 取值 | 含义 |
|---|---|
| 101101 | 开票方取消 |
| 105102 | 替代取消 |
| 101103 | 取消的分析申请 |
| 105104 | 分析准予取消 |
| 105105 | 分析驳回取消 |
| 305101 | 依职权取消 |
| 305102 | 依职权封锁 |
| 305103 | 依职权解封 |
| 202201 | 开票方确认 |
| 203202 | 接收方确认 |
| 204203 | 中介方确认 |
| 205204 | 市镇默示确认 |
| 202205 | 开票方拒绝 |
| 203206 | 接收方拒绝 |
| 204207 | 中介方拒绝 |
| 205208 | 市镇作废拒绝 |
| 000000 | 尚未建模的官方事件,真实码在 status |
| 错误码 | HTTP | |
|---|---|---|
| 10018003 | 404 | 该密钥不在本主体的进项里。核对 chaveAcesso 与 empresaId,另注意同步默认每 15 分钟一轮。 |
| 10003000 | 404 | empresaId 不存在或非本应用名下。 |
