| Tip |
|---|
Available from CRM.COM R15.0.0 |
| Excerpt |
|---|
This method returns a list of discount definitions that are available to be applied on subscriptions or jobs having either specific characteristics (i.e. subscription type) or discounts for specific subscriptions or jobs. It is also possible to select whether the retrieved discounts definitions are ad hoc or autoapply. Multiple discount definitions are returned by each call |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| accounts_receivable (semi-optional) | Accounts Receivable Object | Characteristics related with the accounts receivable that will own the subscription or the job that could possibly be discounted
| ||||||
(semi-optional) | Subscriptions Object | Characteristics related to subscriptions that could possibly be discounted. | ||||||
| subscription_identifier (semi-optional) | Subscription identifier | The identifier of the subscription related with the ad hoc discounts that should be returned as a result. The allowed subscription identifier fields are the following:
| ||||||
(semi-optional) | Job Object | Characteristics related to jobs that could possibly be discounted. | ||||||
job_identifier (semi-optional) | Job identifier | The identifier of the job related with the ad hoc discounts that should be returned as a result. The allowed job identifier fields are the following:
| ||||||
(optional) | Products Object | The product the discount is for. | ||||||
date (optional) | Date | The date for which you want to see the available discounts for. | ||||||
from_date (optional) | Date | The date from which the termed service discount will be applied from. Applicable only for termed services | ||||||
to_date (optional) | Date | The date up to which the termed service discount will be applied to Applicable only for termed services | ||||||
additive_discount_definition_classification (semi-optional) | String | The classification of the additive discount definition related with the applied additive that should be returned as a result. The supported classifications are SUBSCRIPTION, JOB, GENERAL | ||||||
additive_discount_definition_type (semi-optional) | String | The type of the additive discount definition related with the applied additive that should be returned as a result. The supported classifications are AUTO_APPLIED and AD_HOC | ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
...