...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Tip |
|---|
| Excerpt |
|---|
This method creates an ad hoc discount that can be applied on a specific subscription or job. A single ad hoc discount can be created by each call. |
Resource URL
Parameters
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
additive_discount_definition_identifier (mandatory) | Additive Discount Definition identifier | The identifier of the additive discount definition that will be applied. Only additive discount definitions of type Ad Hoc can be specified, considering that they can be applied on the specified subscription or job, and by the specified user.The allowed additive discount definition identifier fields are the following:
| ||||||||
subscription_identifier (mandatory on conditions) | Subscription identifier | The identifier of the subscription on which the ad hoc discount will be applied on. This information is mandatory unless a job is specified. In that case it is not allowed to specified a subscription as well. The allowed subscription identifier fields are the following:
| ||||||||
job_identifier (mandatory on conditions) | Job identifier | The identifier of the job on which the ad hoc discount will be applied on. This information is mandatory unless a subscription is specified. In that case it is not allowed to specified a job as well. The allowed job identifier fields are the following:
| ||||||||
discount_amount (mandatory 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 (mandatory 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 | ||||||||
(mandatory 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 |
...