TF Fiscal
开发文档

DC-e

查询 DC-e

返回状态、协议、XML / DACE 下载链接与发行入参回显。

GET/openapi/v2/empresas/{empresaId}/dc-e/{dceId}

需要 token、timestamp、sign 三个签名头，参见认证与签名。

按发行时传入的 id 查询单据。回显段（remetente … observacoesMarketplace）来自受理时规范化后的入参快照，任务终态后依旧可查。下载链接形如 {公网基址}/openapi/files/{kind}/{ref}?token=…（kind 为 xml 或 dace），令牌自带凭证、下载时不需要签名头，有效期取租户级设置（缺省 7 天），每次查询重新签发。参见文件下载。

参数

路径参数

  • empresaIdstring必填

    注册开票主体返回的标识。

    示例: 1934811222334455
  • dceIdstring必填

    发行时传入的 id。

    示例: DCe-000012333

响应

200

单据存在。单据事实字段（numero、chaveAcesso、protocolo、链接）随状态推进逐步填充。

  • idstring

    集成商单据 id。

  • ambientestring

    Producao / Homologacao，与发行时一致。

    取值:ProducaoHomologacao
  • statusstring

    单据状态，见下方状态表。

    取值:PendenteAutorizadaNegadaCancelamentoPendenteCanceladaFalha
  • motivoStatusstring

    状态原因：Negada 为 cStat - xMotivo，Falha 为失败原因，Autorizada 为最近一次取消被拒原因；其余为 null。

  • dataCriacaostring

    受理时刻（ISO-8601，UTC）。

  • dataUltimaAlteracaostring

    最近一次状态变更时刻（ISO-8601，UTC）。

  • numerointeger

    DC-e 号（nDC），取号后即有。

  • seriestring

    DC-e 系列。

  • dataEmissaostring

    开票时刻（ISO-8601）。

  • chaveAcessostring

    44 位访问密钥，取号后即有。第 7-20 位永远是平台主体的 CNPJ。

  • dataAutorizacaostring

    SEFAZ 授权时刻（ISO-8601）。

  • linkDacestring

    DACE PDF 链接，按 chave 懒渲染（链接先于文件存在，首次下载才渲染归档；渲染服务不可用时下载回 503，稍后重试）。取消后指向带 CANCELADA 水印的重渲染版。

  • linkDownloadXmlstring

    dceProc XML（法律原件）下载链接。

  • protocoloobject

    授权协议。

  • emitidaEmContingenciaboolean

    一期恒为 false。

  • remetenteobject

    发行时传入的发件方回显（结构同发行 DC-e）。

  • destinatarioobject

    收件方回显（结构同发行）。认证测试环境下回显仍为原文，尽管 XML 与 DACE 为固定文案。

  • itensarray

    申报物品回显。

  • transporteobject

    运输信息回显。

  • autorizacaoDownloadXmlarray

    授权下载 XML 的证件回显。

  • informacoesAdicionaisstring

    电商平台附加信息回显。

  • informacoesAdicionaisFiscostring

    面向税务机关的附加信息回显。

  • informacoesAdicionaisEmitentestring

    发行方补充信息回显。

  • observacoesMarketplacearray

    电商平台备注回显。

错误

错误码HTTP
DCe0001404

dceId 不存在或非本主体。核对 id 与 empresaId。

10003000404

empresaId 不存在。

`status` 取值

status含义
Pendente已受理、排队或发送中（numero / chaveAcesso 取号后即有）
AutorizadaSEFAZ 授权（cStat 100）；linkDownloadXml 为 dceProc 法律原件，linkDace 为按 chave 懒渲染的 DACE PDF，protocolo 带协议号与摘要。若最近一次取消被 SEFAZ 拒绝，motivoStatus 为取消被拒原因 cStat - xMotivo（与 Webhook dce.cancel_rejected 的 dceMotivoStatus 一致），否则为 null
NegadaSEFAZ 驳回；motivoStatus 为 cStat - xMotivo
CancelamentoPendente取消已受理，等待 SEFAZ 结论
Cancelada已取消（110111）；linkDace 为带 CANCELADA 水印的重渲染版
CancelamentoNegado仅出现在 Webhook：取消被 SEFAZ 拒绝，单据回到 Autorizada，查询接口按 Autorizada 返回并在 motivoStatus 带取消被拒原因；可修正后再次 DELETE
Falha任务终态失败（参数无法解析、重投超限等），motivoStatus 给原因；可用同 id 重新提交
上一页发行 DC-e下一页取消 DC-e