PHP WHMCS CreateInvoice用法及代碼示例

使用提供的參數創建發票。

請求參數

參數	類型	說明	必需的
action	string	“CreateInvoice”	Required
userid	int	為其創建發票的客戶 ID。	Required
status	string	正在創建的發票的狀態。默認為 unpaid 。	Optional
draft	bool	是否創建草稿狀態的發票。 (您不需要傳遞$status。)	Optional
sendinvoice	bool	是否將 Invoice Created Email 發送給客戶端。 (您不能將其與 $draft 一起使用。)	Optional
paymentmethod	string	已創建發票的付款方式，采用係統格式。	Optional
taxrate	float	應用於發票以覆蓋係統默認值的first-level 稅率。	Optional
taxrate2	float	應用於發票以覆蓋係統默認值的second-level 稅率。	Optional
date	string	發票應顯示的創建日期。格式：YYYY-mm-dd	Optional
duedate	string	新創建發票的到期日。格式：YYYY-mm-dd	Optional
notes	string	在創建的發票上顯示的注釋。	Optional
itemdescriptionx	string	訂單項的說明。 X 是一個整數，用於添加多個發票項目。	Optional
itemamountx	float	行項目的數量。	Optional
itemtaxedx	bool	行項目的征稅值。	Optional
autoapplycredit	bool	是否自動將客戶帳戶的信用應用到發票。	Optional

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤
invoiceid	int	新建發票的 ID。
status	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' => 'CreateInvoice',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'userid' => '1',
            'status' => 'Unpaid',
            'sendinvoice' => '1',
            'paymentmethod' => 'mailin',
            'taxrate' => '10.00',
            'date' => '2016-01-01',
            'duedate' => '2016-01-08',
            'itemdescription1' => 'Sample Invoice Item',
            'itemamount1' => '15.95',
            'itemtaxed1' => '0',
            'itemdescription2' => 'Sample Second Invoice Item',
            'itemamount2' => '1.00',
            'itemtaxed2' => '1',
            'autoapplycredit' => '0',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'CreateInvoice';
$postData = array(
    'userid' => '1',
    'status' => 'Unpaid',
    'sendinvoice' => '1',
    'paymentmethod' => 'mailin',
    'taxrate' => '10.00',
    'date' => '2016-01-01',
    'duedate' => '2016-01-08',
    'itemdescription1' => 'Sample Invoice Item',
    'itemamount1' => '15.95',
    'itemtaxed1' => '0',
    'itemdescription2' => 'Sample Second Invoice Item',
    'itemamount2' => '1.00',
    'itemtaxed2' => '1',
    'autoapplycredit' => '0',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例響應 JSON

{
    "result": "success",
    "invoiceid": "1",
    "status": "Unpaid"
}

錯誤響應

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

• 未找到客戶端 ID
• 無法在單個 API 請求中創建和發送草稿發票。請單獨創建和發送。