定向开放文档

alipay.ebpp.invoice.detail.output.query(获取发票详细信息) 在线调试(沙箱环境)

根据发票代码,发票号码获取发票详细信息 查询权限要求: 发票属于当前isv报销单据进行状态(支持的状态有 EXPENSE_APPLY-用户已提交申请 EXPENSE_APPROVAL_PASS -报销审核通过 EXPENSE_FINISHED-报销完结)

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.ebpp.invoice.detail.output.query
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 必选 16 支付宝用户id 20880000000000000
invoice_code String 必选 12 发票代码
长度限制(10-12位)
1234567890
invoice_no String 必选 10 发票号码
长度限制(8-10位)
12345678
scene String 必选 30 获取发票明细应用场景
固定值:INVOICE_EXPENSE-发票报销
INVOICE_EXPENSE

响应参数

参数 类型 是否必填 最大长度 描述 示例值
invoice_code String 必填 12 发票代码 123456
invoice_no String 必填 10 发票号码 123
invoice_amount String 必填 10 发票金额(价税合计金额) 100.00
invoice_date String 必填 16 开票日期 2017-07-10
tax_type String 必填 20 票种
PLAIN:增值税电子普通发票
SPECIAL:增值税专用发票
PLAIN_INVOICE:增值税普通发票
PAPER_INVOICE:增值税普通发票(卷式)
SALSE_INVOICE:机动车销售统一发票
PLAIN
expense_status String 必填 30 发票报销状态
取值范围:
WAIT_EXPENSE-未报销
EXPENSE_PROCESSING-报销中
EXPENSE_FINISHED-已报销
WAIT_APPLY
invoice_type String 必填 5 发票类型
值有两种情况:blue-蓝票 red-红票
blue
invoice_status String 必填 20 发票状态
SUCCEED-成功
EXPIRED-已失效
TRANSFERRED-已转交
SUCCEED
payee_register_name String 必填 100 销售方名称 国力大酒店
has_upload_pdf String 必填 5 是否已上传发票pdf文件
false-未上传
true-已上传
false
ex_tax_amount String 选填 10 不含税金额 85.00
sum_tax_amount String 选填 10 合计税额 15.00
payee_tax_no String 选填 25 销售方税号 123456789
payee_address String 选填 100 销售方地址 浙江杭州万塘路18号
payee_phone String 选填 20 销售方电话 012-0000000
payee_bank_name String 选填 100 销售方开户银行名称 建设银行
payee_bank_account String 选填 40 销售方开户银行账号 1234
payer_name String 必填 100 购买方名称 支付宝(中国)技术有限公司
payer_tax_no String 选填 25 购买方税号 1234
payer_address String 选填 100 购买方地址 浙江杭州西湖区天目山路222号
payer_phone String 选填 20 购买方电话 1893445555555
payer_bank_name String 选填 60 购买方开户银行名称 招商银行
payer_bank_account String 选填 60 购买方开户银行账号 123556
invoice_item_content_list InvoiceItemContent 选填 发票内容项
item_name String 必填 80 发票项目名称(或商品名称) 电脑
item_no String 可选 20 商品编号 00001
item_price String 可选 20 单价,格式:100.00。新版电子发票,折扣行此参数不能传,非折扣行必传 100.00
item_quantity Number 可选 10 数量。新版电子发票,折扣行此参数不能传,非折扣行必传 10
row_type Number 必填 1 发票行性质。0表示正常行,1表示折扣行,2表示被折扣行。比如充电器单价100元,折扣10元,则明细为2行,充电器行性质为2,折扣行性质为1。如果充电器没有折扣,则值应为0 0
item_sum_price String 必填 20 单项总价,格式:100.00 100.00
item_tax_price String 必填 10 税额 10.00
item_tax_rate String 必填 3 税率 0.12
item_unit String 必填 10 单位
item_amount String 必填 20 价税合计。(等于sumPrice和tax之和) 100.00
invoice_img_url String 选填 200 发票缩略图地址 http://img.test.com
anti_fake_code String 选填 20 防伪码 14345678908765433456
has_risk Boolean 必填 5 该发票可能存在异常,请核实后使用
true:无异常
false:存在异常
true

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayEbppInvoiceDetailOutputQueryRequest request = new AlipayEbppInvoiceDetailOutputQueryRequest();
request.setBizContent("{" +
"\"user_id\":\"20880000000000000\"," +
"\"invoice_code\":\"1234567890\"," +
"\"invoice_no\":\"12345678\"," +
"\"scene\":\"INVOICE_EXPENSE\"" +
"  }");
AlipayEbppInvoiceDetailOutputQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_ebpp_invoice_detail_output_query_response": {
        "code": "10000",
        "msg": "Success",
        "invoice_code": "123456",
        "invoice_no": "123",
        "invoice_amount": "100.00",
        "invoice_date": "2017-07-10",
        "tax_type": "PLAIN",
        "expense_status": "WAIT_APPLY",
        "invoice_type": "blue",
        "invoice_status": "SUCCEED",
        "payee_register_name": "国力大酒店",
        "has_upload_pdf": "false",
        "ex_tax_amount": "85.00",
        "sum_tax_amount": "15.00",
        "payee_tax_no": "123456789",
        "payee_address": "浙江杭州万塘路18号",
        "payee_phone": "012-0000000",
        "payee_bank_name": "建设银行",
        "payee_bank_account": "1234",
        "payer_name": "支付宝(中国)技术有限公司",
        "payer_tax_no": "1234",
        "payer_address": "浙江杭州西湖区天目山路222号",
        "payer_phone": "1893445555555",
        "payer_bank_name": "招商银行",
        "payer_bank_account": "123556",
        "invoice_item_content_list": [
            {
                "item_name": "电脑",
                "item_no": "00001",
                "item_price": "100.00",
                "item_quantity": 10,
                "row_type": 0,
                "item_sum_price": "100.00",
                "item_tax_price": "10.00",
                "item_tax_rate": "0.12",
                "item_unit": "单位",
                "item_amount": "100.00"
            }
        ],
        "invoice_img_url": "http://img.test.com",
        "anti_fake_code": "14345678908765433456",
        "has_risk": true
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_ebpp_invoice_detail_output_query_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 请稍候再试
INVOICE_NOT_EXIST 发票不存在 根据发票代码+发票号码未查询到发票
INVOICE_QUERY_DENY 没有发票权限 没有发票权限
PARAMETER_ILLEGAL 参数检查失败 检查失败参数见错误描述,请仔细核对失败参数在接口中的定义