Page Comparison

...

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.
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

...

title	Example 1

HTTP Method: POST

Request:

Body:

...

theme	Confluence
language	javascript
linenumbers	true

...

Excerpt
This method returns a list of auto-apply discounts that could be applied to a subscription or 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

(semi-optional)

Accounts Receivable Object

Information related with the accounts receivable that will own the subscription or the job that could possibly be discounted

Tip
Up to CRM.COM R14 accounts receivable was a mandatory

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
Not available from CRM.COM R15.0.0

product

(optional)

Products Object

The product the discount is for.

Tip
Applicable from CRM.COM R15.0.0

existing_product_list

(optional)

Set of invoice physical goods

A list of physical goods that will be bought by the customer, used to validated against discounts' existing product conditions. This is only applicable for quick sales, as the existing products of jobs and subscriptions are taken through the defined entity.

Tip
Applicable from CRM.COM R15.0.0

date

(optional)

Date

The date for which you want to see the available discounts for.
Applicable for all products apart from termed services

Tip
Applicable from CRM.COM R15.0.0

from_date

(optional)

Date

The date from which the termed service discount will be applied from.

Applicable only for termed services

Tip
Applicable from CRM.COM R15.0.0

to_date

(optional)

Date

The date up to which the termed service discount will be applied to

Applicable only for termed services

Tip
Applicable from CRM.COM R15.0.0

usage_amount

(optional)

Float

The usage amount of the usage service.

Applicable only for usage services

Tip
Applicable from CRM.COM R15.0.0

usage_zone

(optional)

String

The usage zone the usage service belongs to.

Applicable only for usage services

Tip
Applicable from CRM.COM R15.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

Anchor

	applicable discounts referred objects parameters
	applicable discounts referred objects parameters

Referred Parameters Objects Data

Include Page

	V4:rate_calculation_accounts_receivable_parameters
	V4:rate_calculation_accounts_receivable_parameters

Include Page

	V4:rate_calculation_subscription_parameters
	V4:rate_calculation_subscription_parameters

Include Page

	V4:additive_discount_job_parameters
	V4:additive_discount_job_parameters

Include Page

	V4:rate_calculation_buy_in_advance_request_parameters
	V4:rate_calculation_buy_in_advance_request_parameters

Include Page

	V4:additive_discount_discounted_product_parameters
	V4:additive_discount_discounted_product_parameters

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one semi-optional parameter can be specified.

Response Data

Include Page

	V4:applicable_additive_discounts_short
	V4:applicable_additive_discounts_short

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language	xml
linenumbers	true

{
  "token":"{{token}}",
 "subscription":
  {
    "type_identifier":{"name":"Normal"},
    "owned_by_group_identifier": {"name":"Main Group"},
     "billing_terms":
    {
      "billing_term_scheme_identifier":{"code":"Normal Billing Scheme"},
      "price_plan_identifier" : {"code":"BPPT"},
      "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"}
      }
     ]
  }
}

Response:

Code Block

language	xml
linenumbers	true

{
    "data": [
        {
            "product": null,
            "discount_option": "PERCENTAGE",
            "from_date": "2015-05-05T00:00:00",
            "to_date": null,
            "discount_amount": null,
            "additive_discount_definition": {
                "alternative_code": "PS1B",
                "name": "Pricing SB 19 B",
                "id": "F7A2BAD8EC1C49A18F4E394BA37973FC",
                "life_cycle_state": "EFFECTIVE",
                "classification": "GENERAL",
                "type": "AUTO_APPLY"
            },
            "for": null,
            "currency": {
                "suffix_symbol": null,
                "prefix_symbol": "€",
                "decimal_part_name": null,
                "code": "EUR",
                "integer_part_name": null,
                "id": "2",
                "life_cycle_state": "EFFECTIVE"
            },
            "discount_percentage": 20,
            "renew": null,
            "discount_free_usage": null
        },
        {
            "product": null,
            "discount_option": "PERCENTAGE",
            "from_date": "2015-05-05T00:00:00",
            "to_date": null,
            "discount_amount": null,
            "additive_discount_definition": {
                "alternative_code": "PS1C",
                "name": "Pricing SB 19 C",
                "id": "7482128AE0644004AD823A103A50CC9C",
                "life_cycle_state": "EFFECTIVE",
                "classification": "GENERAL",
                "type": "AUTO_APPLY"
            },
            "for": null,
            "currency": {
                "suffix_symbol": null,
                "prefix_symbol": "€",
                "decimal_part_name": null,
                "code": "EUR",
                "integer_part_name": null,
                "id": "2",
                "life_cycle_state": "EFFECTIVE"
            },
            "discount_percentage": 30,
            "renew": null,
            "discount_free_usage": null
        },
        {
            "product": null,
            "discount_option": "FREE_USAGE",
            "from_date": "2015-05-05T00:00:00",
            "to_date": null,
            "discount_amount": null,
            "additive_discount_definition": {
                "alternative_code": "PS2A",
                "name": "Pricing SB 20 A",
                "id": "FACFA7509F46492A98BE37841B5A9D3A",
                "life_cycle_state": "EFFECTIVE",
                "classification": "SUBSCRIPTIONS",
                "type": "AUTO_APPLY"
            },
            "for": null,
            "currency": {
                "suffix_symbol": null,
                "prefix_symbol": "€",
                "decimal_part_name": null,
                "code": "EUR",
                "integer_part_name": null,
                "id": "2",
                "life_cycle_state": "EFFECTIVE"
            },
            "discount_percentage": null,
            "renew": null,
            "discount_free_usage": 10
        },
        {
            "product": null,
            "discount_option": "AMOUNT_PER_PERIOD",
            "from_date": "2015-05-05T00:00:00",
            "to_date": null,
            "discount_amount": 5,
            "additive_discount_definition": {
                "alternative_code": "PS2C",
                "name": "Pricing SB 20 C",
                "id": "63855F7EFCEA4E73A6C9B8C64FDF709A",
                "life_cycle_state": "EFFECTIVE",
                "classification": "SUBSCRIPTIONS",
                "type": "AUTO_APPLY"
            },
            "for": null,
            "currency": {
        "binding_period":"WEEK",         "startsuffix_datesymbol": "2015-06-05T15:49:59" null,
         },       "concurrent_usage_based_pricing":prefix_symbol": "€",
       {         "concurrentdecimal_part_usagename":10, null,
            "rate_percentage    "code":25 "EUR",
     }      },      "servicesinteger_part_setname":    null,
 [       {        "service_identifier":{"codeid":"Bronze"}
     "2",
 },       {        "servicelife_cycle_identifierstate":{ "code":EFFECTIVE"Movies
2"}       }      ]
  }
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

},
       {     "statusdiscount_percentage":
 null,
   {         "messagerenew": null,
            "descriptiondiscount_free_usage": null,
        "code": "OK"},
     },     "data":{
    [         {"product": null,
            "discount_amount_UOToption": null"PERCENTAGE_PER_PERIOD",
            "tofrom_date": "20162015-0305-11T0005T00:00:00",
            "fromto_date": "2015-04-06T00:00:00"null,
            "freediscount_periodamount": null,
            "additive_discount_amountdefinition": null, {
                "discountalternative_percentagecode": 25,"PS2B",
                 "additive_discount_definition":"name": "Pricing SB 20 B",
                 {"id": "803D9FDAB06B4F6ABF5E99C5FE347706",
                "life_cycle_state": "EFFECTIVE",
                "classification": "SUBSCRIPTIONS",
                "type": "AUTO_APPLY",
                "name": " Auto Apply TC 2_1",
   },
            "idfor": "B49A5B2D654B4E5F88DCD3DD8855BE63",{
                "alternativefor_codeoption": "AAT2_1"
        X_UOT",
   },             "productfor_uot": "WEEKS",
           {     "for_value": 1
          "product_type":  },
             "currency": {
   
                "physicalsuffix_good_typesymbol": null,
                    "serviceprefix_typesymbol": "TERMED€",
 
                  "useddecimal_forpart_provisioningname": truenull,
   
                "composition_methodcode": "FLATEUR",
                    "classification"integer_part_name": "SERVICES",
   null,
                "nameid": "Subscription services2",
   
                "idlife_cycle_state": "600438B64B0F05AB3D020C902674949FEFFECTIVE",
            },
       "description": "Subscription services",          "discount_percentage": 25,
            "alternative_coderenew": {
"SS"                 }"for_option": "EVERY_X_UOT",
                "idfor_uot": "90578F46460B7C4530BE801CFE5CB9A1MONTHS",
                "descriptionfor_value": "Movies 2", 1
            },
            "codediscount_free_usage": "Moviesnull
2",        }
    ],
    "alternative_codestatus": "m2"{
            }"code": "OK",
           "description": "free_period_UOT":,
null         }"message": ""
    ]}
}

Versions Compared

Old Version 7

New Version Current

Key

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples