| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| applied_additive_discount_identifier (mandatory) | Applied Additive Discount identifier | The identifier of the applied additive discount that should be returned as a result. The allowed applied additive discount identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| additive_discount_definition_identifier (semi-optional) | Additive Discount Definition identifier | The identifier of the additive discount definition related with the applied additive that should be returned as a result. The allowed additive discount definition identifier fields are the following:
| ||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable identifier | The identifier of the accounts receivable related with the applied additive discount that should be returned as a result. The allowed accounts receivable identifier fields are the following:
| ||||||
| subscription_identifier (semi-optional) | Subscription identifier | The identifier of the subscription related with the applied additive discount that should be returned as a result. The allowed subscription identifier fields are the following:
| ||||||
job_identifier (semi-optional) | Job identifier | The identifier of the job related with the applied additive discount that should be returned as a result. The allowed job identifier fields are the following:
| ||||||
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 SUBSCRIPTIONS and JOBS | ||||||
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 | ||||||
from_date (optional) | Date | It determines the date that the applied additive discount becomes effective. If specified then only applied additive discounts which were effective on that date or after that date will be retrieved | ||||||
to_date (optional) | Date | It determines the date that the applied additive discount becomes not effective. If specified then only applied additive discounts which were effective up to that date or before that date will be retrieved | ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
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 |
...
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 should be returned as a result. The allowed ad hoc discount identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| additive_discount_definition_identifier (semi-optional) | Additive Discount Definition identifier | The identifier of the additive discount definition related with the ad hoc discounts that should be returned as a result. Only additive discount definitions of type Ad Hoc can be specified.The allowed additive discount definition identifier fields are the following:
| ||||||
| 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:
| ||||||
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:
| ||||||
provided_by_identifier (semi-optional) | User Identifier | The identifier of the user that provided the ad hoc discounts that should be returned as a result. The allowed user identifier fields are the following:
| ||||||
approved_by_identifier (semi-optional) | User Identifier | The identifier of the user that approved the ad hoc discounts that should be returned as a result. The allowed user identifier fields are the following:
| ||||||
cancelled_by_identifier (semi-optional) | User Identifier | The identifier of the user that cancelled the ad hoc discounts that should be returned as a result. The allowed user identifier fields are the following:
| ||||||
life_cycle_state (semi-optional) | String | The life cycle state of the ad hoc discounts that should be returned as a result. The supported life cycle states are PENDING_APPROVAL, APPROVED and CANCELLED | ||||||
applied (optional) | Boolean | If set to TRUE the only ad hoc discounts that were already applied will be returned as a result. If set to FALSE then only ad hoc discounts that are not applied yet will be returned as a result. If not specified then any ad hoc discounts will be retrieved. | ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
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 |
...
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 |
...
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
|
...
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 approved. Only ad hoc discounts in a pending approval life cycle state can be specified. The allowed ad hoc discount identifier fields are the following:
| ||||||
approved_by_identifier (optional) | User Identifier | The identifier of the user that approved the ad hoc discount. If not specified then it defaults to the user that submitted the request into the system. The user is validated against the list of users that are authorized to approve ad hoc discounts. The allowed user identifier fields are the following:
| ||||||
approved_on (optional) | Date | The date that the ad hoc discount was approved. If not specified then it defaults to the date that the request was submitted into the system. |
...
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 cancelled. Only ad hoc discounts in a pending approval life cycle state or approved but not applied can be specified. The allowed ad hoc discount identifier fields are the following:
| ||||||
cancelled_by_identifier (optional) | User Identifier | The identifier of the user that cancelled 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:
| ||||||
cancelled_on (optional) | Date | The date that the ad hoc discount was cancelled. If not specified then it defaults to the date that the request was submitted into the system. |
...
Name | Type | Description | ||
token | String | The token retrieved from the login method | ||
| accounts_receivable (mandatory) | Accounts Receivable Object | Information related with the accounts receivable that will own the subscription or the job that could possibly be discounted | ||
(semi-optional) | Subscriptions Object | Information related with the subscription that could possibly be discounted | ||
(semi-optional) | Job Object | Information related with the job that could possibly be discounted | ||
| (optional)
| Buy in Advance Request Object | Information related with buy in advance request that might be applicable on the subscription that could possible be discounted. This information is applicable only if a subscription is specified.
| ||
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 |
...
Name | Type | Description | ||
token | String | The token retrieved from the login method | ||
| accounts_receivable (mandatory) | Accounts Receivable Object | Information related with the accounts receivable that will own the subscription or the job that could possibly be discounted | ||
(semi-optional) | Subscriptions Object | Information related with the subscription that could possibly be discounted | ||
(semi-optional) | Job Object | Information related with the job that could possibly be discounted | ||
(optional) | Buy in Advance Request Object | Information related with buy in advance request that might be applicable on the subscription that could possible be discounted. This information is applicable only if a subscription is specified.
| ||
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 |
...