Tip
Available from CRM.COM R5.0.0

Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

applied_additive_discount_identifier

(mandatory)

Applied Additive Discount identifier

The identifier of the applied additive discount that should be returned as a result. The allowed applied additive discount identifier fields are the following:

Include Page

	V4:applied_additive_discount_identifier
	V4:applied_additive_discount_identifier

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

additive_discount_definition_identifier

(semi-optional)

Additive Discount Definition identifier

The identifier of the additive discount definition related with the applied additive that should be returned as a result. The allowed additive discount definition identifier fields are the following:

Include Page

	V4:additive_discount_definition_identifier
	V4:additive_discount_definition_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable identifier

The identifier of the accounts receivable related with the applied additive discount that should be returned as a result. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

subscription_identifier

(semi-optional)

Subscription identifier

The identifier of the subscription related with the applied additive discount that should be returned as a result. The allowed subscription identifier fields are the following:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

job_identifier

(semi-optional)

Job identifier

The identifier of the job related with the applied additive discount that should be returned as a result. The allowed job identifier fields are the following:

Include Page

	V4:job_identifier
	V4:job_identifier

additive_discount_definition_classification

(semi-optional)

String

The classification of the additive discount definition related with the applied additive that should be returned as a result. The supported classifications are SUBSCRIPTIONS and JOBS

additive_discount_definition_type

(semi-optional)

String

The type of the additive discount definition related with the applied additive that should be returned as a result. The supported classifications are AUTO_APPLIED and AD_HOC

from_date

(optional)

Date

It determines the date that the applied additive discount becomes effective. If specified then only applied additive discounts which were effective on that date or after that date will be retrieved

to_date

(optional)

Date

It determines the date that the applied additive discount becomes not effective. If specified then only applied additive discounts which were effective up to that date or before that date will be retrieved

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

ad_hoc_discount_identifier

(mandatory)

Ad hoc discount identifier

The identifier of the ad hoc discount that should be returned as a result. The allowed ad hoc discount identifier fields are the following:

Include Page

	V4:ad_hoc_discount_identifier
	V4:ad_hoc_discount_identifier

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

additive_discount_definition_identifier

(semi-optional)

Additive Discount Definition identifier

The identifier of the additive discount definition related with the ad hoc discounts that should be returned as a result. Only additive discount definitions of type Ad Hoc can be specified.The allowed additive discount definition identifier fields are the following:

Include Page

	V4:additive_discount_definition_identifier
	V4:additive_discount_definition_identifier

subscription_identifier

(semi-optional)

Subscription identifier

The identifier of the subscription related with the ad hoc discounts that should be returned as a result. The allowed subscription identifier fields are the following:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

job_identifier

(semi-optional)

Job identifier

The identifier of the job related with the ad hoc discounts that should be returned as a result. The allowed job identifier fields are the following:

Include Page

	V4:job_identifier
	V4:job_identifier

provided_by_identifier

(semi-optional)

User Identifier

The identifier of the user that provided the ad hoc discounts that should be returned as a result. The allowed user identifier fields are the following:

Include Page

	V4:user_identifier
	V4:user_identifier

approved_by_identifier

(semi-optional)

User Identifier

The identifier of the user that approved the ad hoc discounts that should be returned as a result. The allowed user identifier fields are the following:

Include Page

	V4:user_identifier
	V4:user_identifier

cancelled_by_identifier

(semi-optional)

User Identifier

The identifier of the user that cancelled the ad hoc discounts that should be returned as a result. The allowed user identifier fields are the following:

Include Page

	V4:user_identifier
	V4:user_identifier

life_cycle_state

(semi-optional)

String

The life cycle state of the ad hoc discounts that should be returned as a result. The supported life cycle states are PENDING_APPROVAL, APPROVED and CANCELLED

applied

(optional)

Boolean

If set to TRUE the only ad hoc discounts that were already applied will be returned as a result. If set to FALSE then only ad hoc discounts that are not applied yet will be returned as a result. If not specified then any ad hoc discounts will be retrieved.

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

additive_discount_definition_identifier

(mandatory)

Additive Discount Definition identifier

The identifier of the additive discount definition that will be applied. Only additive discount definitions of type Ad Hoc can be specified, considering that they can be applied on the specified subscription or job, and by the specified user.The allowed additive discount definition identifier fields are the following:

Include Page

	V4:additive_discount_definition_identifier
	V4:additive_discount_definition_identifier

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:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

job_identifier

(mandatory on conditions)

Job identifier

The identifier of the job on which the ad hoc discount will be applied on. This information is mandatory unless a subscription is specified. In that case it is not allowed to specified a job as well. The allowed job identifier fields are the following:

Include Page

	V4:job_identifier
	V4:job_identifier

discount_amount

(mandatory and applicable on conditions)

Number

The discount amount that will be applied.

This information is applicable and mandatory if the additive discount definition is set up to provide a range of discount based on amount

discount_percentage

(mandatory and applicable on conditions)

Number

The discount percentage that will be applied.

This information is applicable and mandatory if the additive discount definition is set up to provide a range of discount based on percentage

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:

Include Page

	V4:user_identifier
	V4:user_identifier

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

discount_free_period

(mandatory and applicable on conditions)

Time Period Object

The free period that will be provided, measured in days, weeks, months or years.

This information is applicable and mandatory if the additive discount definition is set up to provide a range of discount based on free period.

products_set

(optional)

Set of Ad hoc Discount Products Objects

The products that the discount will be applied on, considering that they are allowed by the specified subscription or job and the specified additive discount definition. If not specified then the discount will be applicable on any products that will be billed

...

Name

Type

Description

token

String

The token retrieved from the login method

ad_hoc_discount_identifier

(mandatory)

Ad hoc discount identifier

The identifier of the ad hoc discount that will be updated. Only ad hoc discounts in a pending life cycle state can be specified.The allowed ad hoc discount identifier fields are the following:

Include Page

	V4:ad_hoc_discount_identifier
	V4:ad_hoc_discount_identifier

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

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:

Include Page

	V4:user_identifier
	V4:user_identifier

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

discount_free_period

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

products_set

(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

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

...

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:

Include Page

	V4:ad_hoc_discount_identifier
	V4:ad_hoc_discount_identifier

approved_by_identifier

(optional)

User Identifier

The identifier of the user that approved the ad hoc discount. If not specified then it defaults to the user that submitted the request into the system. The user is validated against the list of users that are authorized to approve ad hoc discounts. The allowed user identifier fields are the following:

Include Page

	V4:user_identifier
	V4:user_identifier

approved_on

(optional)

Date

The date that the ad hoc discount was approved. If not specified then it defaults to the date that the request was submitted into the system.

...

Name

Type

Description

token

String

The token retrieved from the login method

ad_hoc_discount_identifier

(mandatory)

Ad Hoc Discount identifier

The identifier of the ad hoc discount that will be cancelled. Only ad hoc discounts in a pending approval life cycle state or approved but not applied can be specified. The allowed ad hoc discount identifier fields are the following:

Include Page

	V4:ad_hoc_discount_identifier
	V4:ad_hoc_discount_identifier

cancelled_by_identifier

(optional)

User Identifier

The identifier of the user that cancelled the ad hoc discount. If not specified then it defaults to the user that submitted the request into the system. The allowed user identifier fields are the following:

Include Page

	V4:user_identifier
	V4:user_identifier

cancelled_on

(optional)

Date

The date that the ad hoc discount was cancelled. If not specified then it defaults to the date that the request was submitted into the system.

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable

(mandatory)

Accounts Receivable Object

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

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

Anchor

	applicable discounts referred objects parameters
	applicable discounts referred objects parameters

Referred Parameters Objects Data

Include Page

	V4:additiverate_discountcalculation_accounts_receivable_parameters
	V4:additiverate_discountcalculation_accounts_receivable_parameters

Include Page

	V4:additiverate_discountcalculation_subscription_parameters
	V4:additiverate_discountcalculation_subscription_parameters

Include Page

	V4:additive_discount_job_parameters
	V4:additive_discount_job_parameters

Include Page

	V4:additiverate_discountcalculation_buy_in_advance_request_parameters
	V4:additiverate_discountcalculation_buy_in_advance_request_parameters

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "token":"8A3F1E31615449B5A87AD40897936E27BC0919815F72418DBADA3F5F19C012F9",
  "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":"Bitcoin"}},
     {"payment_preference_identifier":{"name":"PayPal"}}
    ] 
   },
 "subscription":
  {
    "type_identifier":{"name":"London"},
    "owned_by_group_identifier": {"name":"Main Group"},
    "billing_terms":
    {
      "billing_term_scheme_identifier":{"code":"ANSCHMMPBTS"},
      "price_plan_identifier" : {"code":"APRPLABPP"},
      "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": "20182016-0503-05T0011T00:00:00",
            "from_date": "2015-0504-05T0006T00:00:00",
            "free_period": null,
            "discount_amount": null,
            "discount_percentage": 5025,
            "additive_discount_definition":
            {
                "life_cycle_state": "EFFECTIVE",
                "classification": "SUBSCRIPTIONS",
                "type": "AUTO_APPLY",
                "name": "Additive Auto DiscountApply DefinitionTC 2_1",
                "id": "0BC69BFD265204817A563DF7D336644BB49A5B2D654B4E5F88DCD3DD8855BE63",
                "alternative_code": "ADD1AAT2_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 Package",
                "code": "Movies 2",
                "alternative_code": "m2"
            },
            "free_period_UOT": null
        },
        {
            "discount_amount_UOT": null,
            "to_date": "2018-05-05T00:00:00",
            "from_date": "2015-05-05T00:00:00",
            "free_period": null,
            "discount_amount": null,
            "discount_percentage": 50,
            "additive_discount_definition":
            {
                "life_cycle_state": "EFFECTIVE",
                "classification": "SUBSCRIPTIONS",
                "type": "AUTO_APPLY",
                "name": "Additive Discount Definition 1",
                "id": "0BC69BFD265204817A563DF7D336644B",
                "alternative_code": "ADD1"
            },
            "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 Package",
                "code": "Bronze",
                "alternative_code": "BP"
            },
            "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

...

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

Anchor

	available discounts referred objects parameters
	available discounts referred objects parameters

Referred Parameters Objects Data

Include Page

	V4:additiverate_discountcalculation_accounts_receivable_parameters
	V4:additiverate_discountcalculation_accounts_receivable_parameters

Include Page

	V4:additiverate_discountcalculation_subscription_parameters
	V4:additiverate_discountcalculation_subscription_parameters

Include Page

	V4:additive_discount_job_parameters
	V4:additive_discount_job_parameters

Include Page

	V4:additiverate_discountcalculation_buy_in_advance_request_parameters
	V4:additiverate_discountcalculation_buy_in_advance_request_parameters

...

Versions Compared

Old Version 47

New Version 48

Key

POST additive_discounts/ad_hoc_disounts/get_available_discounts

Page Comparison

Versions Compared

Old Version 47

New Version 48

Key

POST additive_discounts/ad_hoc_disounts/get_available_discounts