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