PHP WHMCS GetQuotes用法及代碼示例

獲取符合通過條件的引號

請求參數

參數	類型	說明	必需的
action	string	“GetQuotes”	Required
limitstart	int	返回的引號數據的偏移量(默認值：0)。	Optional
limitnum	int	要返回的記錄數(默認值：25)。	Optional
quoteid	int	用於查找引號的特定引號 ID。	Optional
userid	int	要為其查找引號的特定客戶。	Optional
subject	string	查找引號的特定主題。	Optional
stage	string	查找引號的特定階段(“草稿”、“已交付”、“擱置”、“已接受”、“丟失”或“死亡”)。	Optional
datecreated	string	查找引號的特定創建日期。格式：Y-m-d	Optional
lastmodified	string	查找引號的特定最後修改日期。格式：Y-m-d	Optional
validuntil	string	查找引號的特定有效截止日期。格式：Y-m-d	Optional

響應參數

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

示例請求(本地 API)

$command = 'GetQuotes';
$postData = array(
    'id' => '1',
);
$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,
    "quotes": {
        "quote": [
            {
                "id": "1",
                "subject": "Sample Quote",
                "stage": "Draft",
                "validuntil": "2016-02-01",
                "userid": "1",
                "firstname": "",
                "lastname": "",
                "companyname": "",
                "email": "",
                "address1": "",
                "address2": "",
                "city": "",
                "state": "",
                "postcode": "",
                "country": "US",
                "phonenumber": "",
                "currency": "1",
                "subtotal": "9.90",
                "tax1": "0.00",
                "tax2": "0.00",
                "total": "9.90",
                "proposal": "This is Proposal Test",
                "customernotes": "These are customer notes",
                "adminnotes": "These are Admin Only notes",
                "datecreated": "2016-01-01",
                "lastmodified": "2016-01-01",
                "datesent": "0000-00-00",
                "dateaccepted": "0000-00-00",
                "items": {
                    "item": [
                        {
                            "id": "1",
                            "description": "This is a line item on a quote",
                            "quantity": "1",
                            "unitprice": "10.00",
                            "discount": "1.00",
                            "taxable": "0"
                        }
                    ]
                }
            }
        ]
    }
}