更新现有引号
请求参数
参数 | 类型 | 说明 | 必需的 |
---|---|---|---|
action | string | “UpdateQuote” | Required |
quoteid | int | 要更新的引号的 ID | Required |
subject | string | 引号的主题 | Optional |
stage | string | 引号的当前阶段(“草稿”、“已交付”、“暂停”、“已接受”、“丢失”、“死亡”) | Optional |
validuntil | string | 引号的有效日期,直到本地化格式(例如 DD/MM/YYYY) | Optional |
datecreated | string | 以本地化格式创建引号的日期(例如 DD/MM/YYYY) | Optional |
lineitems | array | 一个 base64 编码的序列化数组,包含以下键: | Optional |
lineitems[x][id] | int | 对于 $lineitems。现有订单项的 ID。省略换行 | Optional |
lineitems[x][desc] | string | 对于 $lineitems。行项目的说明 | Optional |
lineitems[x][qty] | int | 对于 $lineitems。引号的行项目的数量 | Optional |
lineitems[x][up] | float | 对于 $lineitems。行项目的单价 | Optional |
lineitems[x][discount] | float | 对于 $lineitems。为行项目提供的折扣数量 | Optional |
lineitems[x][taxable] | bool | 对于 $lineitems。行项目是否应纳税 | Optional |
userid | int | 如果引号是针对现有客户的,则引号所针对的客户 ID | Optional |
firstname | string | 如果没有 $userid,则引用的客户的名字 | Optional |
lastname | string | 如果没有 $userid,则引用的客户的姓氏 | Optional |
companyname | string | 如果没有 $userid,则引号所针对的客户公司 | Optional |
string | 如果没有 $userid,引号所针对的客户的电子邮件地址 | Optional | |
address1 | string | 如果没有 $userid,则引用的客户地址 1 | Optional |
address2 | string | 如果没有 $userid,则引用的客户地址 2 | Optional |
city | string | 如果没有 $userid,则引号所针对的客户所在城市 | Optional |
state | string | 如果没有 $userid,则引用的客户端状态 | Optional |
country | string | 如果没有 $userid,则引号所针对的客户所在的国家/地区 | Optional |
phonenumber | string | 客户的电话号码(无国家代码),如果没有 $userid 则引号。本地格式,例如 4035551234 | Optional |
tax_id | string | 客户的税号 | Optional |
currency | int | 如果没有 $userid,则引号的货币 id | Optional |
proposal | string | 向最终用户显示的提案文本 | Optional |
customernotes | string | 显示给最终用户的引号注释 | Optional |
adminnotes | string | 引号单上的注释仅向员工显示 | Optional |
响应参数
参数 | 类型 | 说明 |
---|---|---|
result | 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' => 'UpdateQuote',
// See https://developers.whmcs.com/api/authentication
'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
'password' => 'SECRET_OR_HASHED_PASSWORD',
'subject' => 'Test Quote Subject',
'stage' => 'Draft',
'lineitems' => base64_encode(serialize(array(array("id"=>1,"desc"=>"Test Description 1","qty"=>1,"up"=>"10.00","discount"=>"10.00",
"taxable"=>true),array("desc"=>"Test Description 2","qty"=>4,"up"=>"15.00","discount"=>"0.00",
"taxable"=>false)))),
'responsetype' => 'json',
)
)
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);
示例请求(本地 API)
$command = 'UpdateQuote';
$postData = array(
'subject' => 'Test Quote Subject',
'stage' => 'Draft',
'lineitems' => base64_encode(serialize(array(array("id"=>1,"desc"=>"Test Description 1","qty"=>1,"up"=>"10.00","discount"=>"10.00",
"taxable"=>true),array("desc"=>"Test Description 2","qty"=>4,"up"=>"15.00","discount"=>"0.00",
"taxable"=>false)))),
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later
$results = localAPI($command, $postData, $adminUsername);
print_r($results);
示例响应 JSON
{
"result": "success"
}
错误响应
可能的错误条件响应包括:
- 未找到引号 ID
- 无效阶段
相关用法
- PHP WHMCS UpdateUserPermissions用法及代码示例
- PHP WHMCS UpdateModuleConfiguration用法及代码示例
- PHP WHMCS UpdateClientProduct用法及代码示例
- PHP WHMCS UpdateOAuthCredential用法及代码示例
- PHP WHMCS UpdatePayMethod用法及代码示例
- PHP WHMCS UpdateToDoItem用法及代码示例
- PHP WHMCS UpdateTicketReply用法及代码示例
- PHP WHMCS UpdateClientAddon用法及代码示例
- PHP WHMCS UpdateAnnouncement用法及代码示例
- PHP WHMCS UpdateInvoiceTotal用法及代码示例
- PHP WHMCS UpdateUser用法及代码示例
- PHP WHMCS UpdateTransaction用法及代码示例
- PHP WHMCS UpdateTicket用法及代码示例
- PHP WHMCS UpdateContact用法及代码示例
- PHP WHMCS UpdateProject用法及代码示例
- PHP WHMCS UpdateInvoice用法及代码示例
- PHP WHMCS UpdateClientDomain用法及代码示例
- PHP WHMCS UpdateClient用法及代码示例
- PHP WHMCS UpdateProjectTask用法及代码示例
- PHP WHMCS UpdateAdminNotes用法及代码示例
- PHP WHMCS UpgradeProduct用法及代码示例
- PHP WHMCS UserLogout用法及代码示例
- PHP WHMCS UserAdd用法及代码示例
- PHP WHMCS UserEmailVerificationComplete用法及代码示例
- PHP Unset() vs Unlink()用法及代码示例
注:本文由纯净天空筛选整理自whmcs.com大神的英文原创作品 UpdateQuote。非经特殊声明,原始代码版权归原作者所有,本译文未经允许或授权,请勿转载或复制。