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"
                        }
                    ]
                }
            }
        ]
    }
}