当前位置: API文档
vip_invoice_info_query.php(查询开票数据)
1.1 接口描述:获取税控等开发票系统需要的开票数据 |
1.2 适用版本:客户端 V2.4.5.0及以上版本 |
1.3 增量获取:按照旺店通ERP中发票的最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。 |
1.4 时间跨度:start_time和end_time最大跨度为30天,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,建议根据获取数据量的多少适当减小时间跨度。 |
1.5 注意事项:淘系平台开票数据无法从本接口获取,如需获取淘系平台发票信息,需走奇门线上ERP-线下ERP进行处理。如需开票请联系旺店通销售开通“阿里电子发票”增值功能进行发票的开具。 |
2.1 开票系统(金壬、航天金税等)接入ERP |
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/vip_invoice_info_query.php |
正式环境 | https://api.wangdian.cn/openapi2/vip_invoice_info_query.php |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | 是 | 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 | |
接口账号 | appkey | String | 是 | 本开放平台“自助对接”功能模块内自助申请,获取方式点击这里 | |
时间戳 | timestamp | int | 是 | 北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。 | |
签名 | sign | String | 是 | API输入参数签名结果,签名算法介绍单击这里 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
开始时间 | start_time | datetime | 是 | 按最后修改时间增量获取数据,start_time作为开始时间,时间格式:yyyy-MM-dd HH:mm:ss | |
结束时间 | end_time | datetime | 是 | 按最后修改时间增量获取数据,end_time作为结束时间,时间格式:yyyy-MM-dd HH:mm:ss | |
分页大小 | page_size | int | 否 | 每页返回的数据条数,默认30,最大100条单击这里 | |
页号 | page_no | int | 否 | 不传值默认从0页开始 | |
发票状态 | status | int | 4 | 是 | 输入可选值:0 已取消 60 待开票 80 开票成功 |
开票服务商子类别 | category_order | int | 11 | 是 | 可选值:1 金壬 (纸质票)200 阿里电子发票(注:阿里电子发票信息仅限查询80开票成功的发票信息,其他发票状态不返回)399其他(电子票,除阿里电子发票之外的服务商使用) 400 百望云(数电票) 401 航信(数电票) |
店铺编号 | shop_no | varchar | 40 | 否 | 按照店铺维度进行数据请求,V2.4.5.0及以上版本可使用此参数请求 |
订单编号 | trade_no | varchar | 40 | 否 | 发票对应的erp系统内生成的销售订单编号 |
原始订单号 | src_tid | varchar | 255 | 否 | 发票对应的平台的销售订单编号,ERP系统手工新建订单 |
发票编号 | invoice_no | varchar | 20 | 否 | 发票编号,ERP系统内部自动生成,在ERP发票管理为唯一编号 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 11 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
数据条数 | total_count | int | 11 | 否 | 只有page_no = 0 时才返回的符合条件的数据总条数,用来分页 |
发票列表节点 | info | data[ ] | 是 | 响应参数的1级数据节点,包含当前页的xxxx的数据节点,节点下数据字段详见下述“xxx”节点和"xxx"节点 |
info
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
发票id | invoice_id | int | 11 | 是 | 发票主键 |
发票编号 | invoice_no | varchar | 20 | 是 | 系统内部自动生成的发票编号,ERP发票管理唯一 |
订单ID | trade_id | int | 11 | 是 | ERP内系统订单id,系统订单主键 |
订单编号 | trade_no | varchar | 40 | 是 | ERP内订单编号 |
店铺编号 | shop_no | varchar | 20 | 是 | 店铺编号 |
店铺名称 | shop_name | varchar | 128 | 是 | 店铺名称 |
下载地址 | file_path | varchar | 1024 | 是 | 下载地址 |
发票状态 | status | tinyint | 4 | 是 | 发票状态值:0 已取消 60 待开票 80 开票成功 |
发票红蓝字 | type | tinyint | 4 | 是 | 1 蓝字发票; 2 红字发票 |
抬头类型 | payer_type | tinyint | 4 | 是 | 发票抬头类型 1 商家对个人开具 2 商家对企业开具 |
发票抬头 | payer_name | varchar | 64 | 是 | 订单付款方的名称 |
税务登记证号 | payer_register_no | varchar | 40 | 是 | 付款方税务登记证号,如果对企业开具,必填 |
付款方联系电话 | payer_phone | varchar | 20 | 是 | 付款方联系电话,如果为增值税专用发票的话,必填 |
付款方email | payer_email | varchar | 64 | 是 | 付款方email |
地址 | payer_address | varchar | 255 | 是 | 付款方地址 |
银行名称 | payer_bank | varchar | 255 | 是 | 付款方银行名称 |
银行账户 | payer_account | varchar | 30 | 是 | 付款方银行账户 |
买家税号 | payer_register_no | varchar | 40 | 是 | 付款方税号 |
开票人 | payee_operator | varchar | 20 | 是 | 开票人 |
收款人 | payee_receiver | varchar | 20 | 是 | 收款人 |
复核人 | payee_checker | varchar | 20 | 是 | 复核人 |
收件人 | receiver_name | varchar | 20 | 是 | 收件人 |
收件人联系方式 | receiver_phone | varchar | 20 | 是 | 收件人联系电话 |
收件人地址 | receiver_address | varchar | 255 | 是 | 收件人详细地址 |
总金额 | invoice_amount | decimal | (19,4) | 是 | 开票总金额(实际合计金额+实际合计税额) |
合计金额 | goods_amount | decimal | (19,4) | 是 | 货品合计金额(未扣除折扣)等于明细中sum_price的总和 |
合计税额 | goods_tax | decimal | (19,4) | 是 | 货品合计税额(未扣除折扣)等于明细中tax的总和 |
税前折扣金额 | discount | decimal | (19,4) | 是 | 税前折扣金额 等于明细中discount的总和 |
折扣税额 | discount_tax | decimal | (19,4) | 是 | 折扣税额等于明细中discount_tax的总和 |
实际合计金额 | sum_price | decimal | (19,4) | 是 | 实际合计金额(货品合计金额-税前折扣金额) goods_amount减去discount等于sum_price |
实际合计税额 | sum_tax | decimal | (19,4) | 是 | 实际合计税额(货品合计税额-折扣税额)goods_tax减去discount_tax等于sum_tax |
发票备注 | invoice_remark | varchar | 255 | 是 | 发票备注 |
发票类型 | device_no | int | 4 | 是 | 发票类型:1普通发票 2增值税普通发票3增值专用税发票 |
冲红原因 | extra_1 | int | 4 | 是 | 冲红原因 1:销货退回 2:开票错误 3:服务中止 4:销售折让 |
发票种类 | invoice_category | tinyint | 4 | 是 | 发票种类:0纸质发票 1电子发票 2数电票 |
备注 | remark | varchar | 255 | 是 | 备注 |
原始单号 | src_tids | varchar | 255 | 是 | 原始单号 |
出库单号 | stockout_no | varchar | 40 | 是 | 出库单号 |
收款方公司id | payee_id | int | 11 | 是 | 收款方公司id |
收款方公司名称 | payee_name | varchar | 64 | 是 | 收款方公司名称 |
收款方地址 | payee_address | varchar | 255 | 是 | 收款方地址 |
收款方联系电话 | payee_telno | varchar | 20 | 是 | 收款方联系电话 |
收款方银行 | payee_bank_name | varchar | 64 | 是 | 收款方银行 |
收款方银行账户 | payee_bank_account | varchar | 64 | 是 | 收款方银行账户 |
收款方备注 | payee_remark | varchar | 255 | 是 | 收款方备注 |
开票服务商id | invoice_provider_id | int | 11 | 是 | 开票服务商id |
开票服务商名称 | invoice_provider_name | varchar | 40 | 是 | 开票服务商名称 |
发票创建时间 | created | datetime | 是 | 发票创建时间,时间格式:yyyy-MM-dd HH:mm:ss | |
开票时间 | invoice_time | datetime | 是 | 开票时间,时间格式:yyyy-MM-dd HH:mm:ss | |
最后修改时间 | modified | datetime | 是 | 发票最后修改时间,时间格式:yyyy-MM-dd HH:mm:ss | |
发票号码 | invoice_no_out | varchar | 20 | 是 | 发票号码 |
发票代码 | invoice_code | varchar | 20 | 是 | 发票代码 |
关联发票号码 | relation_invoice_no_out | varchar | 20 | 是 | 红字发票对应蓝票的发票号码 |
关联发票代码 | relation_invoice_code | varchar | 20 | 是 | 红字发票对应蓝票的发票代码 |
红字发票申请单号 | red_invoice_apply_no | varchar | 40 | 是 | 增值税专票红字冲销时的红字发票通知单号(待新增,V2.4.3.0及以上版本可响应此参数请求) |
发票明细节点 | details | data[ ] | 是 | 响应参数的2级数据节点,包含系统发票明细所有属性信息的数据节点,节点下数据字段详见下述"details" | |
货品明细节点 | goods_list | data[ ] | 是 | 响应参数的2级数据节点,包含系统发票明细货品信息的数据节点,节点下数据字段详见下述"goods_list" |
details
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
原始单号 | src_tid | varchar | 255 | 是 | 原始单号 |
原始子单号 | src_oid | varchar | 40 | 是 | 原始子订单号 |
发票项目名称 | item_name | varchar | 255 | 是 | 发票项目名称,即商品名称 |
发票项目编码 | item_no | varchar | 100 | 是 | 发票项目编码,即规格名称 |
单位 | unit | varchar | 20 | 是 | 单位 |
数量 | num | decimal | (19,4) | 是 | 数量 |
税务编码 | tax_code | varchar | 40 | 是 | 税务编码 |
税率 | tax_rate | decimal | (19,4) | 是 | 税率 |
税前单价 | price | decimal | (19,6) | 是 | 税前单价(未扣除折扣) |
税前总价 | sum_price | decimal | (19,4) | 是 | 税前总价(未扣除折扣) |
税额 | tax | decimal | (19,4) | 是 | 税额(未扣除折扣) |
总价 | sum_amount | decimal | (19,4) | 是 | 总价(未扣除折扣),税额+税前总价 |
税前折扣金额 | discount | decimal | (19,4) | 是 | 税前折扣金额 |
折扣税额 | discount_tax | decimal | (19,4) | 是 | 折扣税额 |
折扣总价 | discount_amount | decimal | (19,4) | 是 | 折扣总价(折扣税额+税前折扣金额) |
是否折扣 | discount_flag | tinyint | 4 | 是 | 是否有折扣: 0 无 1 有 |
备注 | remark | varchar | 255 | 是 | 备注 |
goods_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
原始订单号 | src_tid | varchar | 40 | 是 | 原始订单号 |
原始子单号 | src_oid | varchar | 40 | 是 | 原始子单号 |
是否是赠品 | gift_type | tinyint | 1 | 是 | 是否是赠品 0非赠品 1自动赠送 2手工赠送 |
退款状态 | refund_status | tinyint | 1 | 是 | 退款状态: 0无退款,1取消退款,2已申请退款,3等待退货,4等待收货,5退款成功 |
下单数量 | num | decimal | 19,4 | 是 | 货品数量 |
标价 | price | decimal | (19,4) | 是 | 销售单价,手工新建时使用货品属性中的“零售价” |
实发数量 | actual_num | decimal | 19,4 | 是 | 实发数量,此数量为发货数量 |
成交价 | order_price | decimal | (19,4) | 是 | 成交价,原始单折扣及分摊之后的价格 |
分摊后价格 | share_price | decimal | (19,4) | 是 | 分摊后价格 |
分摊邮费 | share_post | decimal | (19,4) | 是 | 分摊邮费 |
已付金额 | paid | decimal | (19,4) | 是 | 已支付金额 |
货品名称 | goods_name | varchar | 255 | 是 | 货品名称 |
货品编号 | goods_no | varchar | 40 | 是 | 代表货品(spu)所有属性的编号,SPU概念介绍,单击这里 |
规格名称 | spec_name | varchar | 100 | 是 | 规格名称 |
商家编码 | spec_no | varchar | 40 | 是 | 代表单品(sku)所有属性的编码,SKU概念介绍,单击这里 |
规格码 | spec_code | varchar | 40 | 是 | 规格码 |
组合装编码 | suite_no | varchar | 40 | 是 | 组合装编码 |
组合装名称 | suite_name | varchar | 255 | 是 | 组合装名称 |
组合装数量 | suite_num | decimal | (19,4) | 是 | 组合装数量 |
平台货品名称 | api_goods_name | varchar | 255 | 是 | 平台货品名称 |
平台规格名称 | api_spec_name | varchar | 100 | 是 | 平台规格名称 |
6.响应示例
6.1 正常响应示例
6.2 异常响应示例
JSON | { "code": 1060, "message": "充值余额为0或应用已欠费,请联系商务充值 " } |