端点快速参考
NFE API所有端点
API中所有可用端点的完整概述。使用此表作为瀏览文档的快速参考。
基础URL
https://api.tffiscal.com
| 路径 | HTTP方法 | 功能 |
|---|---|---|
| 公司管理 | ||
/api/company/create |
POST | 注册开票公司 |
/api/company/get_detail |
GET | 查询公司详情 |
/api/company/edit |
POST | 编辑公司数据 |
/api/company/get_list |
GET | 列出公司 |
/api/company/v2/create |
POST | 使用证书注册公司(简化版) |
/api/company/get_cep_detail |
GET | 通过 CEP 查询地址 |
/api/company/get_export_invoice_month_files |
GET | 列出每月导出文件 |
| 税务类别 | ||
/api/category/get_list |
GET | 列出税务类别 |
/api/category/create |
POST | 创建税务类别 |
/api/category/get_detail |
GET | 查询税务类别详情 |
/api/category/edit |
POST | 编辑税务类别 |
/api/category/delete |
POST | 删除税务类别 |
| CFOP 操作代码表 | ||
/api/cfop/get |
POST | 查询 CFOP |
/api/cfop/list |
POST | CFOP 列表 |
| 税务稽核 | ||
/api/audit/run |
POST | 执行税务稽核 |
| SPED(数字财务记账) | ||
/api/sped/efd |
POST | 生成 SPED EFD ICMS/IPI |
| NF-e 发票管理 | ||
/api/invoice/create |
POST | 开具发票 |
/api/invoice/get_list |
GET | 列出发票 |
/api/invoice/get_detail |
GET | 查询发票详情 |
/api/invoice/refresh |
POST | 更新发票状态 |
/api/invoice/cancel |
POST | 取消发票 |
/api/invoice/invalid |
POST | 作废发票编号 |
/api/invoice/return |
POST | 开具退货发票 |
/api/invoice/get_xml |
POST | 导出发票 XML |
| NFC-e (消费者电子发票) | ||
/api/nfce/company/create |
POST | 注册NFC-e企业 |
/api/nfce/company/update |
POST | 更新NFC-e企业 |
/api/nfce/company/get |
POST | 查询NFC-e企业 |
/api/nfce/create |
POST | 开具NFC-e |
/api/nfce/cancel |
POST | 取消NFC-e |
/api/nfce/get_detail |
POST | 查询NFC-e |
/api/nfce/get_danfe |
POST | 获取NFC-e DANFE |
/api/nfce/get_list |
GET | 列出NFC-e(分页) |
/api/nfce/export |
POST | 批量导出 NFC-e(XML/PDF/表格) |
| NFS-e (服务电子发票) | ||
/api/nfse/create |
POST | 开具NFS-e |
/api/nfse/cancel |
POST | 取消NFS-e |
/api/nfse/get_danfse |
POST | 获取DANFSE (PDF) |
/api/nfse/get_xml |
POST | 下载NFS-e XML |
/api/nfse/get_list |
GET | 列出NFS-e(分页) |
/api/nfs/company/create |
POST | 注册用于开具NFS-e的公司 |
| NF-e — 事件与查询 | ||
/api/invoice/get_danfe |
POST | 获取NF-e的DANFE(PDF) |
/api/invoice/consultar_status |
POST | 在税务局查询NF-e/NFC-e状态 |
/api/invoice/cce/send |
POST | 发送更正函(CC-e) |
/api/invoice/cce/get_list |
POST | 列出某张NF-e的CC-e |
/api/invoice/cce/download_pdf |
POST | 下载CC-e的PDF |
/api/invoice/cce/download_xml |
POST | 下载CC-e的XML |
| NF-e — 表明与接收的发票 | ||
/api/invoice/manifest |
POST | 发送收件人表明事件 |
/api/invoice/manifest/list |
POST | 列出已发送的表明 |
/api/invoice/manifest/get_xml |
POST | 获取某次表明的XML |
/api/invoice/received/sync |
POST | 同步接收的NF-e/事件(DistDFe) |
/api/invoice/received/list |
POST | 列出接收的文档 |
/api/invoice/received/get_xml |
POST | 获取接收文档的XML |
/api/invoice/received/get_sync_status |
POST | 查询DistDFe同步状态 |
| NFC-e — 税务类别 | ||
/api/nfce/category/create |
POST | 创建NFC-e税务类别 |
/api/nfce/category/edit |
POST | 编辑NFC-e税务类别 |
/api/nfce/category/delete |
POST | 删除NFC-e税务类别 |
/api/nfce/category/get_detail |
GET | 获取NFC-e类别详情 |
/api/nfce/category/get_list |
GET | 列出NFC-e税务类别 |
| MDF-e(电子税务文档清单) | ||
/api/mdfe/create |
POST | 开具MDF-e |
/api/mdfe/consult |
POST | 查询MDF-e状态 |
/api/mdfe/cancel |
POST | 取消MDF-e |
/api/mdfe/close |
POST | 关闭MDF-e |
/api/mdfe/get_list |
GET | 列出MDF-e(分页) |
| DC-e(电子内容声明) | ||
/api/dce/create |
POST | 开具DC-e |
/api/dce/consult |
POST | 查询DC-e状态 |
/api/dce/cancel |
POST | 取消DC-e |
/api/dce/pdf |
POST | 获取DC-e的DACE(PDF) |
/api/dce/get_list |
GET | 列出DC-e(分页) |
| CT-e(电子运输凭证) | ||
/api/cte/create |
POST | 开具CT-e |
/api/cte/cancel |
POST | 取消CT-e |
/api/cte/cce |
POST | 更正函(CC-e) |
/api/cte/consult |
POST | 查询CT-e状态 |
/api/cte/get_list |
GET | 列出CT-e(分页) |
| NFCom(电子通信服务发票) | ||
/api/nfcom/create |
POST | 开具NFCom |
/api/nfcom/consult |
POST | 查询NFCom状态 |
/api/nfcom/cancel |
POST | 取消NFCom |
/api/nfcom/pdf |
POST | 获取NFCom的DANFE-COM(PDF) |
/api/nfcom/get_list |
GET | 列出NFCom(分页) |
| NF3e(电子电能发票) | ||
/api/nf3e/create |
POST | 开具NF3e |
/api/nf3e/consult |
POST | 查询NF3e状态 |
/api/nf3e/cancel |
POST | 取消NF3e |
/api/nf3e/pdf |
POST | 获取NF3e的DANF3E(PDF) |
/api/nf3e/get_list |
GET | 列出NF3e(分页) |
| SSO(自动登录) | ||
/api/sso/create_ticket |
POST | 生成自动登录链接 |
/api/sso/consume_ticket |
POST | 消费票据并获取会话JWT |
| 会计师 | ||
/api/accountant/get_info |
POST | 获取与企业绑定的会计师信息 |
| RPA — 自由职业者付款收据 | ||
/api/rpa/prestador/save |
POST | 登记/更新服务提供方 |
/api/rpa/prestador/get_list |
POST | 服务提供方列表 |
/api/rpa/preview |
POST | 试算(不开具) |
/api/rpa/create |
POST | 开具 RPA |
/api/rpa/get_list |
POST | RPA 列表 |
/api/rpa/get_detail |
POST | RPA 详情 |
/api/rpa/get_pdf |
POST | 获取 RPA 的 PDF |
/api/rpa/estornar |
POST | 冲销 RPA |
/api/rpa/report/monthly |
POST | 月度结算 |
📋 重要说明:
-
所有端点都需要通过标头进行认证:
sign,timestamp,token - 要创建公司和列出公司,请使用分销商令牌(b2b_token)
-
Content-Type必须始终为
application/json;charset=utf-8 -
响应遵循带有
success、message和data字段的JSON标准
200
成功
请求处理成功
400
客户端错误
无效或缺少数据
500
服务器错误
服务器内部错误