接入文档
接入文档 /快速开始/接入说明

接入说明

EasyAPI 电子发票提供一套 HTTP + JSON 的开票接口,业务系统只需调用接口提交开票申请,开票、交付、红冲等动作由 EasyAPI 对接电子税务局异步完成,结果通过回调通知或查询接口返回。

接入流程

  1. 注册与配置:登录 发票控制台,在「发票配置 - 企业信息」完善企业名称、税号、地址电话、开户行、电子税务局省份等信息。
  2. 创建密钥:在控制台「服务认证」页面创建一组 appKey / appSecret,这是接口调用的身份凭证,详见 鉴权方式。
  3. 登录 & 认证:数电发票需要开票员在电子税务局完成登录与身份认证,可在控制台操作,也可以把 登录&认证卡片 集成到自有系统。
  4. 联调开票:控制台「开票配置 - 开票参数」中可开启「是否测试环境」,测试模式下开票申请不会提交到电子税务局,而是返回模拟开票结果,便于联调;调用 开具发票 接口提交开票申请。
  5. 接收结果:开票为异步流程,建议在开票时传入 callbackUrl 接收 回调通知,也可以按外部订单号 查询发票。
  6. 上线:关闭测试环境,确认开票员登录 & 认证状态正常后即可正式开票。

环境地址

名称 地址 说明
接口地址 https://fapiao-api.easyapi.com 文档中所有接口路径均相对于该地址
发票控制台 https://fapiao.easyapi.com/console 创建密钥、配置企业信息、查看开票记录与 API 日志
接入演示 https://fapiao.easyapi.com/tool 在线填写参数并发起开票请求,查看实际请求报文
没有独立的沙箱域名

正式环境与测试环境使用同一接口地址,是否产生真实发票由控制台「是否测试环境」开关决定,请在上线前确认该开关已关闭。

请求规范

  • 字符编码统一使用 UTF-8。
  • GET / DELETE 接口的参数放在 Query String 中;POST / PUT 接口除特别说明外使用 Content-Type: application/json,参数放在请求体中,鉴权参数(appKey、appSecret 或 accessToken)同样放在请求体。
  • 金额单位为元,最多保留两位小数;税率使用小数表示,例如 0.13、0.03、0。
  • 时间格式为 yyyy-MM-dd HH:mm:ss,日期格式为 yyyy-MM-dd。
  • 所有接口返回 JSON,结构见 响应格式与错误码。
  • 同一外部订单号 outOrderNo 在同一企业内唯一,请勿在短时间内重复提交。

接口清单

模块 接口 说明
发票开具 POST /invoice/make 开具发票(含特定业务、差额开票、医疗服务)
发票开具 PUT /invoice/{id} 修改发票
发票开具 POST /invoice/used-car/make 二手车发票开具
发票开具 POST /invoice/retry、POST /invoice/batch-retry、GET /invoice/retry-first 重试开票
发票开具 GET /invoice/{outOrderNo}/file-refresh 重新下载版式文件
发票开具 POST /invoice/{id}/making-failure、POST /invoice/{id}/test-failure 主动置为开票失败
发票开具 POST /invoice/template、DELETE /invoice/template、GET /invoice/templates 开票模板
发票查询 GET /invoice/{outOrderNo}/query 查询发票详情
发票查询 GET /invoices/{outOrderNo}/query 查询同一订单号的发票列表
发票查询 GET /invoices/{outOrderNo}/pdf-base64 获取发票文件 Base64
发票查询 GET /dzfp/{allElectronicInvoiceNumber}_{time} 按数电票号码查询(免鉴权)
发票查询 GET /invoice/state、GET /shop/batch-state 批量查询发票状态
发票查询 GET /invoice/{outOrderNo}/out-orders 查询关联外部订单
红冲与作废 POST /invoice/red 红冲 / 作废发票
红冲与作废 POST /invoice/print 纸质发票打印
交付与通知 GET /send/mobile、GET /send/email、GET /send/email/query 短信 / 邮件交付
交付与通知 回调地址 POST {callbackUrl} 回调通知
交付与通知 GET /invoice/callback、POST /invoice/batch-callback 手动触发回调
基础数据 GET /access-token 获取访问令牌
基础数据 GET /company/codes 企业抬头查询
基础数据 POST /tax-code/product、POST /tax-code/short-name、GET /tax-code/tree、GET /tax-code/list 税收分类编码
基础数据 GET /shop/query、POST /shop/register 企业(商户)信息
嵌入式集成 https://fapiao-robot-login.easyapi.com/access-token 登录&认证卡片集成
嵌入式集成 https://fapiao-h5.easyapi.com、https://fapiao-pc.easyapi.com H5 / PC 页面嵌入
其他接口

POST /invoice/product-make(商品明细开票)、POST /invoice/category/make(自定义分类开票)、POST /merge-make(外部订单合并开票)、PUT /scan/{code}/make(扫码开票)以及 /company、/companies 等抬头管理接口,主要服务于 EasyAPI 提供的 H5 / PC 嵌入页面和用户端场景,一般无需业务系统直接调用;如有需要请联系技术支持获取说明。

获取帮助

  • 接入过程中的请求与响应可在控制台「API 日志」中查看,便于排查参数错误。
  • 商务与技术支持:136-5617-1020(微信同号),或通过 联系我们 页面留言。