更新货币
目的
更新货币的详细信息。
端点
- PUT /org/currencies/actions/enable
- PUT /org/currencies
- PUT /org/currencies/{currency_ID}
请求详情
请求 URL
更新本币:
{api-domain}/crm/{version}/org/currencies/actions/enable
更新除本币以外的其他货币:
{api-domain}/crm/{version}/org/currencies
更新特定货币:
{api-domain}/crm/{version}/org/currencies/{currency_ID}
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
适用范围
ZohoCRM.设置.货币.{operation_type}
可能的操作类型
Update - Update货币数据
样品请求
Copiedcurl "https://www.zohoapis.com/crm/v8/org/currencies/actions/enable"
-X PUT
-d input.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"在请求中,"@input.json" 包含了示例输入数据。
注意
- 使用 {api-domain}/crm/{version}/org/currencies/actions/enable 只能更新基础货币的数值,无法将其他货币设为基础货币。
- 您无法更新货币的名称和 ISO 代码。
请求 JSON 键
- id字符串,必填
指定货币的唯一ID。请参考获取货币API以获取货币ID。
- exchange_rate字符串,可选
表示货币与本币之间的兑换汇率。接受最多九位整数和九位小数的正小数。例如:123456789.123456789。
- prefix_symbol布尔值,可选
表示ISO代码在货币中的位置。
可选值:
- true - 在货币数值前显示ISO代码。此为默认值。
- false - 在货币数值后显示ISO代码。
- symbol字符串,可选
表示货币的符号。
- is_active布尔值,可选
表示货币的状态。
可能的取值:- true - 该货币为激活状态。此为默认值。
- false - 该货币为未激活状态。
- formatJSON 对象,可选
表示基础货币的格式,包括小数分隔符、千位分隔符和小数位数等详细信息。
"format" JSON 对象中的键
- decimal_separatorstring,可选
小数分隔符用于将货币的整数部分与小数部分分开。根据不同的货币,分隔符可以是点号或逗号。
- thousand_separatorstring,可选
千分位分隔符用于将货币中的千位进行分组。根据不同的货币,分隔符可以是点号、逗号或空格。
- decimal_placesinteger,可选
表示该货币允许的小数位数。可以为0、2 或 3。
用于更新基础货币的示例输入
Copied{
"base_currency": {
"symbol": "Af",
"format": {
"decimal_separator": "Period",
"thousand_separator": "Comma",
"decimal_places": "3"
},
"prefix_symbol": true,
"id": "111113000000038990",
"exchange_rate": "1.0000000"
}
}用于更新货币的示例输入
Copied{
"currencies": [
{
"id": "3652397000007472080",
"symbol": "$",
"is_active": false,
"exchange_rate": "85"
}
]
}可能的错误
- INVALID_DATAHTTP 400
您指定了无效的货币ID。
解决方法:请使用获取货币API来获取正确的货币ID。 - INVALID_DATAHTTP 400
货币符号无效。
解决方法:您指定了一个无效的货币符号。 - FEATURE_NOT_SUPPORTEDHTTP 403
多币种功能仅在企业版及更高版本中可用。
解决方案:升级您的版本或联系系统管理员。 - FEATURE_NOT_ENABLEDHTTP 403
多币种功能尚未启用。
解决方法: 仅在启用多币种功能后才能更新货币。请参阅启用多币种 API。 - NOT_ALLOWEDHTTP 400
千位分隔符和小数分隔符不能相同。
解决方法:请为千位和小数指定不同的分隔符。 - NOT_ALLOWEDHTTP 400
您正在尝试更改基础货币。
解决方法:您可以更新基础货币的数值,但不能更改基础货币本身。 - MANDATORY_NOT_FOUNDHTTP 400
您尚未在输入中指定“id”键。
解决方法:请在输入中指定货币的唯一ID。请参阅 获取货币 API 以获取货币的唯一ID。 - INVALID_REQUEST_METHODHTTP 400
请求方法不正确。
解决方法:请使用 HTTP PUT 方法调用此 API。使用其他请求方法将导致此错误。 - AUTHORIZATION_FAILEDHTTP 400
您没有足够的权限来更新货币。
解决方法:请联系您的系统管理员。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用于此 API 调用的访问令牌不具备所需的权限范围。
解决方法: 根据Scope部分提及的权限,生成一个新的访问令牌。 - NO_PERMISSIONHTTP 403
您没有权限更新货币。
解决方法:请联系您的系统管理员。 - INVALID_URL_PATTERNHTTP 404
请求的URL不正确。
解决方法:请指定有效的请求URL。请参考请求URL部分以获取正确的URL。 - INTERNAL_ERRORHTTP 500
服务器发生了意外且未处理的异常。
解决方案:请联系支持团队:support@zohocrm.com。
示例响应
Copied{
"base_currency": {
"code": "SUCCESS",
"details": {
"id": "4150868000000780002"
},
"message": "The currency updated successfully",
"status": "success"
}
}