NF-e
查询 NF-e
返回状态、票面与 DANFE / XML 下载链接。
GET
/openapi/v2/empresas/{empresaId}/nf-e/{nfeId}需要
token、timestamp、sign 三个签名头,参见认证与签名。路径参数
empresaId* | string | 开票主体标识 |
nfeId* | string | 发票标识 |
* 必填字段
200
查询成功。
id | string | 请求标识 |
tipo | string | 单据类型 |
status | string | 发票状态 |
motivoStatus | string | 驳回原因 |
ambienteEmissao | string | 开票环境 |
enviadaPorEmail | bool | 是否已邮件发送 |
dataCriacao | string | 受理时刻 |
dataUltimaAlteracao | string | 最后更新时刻 |
forcarEmissaoContingencia | bool | 是否强制应急开票 |
| object | 订单信息 |
| object | 买方信息 |
numero | string | 票号 |
serie | string | 系列号 |
dataEmissao | string | 开票时刻 |
chaveAcesso | string | 访问密钥 |
| object | 运输信息 |
dataAutorizacao | string | 授权时刻 |
linkDanfe | string | DANFE 下载链接 |
linkDownloadXml | string | 授权 XML 下载链接 |
linkConsultaPorChaveAcesso | string | 公开查询地址 |
| object | 授权协议 |
emitidaEmContingencia | bool | 是否应急开出 |
finalidade | string | 开票目的 |
naturezaOperacao | string | 操作性质描述 |
| object | 原票引用 |
| array | 商品行 |
valorTotal | number | 发票总额 |
informacoesAdicionais | string | 票面备注 |
informacoesAdicionaisFisco | string | 给税务机关的备注 |
发票在 SEFAZ 应答前为 AguardandoAutorizacao,之后进入 Autorizada、Negada 或 Cancelada 终态。终态后平台释放请求参数:pedido、备注、naturezaOperacao 以及税码税率以外的税参不再返回。
AguardandoAutorizacao:处理中
受理后到 SEFAZ 应答前。没有票号、密钥、协议与链接;pedido、cliente 与全部税参按传入回显。再查一次或等回调。
json
{"id": "NFe-000014553","status": "AguardandoAutorizacao","numero": null,"chaveAcesso": null,"dataAutorizacao": null,"linkDanfe": null,"linkDownloadXml": null,"pedido": { "presencaConsumidor": "OperacaoPelaInternet", "pagamento": { "tipo": "PagamentoAVista", "formas": [ { "tipo": "CartaoDeCredito", "valor": 28.47 } ] } },"itens": [ { "cfop": "6102", "codigo": "000068", "origem": 0, "impostos": { "icms": { "situacaoTributaria": "102" }, "pis": { "situacaoTributaria": "49", "aliquota": 0 }, "cofins": { "situacaoTributaria": "49", "aliquota": 0 } } } ]}
Autorizada:已授权
票号、密钥、dataAutorizacao、protocolo 与两个链接都有值。每次查询都重新签发链接。
json
{"id": "NFe-000014553","status": "Autorizada","numero": "262","serie": "2","chaveAcesso": "35241104893402000113550020000002621202427463","dataAutorizacao": "2024-11-27T20:56:55Z","protocolo": { "numero": "135240009194753" },"linkDanfe": "https://api.v2.tffiscal.com/openapi/files/danfe/35241104893402000113550020000002621202427463?token=…","linkDownloadXml": "https://api.v2.tffiscal.com/openapi/files/xml/8801?token=…"}
Negada:已驳回
motivoStatus 给出 SEFAZ 返回码与原因。没有 DANFE;已分配的票号会回收,后续开票按先后补上,不会跳号。修正请求后重新开票。
json
{"id": "NFe-000014553","status": "Negada","motivoStatus": "778 - Rejeicao: NCM inexistente","linkDanfe": null,"linkDownloadXml": null}
Cancelada:已取消
取消 NF-e 之后。票号、密钥与协议保留;DANFE 链接不再返回,XML 仍可下载。
json
{"id": "NFe-000014553","status": "Cancelada","numero": "262","chaveAcesso": "35241104893402000113550020000002621202427463","protocolo": { "numero": "135240009194753" },"linkDanfe": null,"linkDownloadXml": "https://api.v2.tffiscal.com/openapi/files/xml/8801?token=…"}
linkDanfe 与 linkDownloadXml 形如 https://api.v2.tffiscal.com/openapi/files/{kind}/{ref}?token=…,不需要签名头:直接 GET 并跟随 302 跳转即可。每次查询都重新签发链接;过期回 401 + 10009036。有效期与其余错误见文件下载。
status发票状态
| 取值 | 含义 |
|---|---|
| AguardandoAutorizacao | 已受理,等待 SEFAZ 应答 |
| Autorizada | SEFAZ 已授权;DANFE 与 XML 可下载 |
| Negada | SEFAZ 驳回;原因在 motivoStatus |
| Cancelada | 授权后已取消 |
ambienteEmissao开票环境
| 取值 | 含义 |
|---|---|
| Homologacao | 税务局测试环境,票无法律效力 |
| Producao | 正式环境 |
finalidade开票目的
| 取值 | 含义 |
|---|---|
| Normal | 普通销售 |
| Complementar | 补充票,补已授权原票的金额、数量或税额 |
| Ajuste | 调整票,对已授权原票做无货物流转的调整 |
| Devolucao | 退货票;带 notaReferenciada |
pedido.presencaConsumidor在场方式
| 取值 | 含义 |
|---|---|
| NaoSeAplica | 不适用,退货票 |
| OperacaoPresencial | 门店现场成交 |
| OperacaoPelaInternet | 互联网成交 |
| OperacaoPorTelefone | 电话成交 |
| EntregaEmDomicilio | 送货上门时成交 |
| OperacaoPresencialForaDoEstabelecimento | 店外现场成交 |
| Outros | 其他 |
pedido.pagamento.tipo付款时点
| 取值 | 含义 |
|---|---|
| PagamentoAVista | 即付 |
| PagamentoAPrazo | 赊购 |
pedido.pagamento.formas[].tipo支付方式
| 取值 | 含义 |
|---|---|
| Dinheiro | 现金 |
| Cheque | 支票 |
| CartaoDeCredito | 信用卡 |
| CartaoDeDebito | 借记卡 |
| CreditoLoja | 店铺信用 |
| ValeAlimentacao | 食品券 |
| ValeRefeicao | 餐券 |
| ValePresente | 礼品券 |
| ValeCombustivel | 燃油券 |
| BoletoBancario | 银行票据 |
| DepositoBancario | 银行存款 |
| PagamentoInstantaneoPix | Pix 即时支付 |
| TransferenciaBancaria | 银行转账 |
| ProgramaDeFidelidade | 忠诚计划或返现 |
| PagamentoInstantaneoPixEstatico | Pix 静态码 |
| CreditoEmLoja | 店内余额 |
| PagamentoEletronicoNaoInformado | 未能对接的电子支付 |
| PagamentoInstantaneoPixAutomatico | Pix 自动扣款 |
| TransferenciaTefBookTransfer | TEF 同行转账 |
| SemPagamento | 无支付,退货票 |
| PagamentoPosterior | 后付 |
| Outros | 其他 |
cliente.indicadorContribuinteICMS买方 ICMS 身份
终态后只有 ContribuinteICMS(带 IE 的 CNPJ)或 NaoContribuinte。
| 取值 | 含义 |
|---|---|
| ContribuinteICMS | 纳税人,带州注册号 |
| ContribuinteIsento | 免登记 |
| NaoContribuinte | 非纳税人 |
cliente.tipoPessoa买方类型
| 取值 | 含义 |
|---|---|
| F | 个人,证件是 11 位 CPF |
| J | 企业,证件是 14 位 CNPJ |
cliente.endereco.uf买方所在州
EX 只出现在出口票。
| 取值 | 含义 |
|---|---|
| AC | Acre |
| AL | Alagoas |
| AP | Amapá |
| AM | Amazonas |
| BA | Bahia |
| CE | Ceará |
| DF | Distrito Federal |
| ES | Espírito Santo |
| GO | Goiás |
| MA | Maranhão |
| MT | Mato Grosso |
| MS | Mato Grosso do Sul |
| MG | Minas Gerais |
| PA | Pará |
| PB | Paraíba |
| PR | Paraná |
| PE | Pernambuco |
| PI | Piauí |
| RJ | Rio de Janeiro |
| RN | Rio Grande do Norte |
| RS | Rio Grande do Sul |
| RO | Rondônia |
| RR | Roraima |
| SC | Santa Catarina |
| SP | São Paulo |
| SE | Sergipe |
| TO | Tocantins |
| EX | 国外,出口票用 |
transporte.frete.modalidade运费方式
| 取值 | 含义 |
|---|---|
| SemFrete | 无运费 |
| PorContaDoEmitente | 发货方承担 |
| PorContaDoDestinatario | 收货方承担 |
| PorContaDeTerceiros | 第三方承担 |
| TransporteProprioPorContaDoRemetente | 发货方自有车辆 |
| TransporteProprioPorContaDoDestinatario | 收货方自有车辆 |
itens[].origem商品来源
| 取值 | 含义 |
|---|---|
| 0 | 国产 |
| 1 | 直接进口 |
| 2 | 国内购入的进口品 |
| 3 | 国产,进口成分超 40 % |
| 4 | 国产,按基本生产流程制造 |
| 5 | 国产,进口成分不超 40 % |
| 6 | 直接进口,无国产同类品 |
| 7 | 国内购入的进口品,无国产同类品 |
| 8 | 国产,进口成分超 70 % |
itens[].impostos.icms.situacaoTributariaICMS 税码 CST,一般税制 CRT 2 / 3
| 取值 | 含义 |
|---|---|
| 00 | 全额征税 |
| 02 | 燃油按量,自征 |
| 10 | 征税并代收下游 ST |
| 15 | 燃油按量,自征加代征 |
| 20 | 税基缩减 |
| 30 | 自身免税但代收下游 ST |
| 40 | 免税 |
| 41 | 不征税 |
| 50 | 暂缓 |
| 51 | 递延 |
| 53 | 燃油按量,递延 |
| 60 | 上游已代收 ST |
| 61 | 燃油按量,前环节已征 |
| 70 | 税基缩减并代收下游 ST |
| 90 | 其他 |
itens[].impostos.icms.situacaoTributariaICMS 税码 CSOSN,Simples Nacional CRT 1 / 4
| 取值 | 含义 |
|---|---|
| 101 | 征税且允许买方抵扣 |
| 102 | 征税不抵扣 |
| 103 | 营收区间免征 |
| 201 | 代收 ST 且允许抵扣 |
| 202 | 代收 ST 不抵扣 |
| 203 | 营收区间免征并代收 ST |
| 300 | 宪法豁免 |
| 400 | 不征税 |
| 500 | 上游已代收 ST |
| 900 | 其他 |
itens[].impostos.pis.situacaoTributariaPIS 税码
| 取值 | 含义 |
|---|---|
| 01 | 基本税率征税 |
| 02 | 差别税率征税 |
| 03 | 按数量征税 |
| 04 | 单相制转售零税率 |
| 05 | 代收 |
| 06 | 零税率 |
| 07 | 免税 |
| 08 | 不征,出口用 |
| 09 | 暂缓 |
| 49 | 其他销项操作 |
| 50–56 | 进项有抵扣权,按收入类型细分,只用于退货票 |
| 60–66 | 进项推定抵扣,按收入类型细分,只用于退货票 |
| 67 | 进项推定抵扣,其他情形,只用于退货票 |
| 70 | 进项无抵扣权 |
| 71 | 进项免税 |
| 72 | 进项暂缓 |
| 73 | 进项零税率 |
| 74 | 进项不征 |
| 75 | 进项代收 |
| 98 | 其他进项操作 |
| 99 | 其他操作 |
itens[].impostos.cofins.situacaoTributariaCOFINS 税码
与 PIS 同一张表。
| 取值 | 含义 |
|---|---|
| 01 | 基本税率征税 |
| 02 | 差别税率征税 |
| 03 | 按数量征税 |
| 04 | 单相制转售零税率 |
| 05 | 代收 |
| 06 | 零税率 |
| 07 | 免税 |
| 08 | 不征,出口用 |
| 09 | 暂缓 |
| 49 | 其他销项操作 |
| 50–56 | 进项有抵扣权,按收入类型细分,只用于退货票 |
| 60–66 | 进项推定抵扣,按收入类型细分,只用于退货票 |
| 67 | 进项推定抵扣,其他情形,只用于退货票 |
| 70 | 进项无抵扣权 |
| 71 | 进项免税 |
| 72 | 进项暂缓 |
| 73 | 进项零税率 |
| 74 | 进项不征 |
| 75 | 进项代收 |
| 98 | 其他进项操作 |
| 99 | 其他操作 |
itens[].impostos.ipi.situacaoTributariaIPI 税码
| 取值 | 含义 |
|---|---|
| 00 | 进项征税 |
| 01 | 进项零税率 |
| 02 | 进项免税 |
| 03 | 进项不征 |
| 04 | 进项豁免 |
| 05 | 进项暂缓 |
| 49 | 其他进项 |
| 50 | 销项征税 |
| 51 | 销项零税率 |
| 52 | 销项免税 |
| 53 | 销项不征 |
| 54 | 销项豁免 |
| 55 | 销项暂缓 |
| 99 | 其他销项 |
| 错误码 | HTTP | |
|---|---|---|
| 10004000 | 404 | nfeId 不存在。核对开票时传入的 id 与 empresaId。 |
| 10004001 | 404 | nfeId 不存在。核对开票时传入的 id 与 empresaId。 |
| 10003000 | 404 | empresaId 不存在或非本应用名下。 |
