PHP WHMCS ApplyCredit用法及代碼示例

將客戶的信用應用於發票

請求參數

參數	類型	說明	必需的
action	string	“ApplyCredit”	Required
invoiceid	int	申請信用的發票編號	Required
amount	float	string	應用於發票的信用額度。
noemail	bool	設置為 true 以在發票已付款時停止發送發票付款電子郵件	Optional

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤
invoiceid	int	已應用信用的發票的 ID
amount	float	申請的信用額度
invoicepaid	string	真/假字符串

示例請求 (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' => 'ApplyCredit',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'invoiceid' => '1',
            'amount' => '10.00',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

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

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

示例響應 JSON

{
    "result": "success",
    "invoiceid": "1",
    "amount": "10.00",
    "invoicepaid": "false"
}

錯誤響應

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

• 未找到發票 ID
• 發票未處於未付狀態
• 數量超過客戶信用餘額
• 數量超過發票餘額
• 申請的信用額度必須大於零