NFC-e 消费者发票

注册（或更新）用于 NFC-e 开票的公司。公司名称、IE、地址和其他数据通过 SintegraWS 从 CNPJ 自动提取。如果 CNPJ 已存在于用户中，则更新 NFC-e 字段并返回现有公司。

必需请求头

Body

* 必填字段。其他数据（名称、IE、地址等）通过 SintegraWS 从 CNPJ 自动提取。

更新由 token 请求头标识的 NFC-e 公司。Body 中所有字段都是可选的 — 只发送要修改的字段。更新 cep 时，系统自动解析 stateCode 和 ibge。当 cert_content 和 cert_pwd 一起发送时，证书在保存前会经过验证。

必需请求头

Body（所有字段可选 — 至少发送 1 个）

Body 中至少 1 个字段必填。CNPJ 不可修改。

返回由 token 请求头标识的 NFC-e 公司数据。注意：方法是 POST，但 body 中无字段 — 公司仅通过令牌解析。

必需请求头

Body

为空。可以发送 {}。

创建一个 NFC-e 税务类目。每个类目只有单一场景(州内出库),ICMS、PIS、COFINS 和 IBS/CBS 使用扁平对象(不是数组,因为 NFC-e 不允许单一类目下有多个场景)。不包含 IPI。

必需请求头

Body(根)

icms

pis / cofins

ibs_cbs(可选)

* 必填字段。

返回 NFC-e 税务类目的完整数据(描述、CFOP、ICMS、PIS、COFINS 和 IBS/CBS)。

必需请求头

查询参数

* 必填字段。

返回已认证企业下注册的 NFC-e 税务类目的分页列表。

必需请求头

查询参数

* 必填字段。

必需请求头

额外字段

* 必填字段。

删除 NFC-e 税务类别。不可逆操作。绑定到此类别的产品仍会引用已删除的 category_id — 请先更新它们。

必需请求头

Body

* 必填字段。

开具 NFC-e(模型 65,始终为州内出库,无运输)。与 NFe 端点的主要区别:消费者对象名为 client(不是 cliente);地址号为 client.number;消费者为可选;不存在 impostos.ipi、shipping_address、delivery_address 或 transportation。pag_info 中的金额字段名为 amount。

必需请求头

Body(根)

client(可选)

仅在消费者已识别时填写。CPF 或 CNPJ 仅传数字。

products[](每项)

pag_info[](每项)

* 必填字段。⚠ category_id 或 impostos 二选一,必填。

返回字段（data）

返回 — 拒绝 / 错误

        {
          "success": false,
          "data": {
            "uuid": "65f8b9a1c2d3e4f5a6b7c8d9",
            "status": "Failed",
            "motivo": "Rejeição 226: Código da UF do Emitente diverge da UF autorizadora / 拒绝 226: 发件人所在州代码与授权州不一致",
            "nfce": 5,
            "serie": 1,
            "chave": "",
            "modelo": "nfce",
            "xml": "",
            "danfe": ""
          }
        }

取消已授权的 NFC-e。与 NFe 不同，这里取消原因由客户提供并转发给税务局。税务局取消窗口很短（通常授权后 15-30 分钟）。

必需请求头

Body

* 必填字段。

返回字段（data）

返回 — 错误

        {
          "success": false,
          "data": {
            "motivo": "Rejeição: Pedido de Cancelamento intempestivo",
            "status": "Failed",
            "nfce": 5,
            "serie": 1,
            "chave": "35210112345678901234650010000000051234567890",
            "modelo": "nfce",
            "cStat": 501
          }
        }

为一张已授权的 NFC-e 开具退货票。退货票是一张入库方向的 NF-e（模型 55），在 XML 中引用原 NFC-e 的访问密钥；NFC-e 本身没有退货这种单据。原票按 uuid 或 chave 在 NFC-e 记录中查找，商品与税务字段沿用原票。/api/invoice/return 只在 NF-e 记录中查找原票，对 NFC-e 会返回「发票不存在」，请改用本接口。

必需请求头

Body

退货票是 NF-e，收货方地址是必填项，而 NFC-e 通常不记录买方地址。原票 XML 里没有地址时，必须在 cliente 中传 endereco、bairro、city、uf、cep，缺哪项接口会逐项列出。

只有已授权的 NFC-e 可以退货。原票的环境（生产或测试）随原票，不需要也不能另传。

重复调用不会重复开票：同一张原票、同一环境下已经开出退货票时，返回已开出的那张。

本接口按整票退货。商品、数量与税务字段取自原票，税务字段先按分类解析，分类缺失时直接沿用原票 XML 的 CST 与税率。

返回字段（data）

返回 — 错误

        {
          "success": false,
          "message": "A devolução é uma NF-e e exige o endereço do comprador; a NFC-e original não o traz. Informe em cliente: endereco, bairro, city, uf, cep / 退货票是 NF-e，必须有买方地址，原 NFC-e 没有。请在 cliente 里传：endereco、bairro、city、uf、cep"
        }

通过 UUID 返回特定 NFC-e 的详情。包括 XML 和 DANFE（热敏小票）的 URL，以及提供时的客户数据。

必需请求头

查询字符串

* 必填字段。

返回 NFC-e DANFE（电子财政小票）的 PDF URL，包含用于税务局查询的 QR 码。按需生成并按哈希（访问密钥 + 状态）缓存；重复调用返回现有 URL。

必需请求头

Body

* 必填字段。

分页列出公司的 NFC-e。参数通过 查询字符串（query string）传递（不在 body 中）。时间过滤可选，但若使用则需同时传入 start_create_time 和 end_create_time。

必需请求头

查询字符串

* 必填字段。

按时间段批量导出公司生产环境的 NFC-e（测试环境 homologação 的票据不包含）。生成为异步：第一次调用触发导出并返回 "status": "Processing"；用相同的 body 重复调用，直到返回 "status": "Success" 和下载 url。XML 和 PDF 以 .zip 交付（每张票一个文件）；表格为 .xlsx 或 .csv。结果有效期 10 天：期间相同参数返回同一文件（生成之后开出的票不会包含 — 换一个时间段即可生成新文件）。

必需请求头

Body

* 必填字段。时间段用 start_create_time + end_create_time 或 month 传入。