文档
测试

查询发票列表

POST
请求地址/router

接口描述

查询税务编码列表

请求地址

|环境|服务地址(HTTP/HTTPS)| |-|-| |V2正式环境(推荐)| https://gw.superboss.cc/router| |V2测试环境| https://gw3.superboss.cc/router| **2022年4月1日**以后申请的APP Key,统一使用V2正式环境的请求地址:**https://gw.superboss.cc/router**

公共参数

调用任何一个API都必须传入的参数,目前支持的公共参数有: | 参数名称 | 参数类型 | 是否必须 | 参数描述 | | --- | --- | --- | --- | | method | string | 是 | API接口名称 | | appKey | string | 是 | 分配给应用的AppKey | | timestamp | string | 是 | 时间戳,时区为GMT+8,例如:2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 | | format | string | 否 | 响应格式。默认为json格式,可选值:json | | version | string | 是 | API协议版本 可选值:1.0 | | sign\_method | string | 否 | 签名的摘要算法(默认 hmac),可选值为:hmac,md5,hmac-sha256。 | | sign | string | 是 | 签名 | | session | string | 是 | 授权会话信息 (即access_token,由系统分配) |

请求头

参数名
类型
描述
必填
Content-Type
string
application/x-www-form-urlencoded
必填

API接口地址

参数名
类型
描述
必填
method
string
fms.invoice.issuer.page
必填

请求参数

参数名
类型
默认值
描述
必填
originalNumber
string
平台单号(多个逗号隔开)
可选
systemNumber
string
系统单号(多个逗号隔开)
可选
invoiceNumber
string
发票单号(多个逗号隔开)
可选
shopIds
string
店铺ID(多个逗号隔开)
可选
timeType
int
查询时间类型 1:创建时间 2:开票时间 3:修改时间
可选
startTime
string
起始时间:格式yyyy-MM-dd HH:mm:ss
可选
endTime
string
截止时间:格式yyyy-MM-dd HH:mm:ss
可选
invoiceStatus
string
发票状态(多个逗号隔开) 发票状态枚举 待开票、开票中、开票失败、开票成功、已确认、已取消
可选
billingType
int
开票类型(枚举 红票、蓝票)
可选
isRedInvoice
int
是否冲红 1:冲红 0:不冲红
可选
pageNo
int
页码
可选
pageSize
int
每页多少条,最大支持200,不能小于20
可选

请求示例

示例一: ----------------- ```` { "invoiceNumber":"FP123", "pageNo":1, "pageSize":50 } ````

响应参数

参数名
类型
描述
必填
success
boolean
示例:true
必填
trace_id
string
示例:3553483395407017
必填
msg
string
错误信息
必填
code
string
错误编码
必填
data
object
分页数据
必填
total
int
总数
必填
page
object
分页数据
必填
startRow
int
开始页
必填
offsetRow
int
下页
必填
pageNo
int
页号
必填
pageSize
int
页数
必填
list
array
查询数据列表
必填
invoiceNumber
string
发票单号
必填
originalNumber
string
原始单号
可选
systemNumber
string
系统单号
可选
redInvoiceOriginalNumber
string
红票原单号
可选
invoiceSerialNumber
string
发票流水号
可选
invoiceNumberCode
string
发票号码
可选
invoiceCode
string
发票代码
可选
invoiceStatus
string
发票状态 待开票、开票中、开票失败、开票成功、已确认、已取消
可选
invoiceResponse
string
发票回告
可选
billingType
string
开票类型 1:蓝票 2:红票
可选
invoiceType
string
发票类型 1: 纸质普票 2: 纸质专票 3: 电子普票 4: 电子专票
可选
isRedInvoice
integer
是否冲红 0:不冲红 1:冲红
可选
redReason
string
冲红原因
可选
shopId
string
店铺id
可选
shopName
string
店铺名称
可选
shopShortTitle
string
店铺简称
可选
orderAmount
number
订单金额
可选
afterTaxAmount
number
含税金额
可选
preTaxTotalPrice
number
不含税金额
可选
taxAmount
number
税额
可选
titleType
string
抬头类型 1:个人 2:企业
可选
invoiceTitle
string
发票抬头
可选
buyerTaxId
string
买家税号
可选
address
string
购方地址
可选
phone
string
购方电话
可选
bankName
string
开户行
可选
bankAccount
string
开户行账号
可选
email
string
开户行电子邮箱
可选
issuer
string
开票方
可选
serviceProvider
string
服务商
可选
billingCategory
string
开票种类 电子、全电、纸质
可选
syncStatus
int
同步状态 1: 待同步, 2: 同步成功, 3: 同步失败, 4: 不支持
可选
invoiceNote
string
发票备注
可选
messageNote
string
留言备注
可选
createdTime
string
创建时间
可选
createdBy
string
创建人
可选
modifiedTime
string
修改时间
可选
modifiedBy
string
修改人
可选
invoiceDate
string
开票日期
可选
invoiceDownloadUrl
string
发票下载地址
可选
errorTag
integer
错误标签
可选
detailList
object[]
详情信息列表
必填
platformOrderNumber
string
平台单号
必填
productName
string
商品名称
必填
productCode
string
商品编码
必填
productSpecification
string
商品规格
必填
taxCode
string
税务编码
必填
quantity
int
数量
必填
unit
string
单位
必填
taxRate
number
税率
必填
preTaxUnitPrice
number
不含税单价
必填
preTaxTotalPrice
number
不含税总价
必填
afterTaxTotalPrice
number
含税总价
必填
createdTime
string
创建时间
必填
isDuct
integer
是否抵扣行 0:否 1:是
必填

响应示例

```` { "traceId": "traceId", "success": true, "data": { "total": 2, "page": { "startRow": 0, "offsetRow": 1, "pageNo": 0, "pageSize": 1 }, "list": [ { "invoiceNumber": "FP000169324110500020", "afterTaxAmount": 0.23, "invoiceStatus": "待开票", "invoiceTitle": "个人", "invoiceType": "电子普票" "detailList": [ { "afterTaxTotalPrice": 0.23, "createdTime": "2024-11-05 11:05:47", "isDuct": 0, "originalNumber": "", "payAmount": 0.33, "platformOrderNumber": "5048398617344169", "preTaxTotalPrice": 0.21, "preTaxUnitPrice": 0.21, "productCode": "xdxiao002", "productName": "xd小东西02", "quantity": 1, "subOrderNumber": "FP000169324110500020", "taxAmount": 0.02, "taxCode": "1010102990000000000", "taxRate": 0.11, "unit": "盒" } ] } ] } } ````

异常示例

```` { "msg": "xxx", "traceId": "123456", "code": "code", "success": false } ````

错误码解释

| 错误码 |错误信息|解决方案| |-|-|-| |content1|content2|content3|