| Tip |
|---|
| Available Not available from CRM.COM R5R15.0.0. |
| Excerpt |
|---|
This method updated updates an ad-hoc discount, which is in a pending approval life cycle state. A single ad hoc discount can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null. |
Resource URL
Parameters
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
ad_hoc_discount_identifier (mandatory) | Ad hoc discount identifier | The identifier of the ad hoc discount that will be updated. Only ad hoc discounts in a pending life cycle state can be specified.The allowed ad hoc discount identifier fields are the following:
| ||||||||
discount_amount (optional and applicable on conditions) | Number | The discount amount that will be applied. This information is applicable and mandatory if the additive discount definition is set up to provide a range of discount based on amount | ||||||||
discount_percentage (optional and applicable on conditions) | Number | The discount percentage that will be applied. This information is applicable and mandatory if the additive discount definition is set up to provide a range of discount based on percentage | ||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the ad hoc discount. If specified then it is validated against the currency of the related accounts receivable and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:
| ||||||||
effective_date (optional) | Date | The date that the discount becomes effective | ||||||||
expiration_date (optional) | Date | The date that the discount will expire | ||||||||
provided_by_identifier (optional) | User Identifier | The identifier of the user that provided the ad hoc discount. If not specified then it defaults to the user that submitted the request into the system. The allowed user identifier fields are the following:
| ||||||||
provided_on (optional) | Date | The date that the ad hoc discount was provided. If not specified then it defaults to the date that the request was submitted into the system. | ||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||
(optional and applicable on conditions) | Time Period Object | The free period that will be provided, measured in days, weeks, months or years. This information is applicable and mandatory if the additive discount definition is set up to provide a range of discount based on free period. | ||||||||
(optional) | Set of Ad hoc Discount Products Objects | The products that the discount will be applied on, considering that they are allowed by the specified subscription or job and the specified additive discount definition. If not specified then the discount will be applicable on any products that will be billed
|
...