| Tip |
|---|
Available from CRM.COM R5.0.0 |
GET additive_discounts/applied_additive_discounts/show
This method returns information related with an applied additive discount. A single applied additive discount is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"udf_float_1": 10,
"udf_float_2": 20,
"udf_float_3": 30,
"number": "AD001",
"udf_float_4": 40,
"udf_string_1": "user field 1",
"udf_string_2": "user field 2",
"udf_string_3": "user field 3",
"udf_string_4": "user field 4",
"udf_string_5": "user field 5",
"udf_string_6": "user field 6",
"udf_string_7": "user field 7",
"udf_string_8": "user field 8",
"discount_amount": 60,
"id": "063D4E324333E4A6263EC0868BF04521",
"subscription": null,
"applied_additive_discount_definition":
{
"life_cycle_state": "EFFECTIVE",
"classification": "SUBSCRIPTIONS",
"type": "AUTO_APPLY",
"name": "Lucia test 3",
"id": "35346B2FB563CD998DF9DFF00949CD7C",
"alternative_code": "lt3"
},
"from_date": null,
"udf_date_1": "2015-02-19T13:32:46",
"udf_date_2": "2015-02-19T13:32:46",
"udf_date_3": "2015-02-19T13:32:46",
"udf_date_4": "2015-02-19T13:32:46",
"log_information":
{
"updated_date": "2015-02-19T13:32:46",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Developers Group",
"name": "Developers Unit",
"id": "C4370788B2630BC8A99E8C7397406C09",
"description": null,
"alternative_code": null
},
"created_date": "2015-02-19T13:32:46",
"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": "Meri",
"username": "Meri",
"id": "573150C4CE1882B98D3D65DB9390D851",
"email": null
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"to_date": null,
"job":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Ioannou24",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Marios",
"name": "Marios Ioannou24",
"id": "45DF853DDDF180FA38D022BF5A4606EA",
"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": "197",
"name": "mar24",
"id": "7002997067CF50C8605542A4968EE5C0"
},
"life_cycle_state": "COMPLETED",
"number": "13",
"id": "37B285CE1C9874D60B7F26B9E06EF95C",
"description": "test desc1"
}
}
} |
|
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"data": {
"applied_additive_discount_definition": {
"alternative_code": "A",
"name": "ADD1",
"id": "4C07273845E649C9BECB70FD03606B4F",
"life_cycle_state": "NOT_EFFECTIVE",
"classification": "SUBSCRIPTIONS",
"type": "AUTO_APPLY"
},
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-02-22T11:42:55",
"updated_date": "2016-02-22T11:42:55",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"discount_amount": 0.86,
"currency_rate_period": null,
"subscription": {
"number": "S0000000044",
"first_activated_date": "2016-02-16T17:40:02",
"rating_state": "PENDING",
"accounts_receivable": {
"number": "ACR0000000047",
"name": "ACR0000000047 Matt Black",
"id": "FE129337AA504E9D82376EA1D991B696",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Matt Black",
"last_name": "Black",
"id": "76E0E43E7CD74157979230819FD41B8E",
"life_cycle_state": "FINANCIAL",
"middle_name": "Y",
"title": null,
"type": "PERSON",
"first_name": "Matt",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "1212128596",
"gender": "MALE",
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": "999999998",
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "6501878393A74DA69ADC2B1F33F54AF1",
"life_cycle_state": "NOT_EFFECTIVE",
"type": {
"alternative_code": "normalsub",
"name": "Normal",
"description": null,
"id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "10",
"udf_float_3": null,
"udf_float_4": null,
"to_date": "2016-02-23T00:00:00",
"id": "B1015A3891DC413092A3EDF8ED0C92DB",
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"product": {
"code": "Gold",
"product_type": {
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "Main Packages",
"composition_method": "FLAT",
"name": "Main Packages",
"description": null,
"id": "E186E293AAAB49EE86A729540A4287FE",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "G",
"description": null,
"id": "D1EB074DFD904E54A0C67CAB9DC7E010"
},
"udf_string_5": null,
"from_date": "2016-02-22T00:00:00",
"udf_string_1": null,
"udf_string_6": null,
"job": null,
"udf_string_7": null,
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
|
GET additive_discounts/applied_additive_discounts/list
This method returns information related with applied additive discounts. Multiple applied additive discounts are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(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:
...
(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:
...
(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)
...
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)
...
additive_discount_definition_type
(semi-optional)
...
from_date
(optional)
...
to_date
(optional)
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
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
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. More than one semi-optional parameter can be specified.
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"number": "AD001",
"id": "063D4E324333E4A6263EC0868BF04521",
"job":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Ioannou24",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Marios",
"name": "Marios Ioannou24",
"id": "45DF853DDDF180FA38D022BF5A4606EA",
"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": "197",
"name": "mar24",
"id": "7002997067CF50C8605542A4968EE5C0"
},
"life_cycle_state": "COMPLETED",
"number": "13",
"id": "37B285CE1C9874D60B7F26B9E06EF95C",
"description": "test desc1"
}
}
]
} |
|
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"data": [
{
"number": "10",
"currency_rate_period": {
"from_date": "C7D7ED57F21B47028144967E015DCBE5",
"to_date": 2.3,
"rate": 2.3,
"inverse_rate": 0.23000000417232513,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9"
},
"id": "C7D7ED57F21B47028144967E015DCBE5"
},
"id": "B1015A3891DC413092A3EDF8ED0C92DB",
"subscription": {
"number": "S0000000044",
"first_activated_date": "2016-02-16T17:40:02",
"rating_state": "PENDING",
"accounts_receivable": {
"number": "ACR0000000047",
"name": "ACR0000000047 Matt Black",
"id": "FE129337AA504E9D82376EA1D991B696",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Matt Black",
"last_name": "Black",
"id": "76E0E43E7CD74157979230819FD41B8E",
"life_cycle_state": "FINANCIAL",
"middle_name": "Y",
"title": null,
"type": "PERSON",
"first_name": "Matt",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "1212128596",
"gender": "MALE",
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": "999999998",
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "6501878393A74DA69ADC2B1F33F54AF1",
"life_cycle_state": "NOT_EFFECTIVE",
"type": {
"alternative_code": "normalsub",
"name": "Normal",
"description": null,
"id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
}
}
},
{
"number": "11",
"currency_rate_period": null,
"id": "FDCC99B79ABE434EBD0FDA1930EA6952",
"subscription": {
"number": "S0000000044",
"first_activated_date": "2016-02-16T17:40:02",
"rating_state": "PENDING",
"accounts_receivable": {
"number": "ACR0000000047",
"name": "ACR0000000047 Matt Black",
"id": "FE129337AA504E9D82376EA1D991B696",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Matt Black",
"last_name": "Black",
"id": "76E0E43E7CD74157979230819FD41B8E",
"life_cycle_state": "FINANCIAL",
"middle_name": "Y",
"title": null,
"type": "PERSON",
"first_name": "Matt",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "1212128596",
"gender": "MALE",
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": "999999998",
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "6501878393A74DA69ADC2B1F33F54AF1",
"life_cycle_state": "NOT_EFFECTIVE",
"type": {
"alternative_code": "normalsub",
"name": "Normal",
"description": null,
"id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
}
}
},
{
"number": "25",
"currency_rate_period": null,
"id": "1FF79327B7674FA8A54AB4591FAB5578",
"subscription": {
"number": "S0000000044",
"first_activated_date": "2016-02-16T17:40:02",
"rating_state": "PENDING",
"accounts_receivable": {
"number": "ACR0000000047",
"name": "ACR0000000047 Matt Black",
"id": "FE129337AA504E9D82376EA1D991B696",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Matt Black",
"last_name": "Black",
"id": "76E0E43E7CD74157979230819FD41B8E",
"life_cycle_state": "FINANCIAL",
"middle_name": "Y",
"title": null,
"type": "PERSON",
"first_name": "Matt",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "1212128596",
"gender": "MALE",
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": "999999998",
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "6501878393A74DA69ADC2B1F33F54AF1",
"life_cycle_state": "NOT_EFFECTIVE",
"type": {
"alternative_code": "normalsub",
"name": "Normal",
"description": null,
"id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
}
}
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
|
GET additive_discounts/ad_hoc_discounts/show
This method returns information related with an ad hoc discount. A single ad hoc discount is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"cancelled_by": null,
"effective_date": "2014-07-11T12:20:47",
"udf_float_1": null,
"products_set":
[
{
"id": "81C527EC9134BE1272BD1E1534DBAEB6",
"product":
{
"product_type":
{
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"id": "A2B00E27070BEB1B1273733260A45ACC",
"description": "Athina STB",
"code": "Athina STB",
"alternative_code": "A-STB"
}
},
{
"id": "20F5F79CE3061B00615EF69273493201",
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": false,
"composition_method": "FIXEDBUNDLE",
"classification": "SERVICES",
"name": "Fixed Bundle",
"id": "AF80230C21FDBD38C3D24777BE9CA333",
"description": null,
"alternative_code": "Fixed Bundle"
},
"id": "468733DA92F19F0F9208F9B91A93E243",
"description": null,
"code": "Viasat ",
"alternative_code": "Viasat"
}
}
],
"udf_float_2": null,
"udf_float_3": null,
"number": "AH001",
"udf_float_4": null,
"udf_string_1": null,
"udf_string_2": null,
"cancelled_on": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"discount_amount": null,
"discount_percentage": 12,
"id": "789FBA44C27D1DA69AB3652E0F5575E7",
"approval_method": "MANUAL",
"subscription":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Pickman",
"life_cycle_state": "FINANCIAL",
"middle_name": "Lie",
"company_profile": null,
"title": "Mrs",
"type": "PERSON",
"first_name": "Jessie",
"name": "Jessie Pickman",
"id": "2F3CDD2FDA4BD2832DED9FD71A6FAFBF",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country":
{
"name": "UNITED STATES",
"id": "127"
},
"passport_number": "2234567",
"social_security_number": "765656",
"country_of_residence":
{
"name": "UNITED STATES",
"id": "127"
},
"industry_sector":
{
"name": "GOVERNMENTAL",
"id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
"alternative_code": "GOV"
},
"date_of_birth":
{
"month": 5,
"day": 3,
"year": 1980
},
"name_day":
{
"month": 7,
"day": 11
},
"id_number": "11232345",
"id_issued_by_country":
{
"name": "UNITED STATES",
"id": "127"
},
"industry":
{
"name": "Industry1",
"id": "31BC2070C79EAE5455BFAD41599C5190",
"code": "In"
}
}
},
"life_cycle_state": "ACTIVE",
"number": "101",
"name": "PickmanAcc",
"id": "16DC87AEB2F308C82ED30D379787F0B6"
},
"life_cycle_state": "DRAFT",
"number": "S60136",
"type":
{
"name": "London",
"id": "3100B0D56E7C7EADF073C34BCE1E42AF",
"description": "For Subscribers residing in London
",
"alternative_code": "LND"
},
"id": "5F2B1F786E804DBC7B16C5F14B679E07"
},
"additive_discount_definition":
{
"life_cycle_state": "EFFECTIVE",
"classification": "SUBSCRIPTIONS",
"type": "AUTO_APPLY",
"name": "Lucia test 3",
"id": "35346B2FB563CD998DF9DFF00949CD7C",
"alternative_code": "lt3"
},
"approved_by":
{
"person_name": "Meri",
"username": "Meri",
"id": "573150C4CE1882B98D3D65DB9390D851",
"email": null
},
"applied_on": null,
"approved_on": "2014-07-11T12:20:47",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"log_information":
{
"updated_date": "2015-02-20T11:20:51",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Developers Group",
"name": "Developers Unit",
"id": "C4370788B2630BC8A99E8C7397406C09",
"description": null,
"alternative_code": null
},
"created_date": "2014-07-11T12:20:47",
"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": "Meri",
"username": "Meri",
"id": "573150C4CE1882B98D3D65DB9390D851",
"email": null
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"provided_by":
{
"person_name": "Meri",
"username": "Meri",
"id": "573150C4CE1882B98D3D65DB9390D851",
"email": null
},
"life_cycle_state": "APPROVED",
"provided_on": "2014-07-11T12:20:47",
"applied": true,
"job": null,
"expiration_date": "2015-02-20T11:20:51"
}
}
|
|
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"data": {
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-04-05T12:28:50",
"updated_date": "2016-04-05T12:29:59",
"updated_by_user": {
"person_name": "emichailidou",
"id": "9A2CF58F91D94B8B981C33275BA20880",
"username": "emichailidou"
},
"created_by_user": {
"person_name": "emichailidou",
"id": "9A2CF58F91D94B8B981C33275BA20880",
"username": "emichailidou"
}
},
"applied": true,
"discount_amount": 3,
"currency_rate_period": null,
"approved_on": "2016-04-05T12:29:59",
"discount_percentage": null,
"subscription": {
"number": "S0000000143",
"first_activated_date": "2016-03-22T10:16:08",
"rating_state": "PENDING",
"accounts_receivable": {
"number": "ACR0000000131",
"name": "ACR0000000131 Donna Paulsen",
"id": "6CBF60D6BA7843B3AEF6C1E1975F493A",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Donna Paulsen",
"last_name": "Paulsen",
"id": "2D64B10AFF7E4FC6B219FCD58C014245",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Donna",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "659832",
"gender": null,
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "B00030B52FFB4D64A19E91B67A8FCB24",
"life_cycle_state": "EFFECTIVE",
"type": {
"alternative_code": "normalsub",
"name": "Normal",
"description": null,
"id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
}
},
"expiration_date": null,
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"products_set": [
{
"product": {
"code": "Sports 1",
"product_type": {
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "AS",
"composition_method": "FLAT",
"name": "Additional Services",
"description": null,
"id": "C8321F0BCA8A4051857BC35CEEE41555",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S1",
"description": null,
"id": "02191FFC231D4FBD844D0BB66EBAB14B"
},
"id": "AC7ABCD8F6414E68BCA3319BD43B8C14"
},
{
"product": {
"code": "Movies 1",
"product_type": {
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "AS",
"composition_method": "FLAT",
"name": "Additional Services",
"description": null,
"id": "C8321F0BCA8A4051857BC35CEEE41555",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "M1",
"description": null,
"id": "571C10876AF840088372A94A14D0A02C"
},
"id": "26D4295C75FB4F8B838C1ECEAD4BC14B"
},
{
"product": {
"code": "Music1",
"product_type": {
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "AS",
"composition_method": "FLAT",
"name": "Additional Services",
"description": null,
"id": "C8321F0BCA8A4051857BC35CEEE41555",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "M",
"description": null,
"id": "D6453416BB704BC4A5448C06F361B5D3"
},
"id": "6D51BBABA4574F6EA674C1B8848B79E2"
},
{
"product": {
"code": "Bronze",
"product_type": {
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "Main Packages",
"composition_method": "FLAT",
"name": "Main Packages",
"description": null,
"id": "E186E293AAAB49EE86A729540A4287FE",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "B",
"description": null,
"id": "F50CC52934BD4F119B6E18E215A4FC55"
},
"id": "030E6F384D30432B8456014ED1C8CE50"
}
],
"udf_date_3": null,
"number": "8",
"udf_float_3": null,
"udf_float_4": null,
"effective_date": null,
"id": "DB9999B5D4634087BC448B19D46CEDAB",
"udf_float_1": null,
"approval_method": "AUTOMATIC",
"udf_float_2": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"cancelled_by": null,
"udf_string_1": null,
"additive_discount_definition": {
"alternative_code": "AHFBIAMT1M",
"name": "Ad Hoc for Buy in Advance more than 11 months",
"id": "B31BC3885FC64610BB67D7DF5CBDAF87",
"life_cycle_state": "EFFECTIVE",
"classification": "SUBSCRIPTIONS",
"type": "AD_HOC"
},
"life_cycle_state": "APPROVED",
"cancelled_on": null,
"provided_on": "2016-04-05T12:29:59",
"approved_by": {
"person_name": "emichailidou",
"id": "9A2CF58F91D94B8B981C33275BA20880",
"username": "emichailidou"
},
"applied_on": "2016-04-05T12:35:43",
"provided_by": {
"person_name": "emichailidou",
"id": "9A2CF58F91D94B8B981C33275BA20880",
"username": "emichailidou"
},
"udf_string_6": null,
"job": null,
"udf_string_7": null,
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
|
GET additive_discounts/ad_hoc_discounts/list
This method returns information related with ad hoc discounts. Multiple ad hoc discounts are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(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:
...
(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)
...
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)
...
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)
...
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)
...
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)
...
applied
(optional)
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
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
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. More than one semi-optional parameters can be specified at the same time
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"products_set":
[
{
"id": "20F5F79CE3061B00615EF69273493201",
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": false,
"composition_method": "FIXEDBUNDLE",
"classification": "SERVICES",
"name": "Fixed Bundle",
"id": "AF80230C21FDBD38C3D24777BE9CA333",
"description": null,
"alternative_code": "Fixed Bundle"
},
"id": "468733DA92F19F0F9208F9B91A93E243",
"description": null,
"code": "Viasat ",
"alternative_code": "Viasat"
}
},
{
"id": "81C527EC9134BE1272BD1E1534DBAEB6",
"product":
{
"product_type":
{
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"id": "A2B00E27070BEB1B1273733260A45ACC",
"description": "Athina STB",
"code": "Athina STB",
"alternative_code": "A-STB"
}
}
],
"number": "AH001",
"id": "789FBA44C27D1DA69AB3652E0F5575E7"
}
]
} |
|
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"data": [
{
"number": "10",
"currency_rate_period": null,
"id": "31540591B4FA4AA79E69491A4CCA41E5",
"subscription": {
"number": "S0000000237",
"first_activated_date": "2016-06-27T09:55:27",
"rating_state": "PENDING",
"accounts_receivable": {
"number": "ACR0000000264",
"name": "ACR0000000264 Alternative Currency",
"id": "4820A781EFF243DF96DD44487EBA5C74",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Alternative Currency",
"last_name": "Currency",
"id": "E6E1240F3C8C48CE83159DB9AF89284B",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Alternative",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "92D9C684154E4197A6B0DE314D40C995",
"life_cycle_state": "NOT_EFFECTIVE",
"type": {
"alternative_code": "normalsub",
"name": "Normal",
"description": null,
"id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
}
}
},
{
"number": "9",
"currency_rate_period": null,
"id": "A61C0CDB9E164E16916BFA5B927268CF",
"subscription": {
"number": "S0000000237",
"first_activated_date": "2016-06-27T09:55:27",
"rating_state": "PENDING",
"accounts_receivable": {
"number": "ACR0000000264",
"name": "ACR0000000264 Alternative Currency",
"id": "4820A781EFF243DF96DD44487EBA5C74",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Alternative Currency",
"last_name": "Currency",
"id": "E6E1240F3C8C48CE83159DB9AF89284B",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Alternative",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "92D9C684154E4197A6B0DE314D40C995",
"life_cycle_state": "NOT_EFFECTIVE",
"type": {
"alternative_code": "normalsub",
"name": "Normal",
"description": null,
"id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
}
}
},
{
"number": "8",
"currency_rate_period": null,
"id": "DB9999B5D4634087BC448B19D46CEDAB",
"subscription": {
"number": "S0000000143",
"first_activated_date": "2016-03-22T10:16:08",
"rating_state": "PENDING",
"accounts_receivable": {
"number": "ACR0000000131",
"name": "ACR0000000131 Donna Paulsen",
"id": "6CBF60D6BA7843B3AEF6C1E1975F493A",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Donna Paulsen",
"last_name": "Paulsen",
"id": "2D64B10AFF7E4FC6B219FCD58C014245",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Donna",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "659832",
"gender": null,
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "B00030B52FFB4D64A19E91B67A8FCB24",
"life_cycle_state": "EFFECTIVE",
"type": {
"alternative_code": "normalsub",
"name": "Normal",
"description": null,
"id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
}
}
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
|
|
POST additive_discounts/ad_hoc_discounts/create
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)
...
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)
...
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)
...
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)
...
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:
...
| Tip |
|---|
Available from CRM.COM R11.0.0 |
...
effective_date
(optional)
...
expiration_date
(optional)
...
provided_by_identifier
(optional)
...
provided_on
(optional)
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
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
...
discount_free_period
(mandatory and applicable on conditions)
...
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.
...
products_set
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters.
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"43584180E9AB4A2C930F2E5EA53A2E0B",
"additive_discount_definition_identifier":{"name":"Lucia Test 4"},
"subscription_identifier":{"number":"S60310"},
"discount_free_period":
{
"time_period_value":8,
"time_period_uot":"DAYS"
},
"effective_date":"2015-09-03T12:49:59",
"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":"add",
"product_identifier":{"code":"P1"}
},
{
"action":"add",
"product_identifier":{"code":"P2"}
}
]
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"cancelled_by": null,
"effective_date": "2015-09-03T12:49:59",
"udf_float_1": 10,
"products_set":
[
{
"id": "9B4EB64979BF4C10AAC882112BE3CA09",
"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"
}
},
{
"id": "603B866C8D96416DB998197973AF5751",
"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": "B1E02AFD27BD8D28762873E9EF4880DE",
"description": null,
"code": "P2",
"alternative_code": "P2"
}
}
],
"udf_float_2": 20,
"udf_float_3": 30,
"number": "25",
"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": "A1B073FED79642F2956E0F3F5C50EB7A",
"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-09T14:26:48",
"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-09T14:26:26",
"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": "Marios Lannister",
"username": "mpadministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "mpadministrator",
"id": "1"
}
},
"provided_by":
{
"person_name": "Marios Lannister",
"username": "mpadministrator",
"id": "1"
},
"life_cycle_state": "PENDING_APPROVAL",
"discount_free_period":
{
"time_period_value": 8,
"time_period_uot": "DAYS"
},
"provided_on": "2015-03-09T14:26:34",
"applied": false,
"job": null,
"expiration_date": null
}
} |
|
POST additive_discounts/ad_hoc_discounts/update
This method updated 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)
...
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)
...
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)
...
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:
...
| Tip |
|---|
Available from CRM.COM R11.0.0 |
...
effective_date
(optional)
...
expiration_date
(optional)
...
provided_by_identifier
(optional)
...
provided_on
(optional)
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
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
...
discount_free_period
(optional and applicable on conditions)
...
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.
...
products_set
(optional)
...
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
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters.
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"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: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"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
}
} |
|
POST additive_discounts/ad_hoc_discounts/approve
This method approves an ad hoc discount, which is in a pending approval life cycle state. A single ad hoc discount can be approved by each call.
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 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)
...
approved_on
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters.
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"8EF60E0F870C4D06A67359D705885CBE",
"ad_hoc_discount_identifier":{"number":"20"},
"approved_by_identifier":{ "username" : "mpadministrator" },
"approved_on" : "2015-03-09T10:58:39"
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"cancelled_by": null,
"effective_date": "2015-03-09T10:50:18",
"udf_float_1": null,
"products_set":
[
{
"id": "522C84F80F23463892AC0214FEF60B91",
"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"
}
},
{
"id": "7FD301CDE8FA49D7B34F9DBFF74370EE",
"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": "B1E02AFD27BD8D28762873E9EF4880DE",
"description": null,
"code": "P2",
"alternative_code": "P2"
}
}
],
"udf_float_2": null,
"udf_float_3": null,
"number": "20",
"udf_float_4": null,
"udf_string_1": null,
"udf_string_2": null,
"cancelled_on": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"discount_amount": null,
"discount_percentage": null,
"id": "F8BD6501D24141578ED17549D8890DBD",
"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":
{
"person_name": "Marios Lannister",
"username": "mpadministrator",
"id": "1",
"email": "mp@ministrator.com"
},
"applied_on": null,
"approved_on": "2015-03-09T10:58:39",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"log_information":
{
"updated_date": "2015-03-09T11:17:12",
"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-09T10:50:05",
"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": "APPROVED",
"discount_free_period":
{
"time_period_value": 8,
"time_period_uot": "DAYS"
},
"provided_on": "2015-03-09T10:50:21",
"applied": false,
"job": null,
"expiration_date": null
}
} |
|
POST additive_discounts/ad_hoc_discounts/cancel
This method cancels an ad hoc discount, which is in a pending approval life cycle state or approved but not applied yet. A single ad hoc discount can be cancelled by each call.
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 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)
...
cancelled_on
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters.
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"4C5D6C83A5584D928FCBAA30DAA58E36",
"ad_hoc_discount_identifier":{"number":"21"},
"cancelled_by_identifier":{ "username" : "mpadministrator" },
"cancelled_on" : "2015-03-09T10:58:39"
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"cancelled_by":
{
"person_name": "Marios Lannister",
"username": "mpadministrator",
"id": "1",
"email": "mp@ministrator.com"
},
"effective_date": "2015-03-09T11:23:06",
"udf_float_1": 10,
"products_set":
[
{
"id": "221A5B9530464947AA22AB752B792BB6",
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription services",
"id": "600438B64B0F05AB3D020C902674949F",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "DAD03F53603E48B419E48BFDD737B65C",
"description": "Add on for P1",
"code": "Add on Movies",
"alternative_code": "P111"
}
},
{
"id": "1820896845FA4CA2925ACC130FEC58F2",
"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": "B1E02AFD27BD8D28762873E9EF4880DE",
"description": null,
"code": "P2",
"alternative_code": "P2"
}
},
{
"id": "B0883E6EEB2847A895974624CFFE761A",
"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"
}
},
{
"id": "F0ECF83C05C9421F816E8CD508DF509D",
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "USAGE",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Usage Services",
"id": "219FBB8FBAA1433AB0A33446B61637F9",
"description": "A type which is used for usage services",
"alternative_code": "US"
},
"id": "3ECE39556C0CFCD7610F05063C189EF6",
"description": "Video On Demand Service",
"code": "Video On Demand Service",
"alternative_code": "VOD"
}
}
],
"udf_float_2": 20,
"udf_float_3": 30,
"number": "21",
"udf_float_4": 40,
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"cancelled_on": "2015-03-09T10:58:39",
"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": "051BC89877B94C88928D100925904EB2",
"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-09T12:22:53",
"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-09T11:22:54",
"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": "CANCELLED",
"discount_free_period":
{
"time_period_value": 8,
"time_period_uot": "DAYS"
},
"provided_on": "2015-03-09T11:23:10",
"applied": false,
"job": null,
"expiration_date": null
}
} |
|
POST additive_discounts/auto_apply_disounts/get_applicable_discounts
This method returns a list of discounts that will automatically be applied on a subscription or a job having the specified characteristics. Multiple auto apply discounts are returned by each call
Resource URL
Parameters
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 |
subscription (semi-optional) | Subscriptions Object | Information related with the subscription that could possibly be discounted |
job (semi-optional) | Job Object | Information related with the job that could possibly be discounted |
buy_in_advance_request (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. | Tip |
|---|
Available from CRM.COM R6.0.0 |
|
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 |
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one semi-optional parameter can be specified.
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"BC0919815F72418DBADA3F5F19C012F9",
"accounts_receivable":
{
"classification_identifier":{"name":"Employee"},
"presentment_preferences_set":
[
{"presentment_preference_identifier":{"name":"By Email"}},
{"presentment_preference_identifier":{"name":"By Post"}}
],
"payment_preferences_set":
[
{"payment_preference_identifier":{"name":"PayPal"}}
]
},
"subscription":
{
"type_identifier":{"name":"London"},
"owned_by_group_identifier": {"name":"Main Group"},
"billing_terms":
{
"billing_term_scheme_identifier":{"code":"MPBTS"},
"price_plan_identifier" : {"code":"ABPP"},
"billing_cycle_day":5,
"agreement_date": "2015-05-05T15:49:59",
"billing_frequency":"DAILY",
"binding_information":
{
"binding_period":"WEEK",
"start_date": "2015-06-05T15:49:59"
},
"concurrent_usage_based_pricing":
{
"concurrent_usage":10,
"rate_percentage":25
}
},
"services_set":
[
{
"service_identifier":{"code":"Bronze"}
},
{
"service_identifier":{"code":"Movies 2"}
}
]
}
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"discount_amount_UOT": null,
"to_date": "2016-03-11T00:00:00",
"from_date": "2015-04-06T00:00:00",
"free_period": null,
"discount_amount": null,
"discount_percentage": 25,
"additive_discount_definition":
{
"life_cycle_state": "EFFECTIVE",
"classification": "SUBSCRIPTIONS",
"type": "AUTO_APPLY",
"name": " Auto Apply TC 2_1",
"id": "B49A5B2D654B4E5F88DCD3DD8855BE63",
"alternative_code": "AAT2_1"
},
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription services",
"id": "600438B64B0F05AB3D020C902674949F",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "90578F46460B7C4530BE801CFE5CB9A1",
"description": "Movies 2",
"code": "Movies 2",
"alternative_code": "m2"
},
"free_period_UOT": null
}
]
} |
|
POST additive_discounts/ad_hoc_disounts/get_available_discounts
This method returns a list of ad hoc discounts that are available for a subscription or a job having the specified characteristics. Ad hoc discounts are applied manually. Multiple ad hoc discounts are returned by each call
Resource URL
Parameters
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 |
subscription (semi-optional) | Subscriptions Object | Information related with the subscription that could possibly be discounted |
job (semi-optional) | Job Object | Information related with the job that could possibly be discounted |
buy_in_advance_request (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. | Tip |
|---|
Available from CRM.COM R6.0.0 |
|
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 |
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one semi-optional parameter can be specified.
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: POST
Request:
Body:
| Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"token":"C224050D1AD945009263D65CE98AFE35",
"accounts_receivable":
{
"classification_identifier":{"name":"Employee"},
"presentment_preferences_set":
[
{"presentment_preference_identifier":{"name":"By Email"}},
{"presentment_preference_identifier":{"name":"By Post"}}
],
"payment_preferences_set":
[
{"payment_preference_identifier":{"name":"PayPal"}}
]
},
"subscription":
{
"type_identifier":{"name":"London"},
"owned_by_group_identifier": {"name":"Main Group"},
"billing_terms":
{
"billing_term_scheme_identifier":{"code":"ABTS"},
"price_plan_identifier" : {"code":"BPP0614"},
"billing_cycle_day":5,
"agreement_date": "2015-05-05T15:49:59",
"billing_frequency":"DAILY",
"binding_information":
{
"binding_period":"WEEK",
"start_date": "2015-06-05T15:49:59"
}
},
"services_set":
[
{
"service_identifier":{"code":"Bronze"}
},
{
"service_identifier":{"code":"Movies 2"}
}
]
}
} |
Response:
| Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"discount_amount_UOT": "YEARS",
"to_date": "2015-06-12T00:00:00",
"from_date": "2015-05-05T00:00:00",
"free_period": null,
"discount_amount": 50,
"discount_percentage": null,
"additive_discount_definition":
{
"life_cycle_state": "EFFECTIVE",
"classification": "SUBSCRIPTIONS",
"type": "AD_HOC",
"name": "Sub Test",
"id": "78309B32849D44C1B11DFE8A9796F9C7",
"alternative_code": "ST"
},
"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": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"description": "Bronze Premium Package",
"code": "Bronze",
"alternative_code": "BP"
},
"free_period_UOT": null
},
{
"discount_amount_UOT": "YEARS",
"to_date": "2015-06-12T00:00:00",
"from_date": "2015-05-05T00:00:00",
"free_period": null,
"discount_amount": 50,
"discount_percentage": null,
"additive_discount_definition":
{
"life_cycle_state": "EFFECTIVE",
"classification": "SUBSCRIPTIONS",
"type": "AD_HOC",
"name": "Sub Test",
"id": "78309B32849D44C1B11DFE8A9796F9C7",
"alternative_code": "ST"
},
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription services",
"id": "600438B64B0F05AB3D020C902674949F",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "90578F46460B7C4530BE801CFE5CB9A1",
"description": "Movies 2",
"code": "Movies 2",
"alternative_code": "m2"
},
"free_period_UOT": null
}
]
}| Panel |
|---|
|
| Child pages (Children Display) |
|---|
|
|