Process is not available from CRM.COM R15.0.0
This method 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 If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
|
Referred Parameters Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters.
Response Data
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
Available from CRM.COM R15.0.0 |
| 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 Not available from CRM.COM R15.0.0 |
| 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 Available from CRM.COM R15.0.0 |
| 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:
Available from CRM.COM R15.0.0 |
| 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:
Available from CRM.COM R15.0.0 |
| 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 Not available from CRM.COM R15.0.0 |
| cancelled_on | Date | The date that the ad hoc discount was cancelled Not available from CRM.COM R15.0.0 |
| 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. Not available from CRM.COM R15.0.0 |
| 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 Available from CRM.COM R10.0.0 |
| 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 Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"0EAFCF4BAF264A24BBA2A7FAC17CD6F8",
"ad_hoc_discount_identifier":{"number":"24"},
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59",
"products_set":[
{
"action":"remove",
"ad_hoc_discount_product_identifier":{"product_identifier":{"code":"P2"}}
},
{
"action":"add",
"product_identifier":{"code":"P1"}
}
]
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"cancelled_by": null,
"effective_date": "2015-03-09T12:30:05",
"udf_float_1": 10,
"products_set":
[
{
"id": "FB7A4973B35C4B0E82E9CF7D400D7086",
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription Packages",
"id": "BC954969D3172372D498D3BB2BA590A0",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "5C2DCFDD743632AC57AE8147B6EE665E",
"description": null,
"code": "P1",
"alternative_code": "P1"
}
}
],
"udf_float_2": 20,
"udf_float_3": 30,
"number": "24",
"udf_float_4": 40,
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"cancelled_on": null,
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_6": "udf string 6",
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"discount_amount": null,
"discount_percentage": null,
"id": "ACC659665C1B4FE6B3DA01C597798D3B",
"approval_method": "MANUAL",
"subscription":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Ioannou78",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Marios",
"name": "Marios Ioannou78",
"id": "2CAAE984123646F2999935E6BB0D1A90",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": null,
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "558",
"name": "mar78",
"id": "C14A88EF0C434BA886755D8B4DCEE2F2"
},
"life_cycle_state": "EFFECTIVE",
"number": "S60310",
"type":
{
"name": "Normal Subscription",
"id": "6BB2B984CC9309775D06650C7493A836",
"description": null,
"alternative_code": "ST"
},
"id": "35656546C7504EEA821A592E69E3C86F"
},
"additive_discount_definition":
{
"life_cycle_state": "EFFECTIVE",
"classification": "SUBSCRIPTIONS",
"type": "AD_HOC",
"name": "Lucia Test 4 ",
"id": "CBAE3930253AB31856D28BF34023E44E",
"alternative_code": "lt4"
},
"approved_by": null,
"applied_on": null,
"approved_on": null,
"udf_date_1": "2014-05-05T15:49:59",
"udf_date_2": "2014-06-05T15:49:59",
"udf_date_3": "2014-07-05T15:49:59",
"udf_date_4": "2014-08-05T15:49:59",
"log_information":
{
"updated_date": "2015-03-09T13:01:49",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2015-03-09T12:29:57",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "mpadministrator",
"id": "1"
}
},
"provided_by":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1"
},
"life_cycle_state": "PENDING_APPROVAL",
"discount_free_period":
{
"time_period_value": 8,
"time_period_uot": "DAYS"
},
"provided_on": "2015-03-09T12:30:07",
"applied": false,
"job": null,
"expiration_date": null
}
}