Name | Type | Description | ||
|---|---|---|---|---|
id | String | The ID of the retrieved ad hoc discount | ||
number | String | The number of the retrieved ad hoc discount | ||
| discount_option | String | The type of discount which will be applied, which can be one of the following
| ||
| discount_amount | Number | The discount amount that will be applied, if the additive discount definition is set up to provide a range of discount based on amount. | ||
| discount_amount_uot | String | The period of time that the ad hoc discount amount will be applied for
| ||
| discount_percentage | Number | The discount percentage that will be applied, if the additive discount definition is set up to provide a range of discount based on percentage | ||
| discount_free_usage | Number | The free usage discount that will be applied, if the additive discount definition is set up to provide a range of discount based on usage. The UOM depends on the UOM of the usage service being discounted
| ||
| for | For Object | The discounted period every time the discount is given when the Discount Option is Percentage per Period or Amount per Period. The possible options are the following:
| ||
| renew | Renew Object | How often the discount is renewed (provided again) when the Discount Option is Percentage per Period or Amount per Period which can have one of the following options:
| ||
| effective_date | Date | The date that the discount becomes effective | ||
| expiration_date | Date | The date that the discount will expire | ||
| life_cycle_state | String | The life cycle state of the retrieved ad hoc discount. Supported values are PENDING_APPROVAL, APPROVED and CANCELLED | ||
| provided_on | Date | The date that the ad hoc discount was provided | ||
| approved_on | Date | The date that the ad hoc discount was approved
| ||
| cancelled_on | Date | The date that the ad hoc discount was cancelled
| ||
| approval_method | String | The method that was followed in order to approve the the ad hoc discount. The supported approval methods are AUTOMATIC or MANUAL | ||
| applied | Boolean | It determines if the ad hoc discount was already applied or not. It returns true if the ad hoc discount was applied or false otherwise | ||
| applied_on | Date | The date that the ad hoc discount was applied. | ||
udf_string_1 | String | User Defined Field of type String | ||
udf_string_2 | String | User Defined Field of type String | ||
udf_string_3 | String | User Defined Field of type String | ||
udf_string_4 | String | User Defined Field of type String | ||
udf_string_5 | String | User Defined Field of type String | ||
udf_string_6 | String | User Defined Field of type String | ||
udf_string_7 | String | User Defined Field of type String | ||
udf_string_8 | String | User Defined Field of type String | ||
udf_float_1 | Float | User Defined Field of type Float | ||
udf_float_2 | Float | User Defined Field of type Float | ||
udf_float_3 | Float | User Defined Field of type Float | ||
udf_float_4 | Float | User Defined Field of type Float | ||
udf_date_1 | Date | User Defined Field of type Date | ||
udf_date_2 | Date | User Defined Field of type Date | ||
udf_date_3 | Date | User Defined Field of type Date | ||
udf_date_4 | Date | User Defined Field of type Date | ||
| discount_free_period | Time Period object | The free period that will be provided, measured in days, weeks, months or years. This information is available if the additive discount definition is set up to provide a range of discount based on free period.
| ||
| subscription | Subscription Object | The subscription that the ad hoc discount will be applied on | ||
| job | Job Object | The job that the ad hoc discount will be applied on. | ||
| additive_discount_definition | Additive Discount Definition Object | The additive discount definition that will be applied by the ad hoc discount | ||
| provided_by | User Object | The user that provided the ad hoc discount | ||
| approved_by | User Object | The user that approved the ad hoc discount. | ||
| cancelled_by | User Object | The user that cancelled the ad hoc discount | ||
| currency_rate_period | Currency Rate Period Object | The currency rate period of the ad hoc discount
| ||
| log_information | Log Information Object | The log information of the retrieved ad hoc discount | ||
| products_set | Set of Ad hoc Discount Products Objects | Set of ad hoc discount products used to keep track of the products that the discount will be applied on. If not specified then the discount will be applicable on any products that will be billed |
Referred Objects Response DataAnchor ad hoc discount referred objects ad hoc discount referred objects
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
...
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
...
| Include Page | ||||
|---|---|---|---|---|
|