PHP WHMCS GetInvoice用法及代碼示例

檢索特定發票

請求參數

參數	類型	說明	必需的
action	string	“GetInvoice”	Required
invoiceid	int	要檢索的發票的 ID。	Required

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤
invoiceid	int	發票的 ID。
invoicenum	string	分配的順序發票編號(如果啟用)。
userid	int	擁有此發票的用戶的 ID。
date	string	發票日期。格式：YYYY-MM-DD
duedate	string	發票的到期日。格式：YYYY-MM-DD
datepaid	string	支付發票的日期。格式：YYYY-MM-DD HH:ii:ss
subtotal	float	發票上的小計。
credit	float	分配給發票的貸方數量。
tax	float	發票上收取的first-level 稅額。
tax2	float	發票上收取的second-level 稅額。
total	float	發票總額。
balance	float	發票上的剩餘數量。
taxrate	float	first-level 稅的稅率。
taxrate2	float	second-level 稅的稅率。
status	string	發票的狀態。
paymentmethod	string	發票上的付款方式，采用係統格式。
notes	string	與發票關聯的注釋。
ccgateway	bool	支付方式是否是可以提交嘗試捕獲的信用卡網關。
items	array	發票上的項目。
transactions	array	發票上的交易。

示例請求 (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'GetInvoice',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'invoiceid' => '1',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'GetInvoice';
$postData = array(
    'invoiceid' => '1',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

示例響應 JSON

{
    "result": "success",
    "invoiceid": 1,
    "invoicenum": "",
    "userid": 2361,
    "date": "2016-01-01",
    "duedate": "2020-12-30",
    "datepaid": "0000-00-00 00:00:00",
    "lastcaptureattempt": "0000-00-00 00:00:00",
    "subtotal": "15.95",
    "credit": "0.00",
    "tax": "0.00",
    "tax2": "0.00",
    "total": "15.95",
    "balance": "15.95",
    "taxrate": "0.000",
    "taxrate2": "0.000",
    "status": "Unpaid",
    "paymentmethod": "paypalcheckout",
    "notes": "",
    "ccgateway": false,
    "items": {
        "item": [
            {
                "id": 1,
                "type": "Hosting",
                "relid": 1,
                "description": "Sample Monthly Product (01\/01\/2016 - 31\/01\/2016)",
                "amount": "15.95",
                "taxed": 0
            }
        ]
    },
    "transactions": ""
}

錯誤響應

可能的錯誤條件響應包括：

• 未找到發票 ID