文档中心 > API类目 > 电子发票

alibaba.einvoice.prod.apply.get (查询发票申请)

查询申请的详细信息,包含申请所关联的发票摘要信息+板式文件+预览图; 场景使用:1、业务前台收到申请状态变更消息后,调用此接口查询申请详情;2、主动补偿查询:当指定了自动开票,且发票申请长时间未收到状态变更通知时,可能存在丢消息的情况,此时可主动查询该申请,然后更新本地工单状态。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
invoice_apply_query_dto InvoiceApplyDtlQueryDto 必须 查询申请请求
  • └ apply_id
  • String
  • 必须
  • 123456
  • 中台发票申请ID,由中台生成。字母或数字组成。 可用于查询发票申请的详情。
  • └ need_download_url
  • Boolean
  • 可选
  • false
  • 是否需要生成发票板式文件的下载链接。默认为:false不生成。 调用方请根据使用场景而定。 true: 生成新的发票下载链接,拆单情况下生成多张发票链接响应时间较长,建议设置超时时间为6s. false: 不生成下载链接,查询响应时间更快。调用方如果不需要发票链接,或者有对接查询发票详情接口时,此处建议传false

响应参数

名称 类型 示例值 描述
result ServiceResult 系统返回的通用结果类
  • invoice_apply_dtl
  • InvoiceApplyDtlDto
  • 发票申请详情
  • └ apply_amount
  • String
  • 100.00
  • 合计实付金额(申请开票的总金额,含税),格式为2位小数。开红票时传正数。 需满足公式:开票总金额(invoiceAmount) = 各项明细的交易金额(amount)之和 - 各项明细的优惠金额(discount)之和。 当指定auto_create_invoice=true或商户配置为自动开票时该字段必填。
  • └ apply_id
  • String
  • 123456
  • 发票申请ID
  • └ apply_mode
  • String
  • normal
  • 发票申请模式,可选值: pre_apply_url: URL预申请模式;适用于扫码开票(一单一码)的业务场景:业务前台提交开票金额等信息,请求阿里发票平台生成一个对应的发票申请页面URL。用户可在该页面中填写抬头等信息,然后提交正式的发票申请。 normal(默认为此模式): 正式提交用户的发票申请,商户根据此发票申请自动或审核开票。
  • └ apply_status
  • String
  • 200
  • 申请状态,可选值: applying: 申请中,初始状态 cancelled: 申请已取消 confirmed: 商户已确认,待开/待录入发票 creating_inv: 开票中,待发票结果回传 inv_failed: 开票失败 inv_success: 开票成功 inv_part_success: 部分成功(拆单场景下存在。举例:发票申请拆单之后有10张票,其中有1张开票成功时,此时申请状态即为inv_part_success,当10张票全部成功申请状态则为inv_success)
  • └ business_type
  • Number
  • 1
  • 抬头类型。可选值: 0:个人 1:企业
  • create_inv_results
  • InvoiceCreateSimpleResultDto []
  • 该申请单 请求开票的结果,拆单的场景下可能有多笔发票请求 当apply_status为creating_inv, inv_failed, inv_success, inv_part_success 时返回该字段
  • └ anti_fake_code
  • String
  • CF6B2F6168420008
  • 防伪码
  • └ biz_error_code
  • String
  • demo
  • 错误编码 当开票失败时返回
  • └ biz_error_msg
  • String
  • demo
  • 错误信息 当开票失败时返回
  • └ create_status
  • String
  • waiting
  • 开票状态,可选值: (waiting = 开票中) 、(create_success = 开票成功)、(create_failed = 开票失败)
  • └ download_url
  • String
  • http://xxxx
  • 发票板式文件的下载地址。 need_download_url=true时返回。默认不生成。
  • └ download_url_expires
  • String
  • http://xxxx
  • 发票板式文件下载地址(download_url)和预览图地址(invoice_image_url)的失效时间。 过期之后板式文件下载地址将无法访问,可以重新调用此接口,重新生成访问链接。 格式为:yyyy-MM-dd HH:mm:ss
  • └ error_type
  • String
  • sys
  • 错误类型,开票失败时必传。 可选值: biz: 业务错误,重试也无法开票。需要商户人工处理申请之后重新开票。 tax: 税控设备问题导致的开票失败,税控设备就绪后 可以由商户触发重试。 sys: 系统错误,中台重试一定次数后仍然失败的。
  • └ invoice_amount
  • String
  • 1170.00
  • 合计含税金额(实际开票金额),格式为2位小数。 当开红票时,该字段为负数。
  • └ invoice_code
  • String
  • 1231231234
  • 发票代码
  • └ invoice_date
  • String
  • 2020-01-21
  • 开票日期; 当开票成功时必选
  • └ invoice_image_url
  • String
  • http://xxxx
  • 发票预览图的下载地址。 need_download_url=true时返回。默认不生成。
  • └ invoice_kind
  • Number
  • 0
  • 开票发票类型,可选值: 0: 电票 1:纸质普票 2:纸质专票
  • └ invoice_no
  • String
  • 12345678
  • 发票号码
  • └ payee_name
  • String
  • 阿里巴巴测试企业
  • 销方名称,公司名
  • └ payee_register_no
  • String
  • QWERTY123467890
  • 销方税号
  • └ product_code
  • String
  • OEM_OWNTAX_ASYNC
  • 税控产品,产品码由中台定义。
  • └ red_apply_id
  • String
  • 1234567
  • 红票申请ID
  • └ red_create_status
  • String
  • --
  • 红票申请状态,定义同create_status
  • └ single_serial_no
  • String
  • 1001
  • 开票流水号/序列号,唯一标志一笔开票请求。发票中台发起开票后生成,可用于查询单张发票。
  • └ sum_price
  • String
  • 1000.00
  • 合计金额(不含税),格式为2位小数。 当开红票时,该字段为负数
  • └ sum_tax
  • String
  • 170.00
  • 合计税额,格式为2位小数。 当开红票时,该字段为0或负数
  • create_inv_payee_info
  • InvoiceCreatePayeeInfoDto
  • --
  • 请求开票的销方信息 间联开票模式下,该字段无值。若调用方需要获取开具发票的销方信息,可调用查询发票详情接口
  • └ payee_address
  • String
  • 杭州市西溪路
  • 销方地址 销方电话加地址不超出100字符
  • └ payee_bank_account_id
  • String
  • 92523123213412341234
  • 销方银行帐号
  • └ payee_bank_name
  • String
  • 招商银行西溪路支行
  • 销方开户行名称
  • └ payee_checker
  • String
  • 李四
  • 复核人
  • └ payee_name
  • String
  • 阿里巴巴测试企业
  • 销方企业名称
  • └ payee_operator
  • String
  • 张三
  • 开票人
  • └ payee_phone
  • String
  • 12345678
  • 销方电话
  • └ payee_receiver
  • String
  • 王五
  • 收款人
  • └ payee_register_no
  • String
  • QWERTY1234567890
  • 销方税号
  • └ is_finally
  • Boolean
  • true
  • 当前申请单是否为已终结状态。true: 是,false: 否。 主要用于区分inv_part_success状态下是终态还是中间态。
  • └ gmt_create
  • Date
  • 2020-10-10 00:00:00
  • 申请创建时间
  • └ gmt_modified
  • Date
  • 2020-10-10 00:00:00
  • 申请最近修改时间
  • invoice_items
  • InvoiceApplyItemsDto []
  • --
  • 申请明细列表
  • └ amount
  • String
  • 1170.00
  • 交易金额(含税)=单价*数量 单位:元,格式为2位小数,精度2位小数
  • └ discount
  • String
  • 0
  • 优惠金额(含税)可为0 交易金额-优惠价金额=实付金额 单位:元,格式为2位小数,精度2位小数
  • └ item_name
  • String
  • 稻谷
  • 商品名称/货物名称
  • └ item_no
  • String
  • 1010101010000000000
  • 发票项目编号(或商品编号) 业务前台未传值中台会做税编规则匹配。 业务前台有传值则优先取前台传入的值。
  • └ quantity
  • String
  • 1
  • 数量,最多6位小数
  • └ specification
  • String
  • x100
  • 规格型号
  • └ tax_price
  • String
  • 100.00
  • 单价(含税),格式为2位小数。最大支持6位小数,不足2位小数时需转化为2位小数格式。
  • └ tax_rate
  • String
  • 0.13
  • 税率。格式为2位小数, 业务前台未传值中台会做税编规则匹配。 业务前台有传值则优先取前台传入的值。
  • └ unit
  • String
  • 单位
  • └ zero_rate_flag
  • String
  • 0
  • 0税率标识,0=出口零税率,1=免税,2=不征收,3=普通零税率
  • └ invoice_kind
  • Number
  • 0
  • 申请开票类型,可选值: 0: 电票 1:纸质普票 2:纸质专票
  • └ invoice_memo
  • String
  • 123
  • 发票备注
  • └ invoice_type
  • String
  • blue
  • 发票(开票)类型,可选值: blue: 蓝票 red: 红票
  • └ normal_invoice_code
  • String
  • 111100000000
  • 原发票代码; 申请红票时必传
  • └ normal_invoice_no
  • String
  • 00004349
  • 原发票号码; 申请红票时必传
  • └ outer_id
  • String
  • S0000001
  • 外部业务方创建入驻工单的唯一幂等ID, 由业务方自己生成。 由字母数字组成
  • └ payee_register_no
  • String
  • QWERTY0000001
  • 纳税人识别号
  • └ payer_address
  • String
  • 浙江省杭州市余杭区文一西路xxx号
  • 购方地址, 专票必填。
  • └ payer_bank_account_id
  • String
  • 123412341234
  • 购方银行账号, 专票必填。
  • └ payer_bank_name
  • String
  • 招商银行
  • 购方开户行名称, 专票必填。
  • └ payer_email
  • String
  • mytest@xxx.com
  • 购方电子邮箱
  • └ payer_memo
  • String
  • 测试
  • 购方开票备注。不会显示在票面
  • └ payer_name
  • String
  • 张三
  • 购方抬头
  • └ payer_phone
  • String
  • 18234561212
  • 购方联系电话, 专票必填。
  • └ payer_register_no
  • String
  • 2015020123123
  • 购方方税务登记证号, 开企业抬头时必填, 专票必填。
  • └ payer_uid
  • String
  • 123456
  • 购方UID
  • └ platform_biz_flag
  • String
  • 1,2,3
  • 业务前台的业务标记。 提供给业务前台打上特殊的业务标识,解决前台一些特殊场景,阿里发票不关心该字段的业务含义。
  • └ platform_code
  • String
  • ABC
  • 业务平台code, 由发票中台分配
  • └ platform_tid
  • String
  • 100011101
  • 业务平台发票申请对应的订单号
  • └ platform_user_id
  • String
  • 12345678
  • 业务平台商户ID
  • └ red_notice_no
  • String
  • 12312312
  • 红字发票信息表编号。 专票冲红时需要,商家跟税局申请

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaEinvoiceProdApplyGetRequest req = new AlibabaEinvoiceProdApplyGetRequest();
AlibabaEinvoiceProdApplyGetRequest.InvoiceApplyDtlQueryDto obj1 = new AlibabaEinvoiceProdApplyGetRequest.InvoiceApplyDtlQueryDto();
obj1.setApplyId("123456");
obj1.setNeedDownloadUrl(false);
req.setInvoiceApplyQueryDto(obj1);
AlibabaEinvoiceProdApplyGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_einvoice_prod_apply_get_response>
    <result>
        <invoice_apply_dtl>
            <apply_amount>100.00</apply_amount>
            <apply_id>123456</apply_id>
            <apply_mode>normal</apply_mode>
            <apply_status>200</apply_status>
            <business_type>1</business_type>
            <create_inv_results>
                <invoice_create_simple_result_dto>
                    <anti_fake_code>CF6B2F6168420008</anti_fake_code>
                    <biz_error_code>demo</biz_error_code>
                    <biz_error_msg>demo</biz_error_msg>
                    <create_status>waiting</create_status>
                    <download_url>http://xxxx</download_url>
                    <download_url_expires>http://xxxx</download_url_expires>
                    <error_type>sys</error_type>
                    <invoice_amount>1170.00</invoice_amount>
                    <invoice_code>1231231234</invoice_code>
                    <invoice_date>2020-01-21</invoice_date>
                    <invoice_image_url>http://xxxx</invoice_image_url>
                    <invoice_kind>0</invoice_kind>
                    <invoice_no>12345678</invoice_no>
                    <payee_name>阿里巴巴测试企业</payee_name>
                    <payee_register_no>QWERTY123467890</payee_register_no>
                    <product_code>OEM_OWNTAX_ASYNC</product_code>
                    <red_apply_id>1234567</red_apply_id>
                    <red_create_status>--</red_create_status>
                    <single_serial_no>1001</single_serial_no>
                    <sum_price>1000.00</sum_price>
                    <sum_tax>170.00</sum_tax>
                </invoice_create_simple_result_dto>
            </create_inv_results>
            <create_inv_payee_info>
                <payee_address>杭州市西溪路</payee_address>
                <payee_bank_account_id>92523123213412341234</payee_bank_account_id>
                <payee_bank_name>招商银行西溪路支行</payee_bank_name>
                <payee_checker>李四</payee_checker>
                <payee_name>阿里巴巴测试企业</payee_name>
                <payee_operator>张三</payee_operator>
                <payee_phone>12345678</payee_phone>
                <payee_receiver>王五</payee_receiver>
                <payee_register_no>QWERTY1234567890</payee_register_no>
            </create_inv_payee_info>
            <is_finally>true</is_finally>
            <gmt_create>2020-10-10 00:00:00</gmt_create>
            <gmt_modified>2020-10-10 00:00:00</gmt_modified>
            <invoice_items>
                <invoice_apply_items_dto>
                    <amount>1170.00</amount>
                    <discount>0</discount>
                    <item_name>稻谷</item_name>
                    <item_no>1010101010000000000</item_no>
                    <quantity>1</quantity>
                    <specification>x100</specification>
                    <tax_price>100.00</tax_price>
                    <tax_rate>0.13</tax_rate>
                    <unit>斤</unit>
                    <zero_rate_flag>0</zero_rate_flag>
                </invoice_apply_items_dto>
            </invoice_items>
            <invoice_kind>0</invoice_kind>
            <invoice_memo>123</invoice_memo>
            <invoice_type>blue</invoice_type>
            <normal_invoice_code>111100000000</normal_invoice_code>
            <normal_invoice_no>00004349</normal_invoice_no>
            <outer_id>S0000001</outer_id>
            <payee_register_no>QWERTY0000001</payee_register_no>
            <payer_address>浙江省杭州市余杭区文一西路xxx号</payer_address>
            <payer_bank_account_id>123412341234</payer_bank_account_id>
            <payer_bank_name>招商银行</payer_bank_name>
            <payer_email>mytest@xxx.com</payer_email>
            <payer_memo>测试</payer_memo>
            <payer_name>张三</payer_name>
            <payer_phone>18234561212</payer_phone>
            <payer_register_no>2015020123123</payer_register_no>
            <payer_uid>123456</payer_uid>
            <platform_biz_flag>1,2,3</platform_biz_flag>
            <platform_code>ABC</platform_code>
            <platform_tid>100011101</platform_tid>
            <platform_user_id>12345678</platform_user_id>
            <red_notice_no>12312312</red_notice_no>
        </invoice_apply_dtl>
    </result>
</alibaba_einvoice_prod_apply_get_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部