PHP WHMCS GetInvoices用法及代碼示例

檢索發票列表。

請求參數

參數	類型	說明	必需的
action	string	“GetInvoices”	Required
limitstart	int	返回發票數據的偏移量(默認值：0)	Optional
limitnum	int	返回的記錄數(默認：25)	Optional
userid	int	查找特定客戶 ID 的發票	Optional
status	string	查找特定狀態的發票。標準發票狀態加上過期	Optional
orderby	string	結果排序依據的字段。接受的值為：id、invoicenumber、date、duedate、total、status	Optional
order	string	訂單排序屬性。可接受的值為：asc 或 desc。	Optional

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤
totalresults	int	可用結果總數
startnumber	int	返回結果的起始編號
numreturned	int	返回的結果數
invoices	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' => 'GetInvoices',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'userid' => '1',
            'orderby' => 'invoicenumber',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'GetInvoices';
$postData = array(
    'userid' => '1',
    'orderby' => 'invoicenumber',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例響應 JSON

{
    "result": "success",
    "totalresults": 1,
    "startnumber": 0,
    "numreturned": 1,
    "invoices": {
        "invoice": [
            {
                "id": 1,
                "userid": 1,
                "firstname": "Test",
                "lastname": "Client",
                "companyname": "",
                "invoicenum": "",
                "date": "2016-01-01",
                "duedate": "2016-01-08",
                "datepaid": "0000-00-00 00:00:00",
                "last_capture_attempt": "0000-00-00 00:00:00",
                "date_refunded": "0000-00-00 00:00:00",
                "date_cancelled": "0000-00-00 00:00:00",
                "subtotal": "15.95",
                "credit": "0.00",
                "tax": "0.00",
                "tax2": "0.00",
                "total": "15.95",
                "taxrate": "0.000",
                "taxrate2": "0.000",
                "status": "Unpaid",
                "paymentmethod": "paypalcheckout",
                "paymethodid": null,
                "notes": "",
                "created_at": "2016-01-08 14:06:34",
                "updated_at": "2016-01-08 14:07:17",
                "currencycode": "USD",
                "currencyprefix": "$",
                "currencysuffix": " USD"
            }
        ]
    }
}