当前位置: API文档
finance.invoice.InvoiceOrder.search(发票信息查询)
1.1 接口描述:获取发票信息 |
1.2 适用版本:客户端 V1.4.8.1及以上版本 |
1.3 增量获取:支持增量获取 |
1.4 时间跨度:start_time和end_time最大跨度为30天 |
1.5 注意事项:发票编号不填写的情况下必须填写开始时间和结束时间 【权限校验】:店铺权限 为了达到保护用户隐私数据安全的目的,本接口不返回淘系及系统供销平台订单数据,相关平台规则点击这里,淘系数据获取办法点击这里。 |
2.1举例说明: |
环境 | HTTP地址 |
---|---|
测试环境 | http://47.92.239.46/openapi |
正式环境 | http://wdt.wangdian.cn/openapi |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | Y | 卖家账号, 由旺店通分配 | |
接口账号 | key | String | Y | 由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里 | |
盐 | salt | String | Y | 由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt. | |
接口名称 | method | String | Y | 调用的接口名称 | |
版本号 | v | String | Y | 1.0 | |
秒级时间戳 | timestamp | int | Y | 秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。 | |
签名 | sign | String | Y | 签名 | |
分页大小 | page_size | int | N | 分页大小,分页查询必传 | |
分页编号 | page_no | int | N | 分页编号,分页查询必传 | |
是否计算查询结果的总条数 | calc_total | int | N | 是否计算查询结果的总条数, 需要计算则1, 否则填0 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
查询参数 | params | Map<String, Object> | Y | 查询参数 | |
分页 | pager | Pager | Y | 分页 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
开始时间 | start_time | String | N | 开始时间(最后更新时间) | |
结束时间 | end_time | String | N | 结束时间(最后更新时间) | |
发票编号 | invoice_order_no | String | 40 | N | 发票编号 |
查询类型 | mode | Int | N | 1:按照传入的条件查询,不限制服务商类型和发票状态. 默认仅返回线下待开票的数据 | |
发票状态 | status | Int | N | 仅mode=1 时生效, | |
服务商类型 | platform_type | Int | 4 | N | 201 金壬 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
分页大小 | page_size | Int | 4 | N | 分页大小 |
页号 | page_no | Int | 4 | N | 从0开始 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
状态码 | status | Int | Y | 返回0为正常 | |
错误信息 | message | String | N | 无错误信息不返回 | |
单据数据 | data | Map<String, Object> | Y | 单据数据 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
单据数据 | order | List<Map<String, Object>> | Y | 单据数据 | |
总数 | total_count | Int | 11 | Y | 查询条件总单据数 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
发票编号 | invoice_order_no | String | 40 | Y | 发票编号,系统内部生成 |
发票下载地址 | file_url | String | 255 | Y | 发票下载地址 |
错误信息 | error_info | String | 100 | Y | 错误信息 |
电子邮箱 | payer_email | String | 64 | Y | 电子邮箱 |
收款银行 | payee_bank_name | String | 255 | Y | 收款银行(开票方管理页面维护) |
收款账户 | payee_bank_account | String | 20 | Y | 收款账户(开票方管理页面维护) |
税前折扣金额 | discount | Decimal(19,4) | Y | 税前折扣金额 | |
付款方联系电话 | payer_phone | String | 40 | Y | 付款方联系电话 |
收款人 | payee_receiver | String | 20 | Y | 收款人 |
开票金额 | invoice_amount | Decimal(19,4) | Y | 实际合计金额+实际合计税额 | |
红蓝票 | is_red | boolean | 1 | Y | false:蓝票 true:红票 |
发票类型 | invoice_type | Int | 4 | Y | 0普通发票 1电子发票 2专用发票 3全电普通发票 4全电专用发票 |
付款方银行账号 | payer_account | String | 40 | Y | 付款方银行账号 |
税控盘号 | tax_control_no | String | Y | 税控盘号 | |
开票人 | payee_operator | String | 20 | Y | 开票人 |
开票类型 | business_type | Int | 4 | Y | 0:商家对于个人开具 1:商家对于企业开具 |
付款方税务登记号 | payer_register_no | String | 40 | y | 付款方税务登记号 |
开票服务商名称 | provider_name | String | 40 | Y | 开票服务商名称 |
付款方地址 | payer_address | String | 255 | Y | 付款方地址 |
实际开票金额 | invoice_outer_amount | Decimal(19,4) | Y | 实际开票金额 | |
付款方银行 | payer_bank | String | 128 | Y | 付款方银行 |
收款方纳税人识别号 | payee_register_no | String | 40 | Y | 收款方纳税人识别号 |
收款方地址 | payee_address | String | 255 | Y | 收款方地址 |
货品合计金额 | goods_amount | Decimal(19,4) | Y | 货品合计金额(未扣除折扣) | |
货品合计税额 | goods_tax | Decimal(19,4) | Y | 货品合计税额(未扣除折扣) | |
创建时间 | created | String | Y | 创建时间(毫秒级时间戳,例如:1631861379000) | |
发票打印备注 | invoice_remark | String | 200 | Y | 发票打印备注 |
折扣税率 | discount_tax | Decimal(19,4) | Y | 折扣税率 | |
收款方联系电话 | payee_telno | String | 40 | Y | 收款方联系电话 |
开票方备注 | payee_remark | String | 255 | Y | 开票方备注 |
店铺编号 | shop_no | String | 20 | Y | 店铺编号 |
店铺名称 | shop_name | String | 128 | Y | 店铺名称 |
实际合计税额 | sum_tax | Decimal(19,4) | Y | 货品合计税额-折扣税额 | |
收款方公司名称 | payee_name | String | 64 | Y | 收款方公司名称 |
付款方名称 | payer_name | String | 64 | Y | 对应发票抬头,付款方名称 |
关联发票号码 | relation_invoice_no_out | String | 40 | Y | 红字发票对应蓝票的发票号码(为null时不返回) |
关联发票代码 | relation_invoice_code | String | 40 | Y | 红字发票对应蓝票的发票代码(为null时不返回) |
复核人 | payee_checker | String | 20 | Y | 复核人 |
发票流水号 | serial_no | String | 50 | Y | 发票流水号 |
发票状态 | status | Int | 4 | Y | 5:取消;10:编辑中;20:待审核;35:导入待确认;40:待开票;45:线下待开票;50:开票中;60:开票成功;70开票申请失败;80:开票失败;85:线下开票失败;90:待上传PDF;100:上传失败;110:上传成功 |
实际合计金额 | sum_price | Decimal(19,4) | Y | 货品合计金额-税前折扣金额 | |
发票标记 | invoice_mask | Int | 11 | Y | 1发送短信;2整合开票;4导入发票;8线下订单标记;16等待发票开票成功后重开,重开成功后去除;32重开的发票;64开票后原始发票信息变更;128上传发票;256重开的发票金额跟之前相同;512发送邮件; |
发票代码 | invoice_code | String | 40 | Y | 发票代码 |
发票号码 | invoice_no | String | 40 | Y | 发票号码 |
开票日期 | invoice_time | String | Y | 开票日期, 格式: yyyy-MM-dd HH:mm:ss | |
标记名称 | flag_name | String | Y | 标记名称 | |
订单编号 | trade_no | String | Y | 旺店通系统订单编号 | |
明细信息 | detail_list | List<Map<String,Object>> | Y | 明细信息 |
detail_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
发票项目名称 | item_name | String | 40 | Y | 发票项目名称,即商品名称 |
发票项目编码 | item_no | String | 40 | Y | 发票项目编码,即商品规格 |
行类型 | row_type | String | 4 | Y | 0: 正常行 1:折扣行 2:被折扣行 |
单位名称 | unit_name | String | 20 | Y | 单位名称 row_type=1不传 |
商品数量 | num | Decimal(19,4) | Y | 商品数量 row_type=1不传 | |
税务编码 | tax_code | String | 32 | Y | 税务编码 |
税率 | tax_rate | Decimal(19,4) | Y | 税率 | |
税前单价 | price | Decimal(19,4) | Y | 税前单价 row_type=1不传 | |
税前总价 | sum_price | Decimal(19,4) | Y | 税前总价(不含折扣) | |
税额 | tax | Decimal(19,4) | Y | 税额(不含折扣) | |
总价 | sum_amount | Decimal(19,4) | Y | 总价(税前总价+税额) | |
电子发票明细备注 | remark | String | 100 | Y | 电子发票明细备注 |
原始单号 | tid | String | 40 | Y | 原始单号 |
原始子单号 | oid | String | 40 | Y | 原始子单号 |
订单编号 | trade_no | String | Y | 订单编号 | |
平台id | platform_id | short | Y | 平台id,可参考平台代码表 |
"status": 0, "data": { "total_count": 1, "order": [{ "invoice_order_no": "FP201902120001", "file_url": "", "error_info": "", "payer_email": "", "detail_list": [{ "item_name": "", "item_no": "green", "unit_name": "只", "num": 1, "tax_code": "1010101010000000000", "tax_rate": 0.13, "price": 3.53, "sum_price": 3.53, "tax": 0.47, "sum_amount": 4, "discount": 0, "discount_tax": 0, "remark": "" }], "payee_bank_name": "", "payee_bank_account": "", "discount": 0, "payer_phone": "18000000983", "payee_receiver": "王小二", "invoice_amount": 4, "is_red": false, "payer_account": "", "payee_operator": "王小二", "business_type": 0, "payer_register_no": "", "provider_name": "金壬普通发票", "payer_address": "河北省 唐山市 古冶区 xxxxxxxxx生生世世事实上事实上事实上", "shop_no": "msn001", "invoice_outer_amount": 0, "payer_bank": "", "payee_address": "北京", "goods_amount": 3.53, "goods_tax": 0.47, "created": 1549943699000, "invoice_remark": "", "discount_tax": 0, "shop_name": "莫胜男的店铺", "payee_telno": "15936892345", "payee_remark": "", "sum_tax": 0.47, "payee_name": "百望", "payer_name": "个人", "payee_checker": "王小二", "serial_no": "", "status": 20, "sum_price": 3.53 }] } } |
{ "status": 100, "message": "参数中必须包含起止时间" } |