1. Pulling Up Invoice List from Weixin Official Account

2. Pulling Up Invoice List from Weixin Mini Program

3. Pulling Up Invoice List from Weixin Work

4. Pulling Up Invoice List from External App

5. Querying Reimbursement Invoice Information

6. Querying Reimbursement Invoice Information in Batch

7. Updating Invoice Status by Reimburser

8. Updating Invoice Statuses in Batch by Reimburser

9. Error Codes

10. List of Invoice Reimbursement Status

# 1. Pulling Up Invoice List from Weixin Official Account

API description

This API is used to pull up an invoice card list in a Weixin Official Account. After a user selects an invoice to submit for reimbursement, the developer obtains identification information for the selected invoice.

Calls to this API must follow the JS-SDK call method. Before development, read the [Weixin JS-SDK API Documentation](http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN" target="_blank) to get familiar with the development terminology and basic API calls.

Request method

Call the chooseInvoice API.

Request parameters

Response

After the user taps OK or Cancel, a result containing the following fields is returned.

The choose_invoice_info object contains the following fields:

Sample code

wx.config({
    beta: true,
    debug: false,
    appId: "wx00000000000000",
    timestamp: 1489030247,
    nonceStr: "(9J4YRV[#@",
    signature: "f027317f8910000000000000000000",
    jsApiList: ['chooseInvoice']
});
wx.ready(function () {
    wx.invoke('chooseInvoice', {
        'timestamp': 1489030247, 
        'nonceStr': "p(6N&7WOAF", 
        }, function(res) {
            alert(JSON.stringify(res));
        }
    });
});

# 2. Pulling Up Invoice List from Weixin Mini Program

API description

This API is used to pull up an invoice list in a Weixin Mini Program.

See the invoice section in the Mini Program API documentation for details.

# 3. Pulling Up Invoice List from Weixin Work

API description

Weixin Work 2.1 comes with a JS-API to select electronic invoices. After a company updates its Weixin Work version to 2.1 or later, it can quickly implement electronic invoice selection in Weixin Work.

See the electronic invoice section in the Weixin Work API documentation for details.

# 4. Pulling Up Invoice List from External App

API description

For companies with self-deployed mobile office apps and reimbursement service providers who provide independent reimbursement apps to companies, Weixin provides an API that allows external apps to pull up the invoice list. Just like the API to pull up the invoice list in Weixin, external app developers can obtain invoice identification data after a user selects an invoice and taps OK.

Calls to this API must follow the JS-SDK calling method. Before development, make sure the following conditions are met:

(1) You have a verified Weixin Open Platform account.

(2) You have created an app on the Weixin Open Platform and it has passed the verification. Developers of unregistered apps can register their apps on the app registration page.

(3) You have read the basic SDK usage methods in the Weixin Open Platform Resource Center and the SDKs are correctly used in your app.

Request method

iOS apps

Refer to the OpenSDK1.7.7 file in the code package. During use, call the WXChooseInvoice class. Refer to the JS-SDK call method for information about the required signature. Sample code

—(void)getlnvoiceWithTicket: (NSString*)ticket whenComptetion: (void(^)(NSString* result, NSString*errorDesc) )comptetion{
BOOL isWXApplnstalled = [WXApi isWXApplnstalled]; 
if (!isWXApplnstalled) { // The result is directly returned if Weixin is not installed.
completion(nil.,@"Wechat Not installed");
return;
}
_completion = completion;
WXChooselnvoiceReq *cardReq = [[WXChooselnvoiceReq alloc]initl; 
cardReq. applD = WechatlnvoiceAppld;
cardReq.timeStamp = [[NSDate date]timelntervalSince1970]; 
NSString* timeStamp = [NSString stringWithFormat:@"%d",cardReq.timeStamp]; 
cardReq. nonceStr = @"sfim_invoice";

NSString *cardSign = [self genCardSignWithNonceStr: cardReq.nonceStr andTimeStr:
timeStamp andApiTicket:ticket];
cardReq.cardSign = cardSign;
[WXApi sendReq:cardReq];//Send

Android apps

Refer to the JAR file in the code package. During use, call the ChooseCardFromWXCardPackage class and set the CardType to "INVOICE". Refer to the JS-SDK call method for information about the required signature.

Response

After the user taps OK or Cancel, a result containing the following fields is returned.

The choose_invoice_info object contains the following fields:

# 5. Querying Reimbursement Invoice Information

API description

This API is used to query the structured information of an electronic invoice and obtain the invoice's PDF file.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/reimburse/getinvoiceinfo?access_token={access_token}

Request method: POST

Request parameters

The request parameters use JSON format and contain the following fields:

Response

The returned result is in JSON format and contains the following fields:

If the error code is 0, the following information is returned:

user_info contains the following information:

info provides the information of invoice items. The data is expressed as an Object list, and each Object in the list includes the following information:

Sample code

Request:
{
    "card_id": "pjZ8Yt5crPbAouhFqFf6JFgZv4Lc",
    "encrypt_code": "fbdt/fWy1VitQwhbKtSjNeR3BJyfpeJXfZjjGsdCXiM="
}
Response:
{
    "errcode": 0,
    "errmsg": "ok",
    "card_id": "pjZ8Yt5crPbAouhFqFf6JFgZv4Lc",
    "begin_time": 1476068114,
    "end_time": 1476168114,
    "user_card_status": "EXPIRE",
    "openid": "obLatjnG4vRXJvSO8p914rSK8-Vo",
    "type": "Guangdong VAT invoice",
    "payee": "Test - Payee",
    "detail": "Test - detail",
    "user_info": {
        "fee": 1100,
        "title": "XX company",
        "billing_time": 1468322401,
        "billing_no": "hello",
        "billing_code": "world",
            "info": [
                {
                    "name": "Green Giant",
                    "num": 10,
                    "unit": "Tons",
                    "price": 4
                }
        ],
        "accept": true,
        "fee_without_tax": 2345,
        "tax": 123,
        "pdf_url": "pdf_url",
        " reimburse_status": "INVOICE_REIMBURSE_INIT",
    }
}

# 6. Querying Reimbursement Invoice Information in Batch

API description

This API is used to query the structured information of electronic invoices in batch and obtain their PDF files.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/reimburse/getinvoicebatch?access_token={access_token}

Request method: POST

Request parameters

The request parameters use JSON format and contain the following fields:

Each object in the item_list contains the following fields:

Response

The returned result is in JSON format and contains the following fields:

If the error code is 0, each object in the item_list contains the following information:

user_info contains the following information:

info provides the information of invoice items. The data is expressed as an Object list, and each Object in the list includes the following information:

Sample code

Request:
{
    "item_list": [
        {
            "card_id": "pjZ8Yt7KKEXWMpETmwG2ZZxX2m6E",
            "encrypt_code": "O/mPnGTpBu22a1szmK2 "
        },
        {
            "card_id": "pjZ8YtxSguaLUaaDqzeAf385soJM",
            "encrypt_code": "O/mPnGTpBu22a1szmK2ogz "
        }
    ]
}
Response:
{
    "errcode": 0,
    "errmsg": "ok",
    "item_list": [
        {
            "user_info": {
                "fee": 123,
                "title": "Guan Ge's invoice",
                "billing_time": 1504085973,
                "billing_no": "1504085973",
                "billing_code": "aabbccdd",
                "info": [
                    {
                        "name": "Toothpaste",
                        "num": 3,
                        "unit": "Tube"
                        "price": 10000
                    }
                ],
                "fee_without_tax": 2345, 
                "tax": 123, 
                "detail": "Item", 
                "pdf_url": "http://pdfurl", 
                "reimburse_status": "INVOICE_REIMBURSE_INIT", 
                "order_id": "1504085935", 
                "check_code": "check_code", 
                "buyer_number": "buyer_number"
            }, 
            "card_id": "pjZ8Yt7KKEXWMpETmwG2ZZxX2m6E", 
            "openid": "oZI8Fj8L63WugQsljlzzfCcw3AkQ", 
            "type": "Guangdong VAT invoice", 
            "payee": "Test - Payee", 
            "detail": "detail"
        }, 
        {
            "user_info": {
                "fee": 123, 
                "title": "Guan Ge's invoice", 
                "billing_time": 1504083578, 
                "billing_no": "1504083578", 
                "billing_code": "aabbccdd", 
                "info": [
                    {
                        "name": "Toothpaste", 
                        "num": 3, 
                        "unit": "Tube" 
                        "price": 10000
                    }
                ], 
                "fee_without_tax": 2345, 
                "tax": 123, 
                "detail": "Item", 
                "pdf_url": " http://pdfurl", 
                "reimburse_status": "INVOICE_REIMBURSE_INIT", 
                "order_id": "1504083522", 
                "check_code": "check_code", 
                "buyer_number": "buyer_number"
            }, 
            "card_id": "pjZ8YtxSguaLUaaDqzeAf385soJM", 
            "openid": "oZI8Fj8L63WugQsljlzzfCcw3AkQ", 
            "type": "Guangdong VAT invoice", 
            "payee": "Test - Payee", 
            "detail": "detail"
        }
    ]
}

# 7. Updating Invoice Status by Reimburser

API description

Reimbursing companies and reimbursement service providers can use this API to lock, unlock, or reimburse an invoice, as described below:

Lock: The electronic invoice should be locked after it enters the reimbursement process of the company. After an electronic invoice is locked, it still appears in the user's Cards & Offers, but cannot be submitted for reimbursement again.

Unlock: When the reimbursement process cannot be completed for an electronic invoice, it should be unlocked. After an electronic invoice is unlocked, it can be submitted for reimbursement again.

Reimburse: After an electronic invoice is reimbursed, this API should be used to perform the reimbursement operation. After this operation is performed, the electronic invoice is removed from the user's Cards & Offers. The user can view the electronic invoice's write-off information in the Cards & Offers messages. Note that the reimbursement operation is irreversible so call this API with caution.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/reimburse/updateinvoicestatus?access_token={access_token}

Request method: POST

Request parameters

The request parameters use JSON format and contain the following fields:

Response

The returned result is in JSON format and contains the following fields:

Sample code

Request:
{
    "card_id": "pjZ8Yt5crPbAouhFqFf6JFgZv4Lc",
    "encrypt_code": "fbdt/fWy1VitQwhbKtSjNeR3BJyfpeJXfZjjGsdCXiM=",
    "reimburse_status": "INVOICE_REIMBURSE_INIT"
}
Response:
{
    "errcode": 0,
    "errmsg": "ok"
}

# 8. Updating Invoice Statuses in Batch by Reimburser

API description

An invoicing platform can call this API to lock, unlock, or reimburse multiple invoices. Note that once an invoice is changed to the reimbursed status, it cannot be changed back. Therefore, call this API with caution.

Notes:

1. The reimburser must ensure that, after invoices are reimbursed, locked, or unlocked, the new statuses are promptly synced with Weixin to ensure user invoices can be used normally.

2. The API for batch update of invoice statuses is a transactional operation. If any invoice fails to be updated, the statuses of the other invoices in the list will not be changed. All invoices will revert to their statuses before the API was called.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/reimburse/updatestatusbatch?access_token={access_token}

Request method: POST

Request parameters

The request parameters use JSON format and contain the following fields:

Each object in the invoice_list contains the following fields:

Response

The returned result is in JSON format and contains the following fields:

Sample code

Request:
{
    "openid": "{openid}",
    "reimburse_status": "{reimburse_status}",
    "invoice_list":
    [
        {"card_id":"cardid_1","encrypt_code":"encrypt_code_1"},
        {"card_id":"cardid_2","encrypt_code":"encrypt_code_2"}
    ]
}
Response:
{
    "errcode": 0,
    "errmsg": "ok"
}

# 9 Error Codes

# 10. List of Invoice Reimbursement Status