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
• 发票未处于未付状态
• 数量超过客户信用余额
• 数量超过发票余额
• 申请的信用额度必须大于零