POST additive_discounts/ad_hoc_discounts/create

This method creates an ad hoc discount to 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:

Name

Type

Description

id

(semi-optional)

String

The ID of the additive discount definition

name

(semi-optional)

String

The name of the additive discount definition

alternative_code

(semi-optional)

String

The alternative code of the additive discount definition

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 or account is specified. In that case it is not allowed to specified a subscription as well. The allowed subscription identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

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 or account is specified. In that case it is not allowed to specified a job as well. The allowed job identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the job

number

(semi-optional)

String

The number of the job

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

usage_amount

Number

The free usage 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 free usage

Available from CRM.COM R15.0.0

intended_currency_identifier

(optional)

Currency Identifier

The currency that the user was intended to use for the ad hoc discount. If specified then it is validated against the currency of the related accounts receivable and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the currency

code

(semi-optional)

String

The code of the currency

Available from CRM.COM R11.0.0

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user

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.

Not available from CRM.COM R15.0.0

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

Referred Parameters Objects Data

time period parameter object data

Name

Type

Description

time_period_value

(mandatory)

Number

The time period value

time_period_uot

(mandatory)

String

The time period unit of time

The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

ad_hoc_discount_product object parameter data

Name

Type

Description

product_identifier
(mandatory)

Product identifier

The product related with the ad hoc discount. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

Restrictions

It is mandatory to specify one of the semi-optional parameters.

Response Data

Name	Type	Description
id	String	The ID of the retrieved ad hoc discount
number	String	The number of the retrieved ad hoc discount
discount_option	String	The type of discount which will be applied, which can be one of the following AMOUNT AMOUNT_PER_PERIOD PERCENTAGE PERCENTAGE_PER_PERIOD FREE_USAGE Available from CRM.COM R15.0.0
discount_amount	Number	The discount amount that will be applied, if the additive discount definition is set up to provide a range of discount based on amount.
discount_amount_uot	String	The period of time that the ad hoc discount amount will be applied for Not available from CRM.COM R15.0.0
discount_percentage	Number	The discount percentage that will be applied, if the additive discount definition is set up to provide a range of discount based on percentage
discount_free_usage	Number	The free usage discount that will be applied, if the additive discount definition is set up to provide a range of discount based on usage. The UOM depends on the UOM of the usage service being discounted Available from CRM.COM R15.0.0
for	For Object	The discounted period every time the discount is given when the Discount Option is Percentage per Period or Amount per Period. The possible options are the following: X_UOT 1_Billing_Period Available from CRM.COM R15.0.0
renew	Renew Object	How often the discount is renewed (provided again) when the Discount Option is Percentage per Period or Amount per Period which can have one of the following options: Never Every_x_UOT Every_Billing_Cycle Available from CRM.COM R15.0.0
effective_date	Date	The date that the discount becomes effective
expiration_date	Date	The date that the discount will expire
life_cycle_state	String	The life cycle state of the retrieved ad hoc discount. Supported values are PENDING_APPROVAL, APPROVED and CANCELLED
provided_on	Date	The date that the ad hoc discount was provided
approved_on	Date	The date that the ad hoc discount was approved Not available from CRM.COM R15.0.0
cancelled_on	Date	The date that the ad hoc discount was cancelled Not available from CRM.COM R15.0.0
approval_method	String	The method that was followed in order to approve the the ad hoc discount. The supported approval methods are AUTOMATIC or MANUAL
applied	Boolean	It determines if the ad hoc discount was already applied or not. It returns true if the ad hoc discount was applied or false otherwise
applied_on	Date	The date that the ad hoc discount was applied.
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
discount_free_period	Time Period object	The free period that will be provided, measured in days, weeks, months or years. This information is available if the additive discount definition is set up to provide a range of discount based on free period. Not available from CRM.COM R15.0.0
subscription	Subscription Object	The subscription that the ad hoc discount will be applied on
job	Job Object	The job that the ad hoc discount will be applied on.
additive_discount_definition	Additive Discount Definition Object	The additive discount definition that will be applied by the ad hoc discount
provided_by	User Object	The user that provided the ad hoc discount
approved_by	User Object	The user that approved the ad hoc discount.
cancelled_by	User Object	The user that cancelled the ad hoc discount
currency_rate_period	Currency Rate Period Object	The currency rate period of the ad hoc discount Available from CRM.COM R10.0.0
log_information	Log Information Object	The log information of the retrieved ad hoc discount
products_set	Set of Ad hoc Discount Products Objects	Set of ad hoc discount products used to keep track of the products that the discount will be applied on. If not specified then the discount will be applicable on any products that will be billed

Referred Objects Response Data

additive dicsount for object response data

Name

Type

Description

for_option

String

The period for which the discount is for:

For_X_UOT
1_BILLING_PERIOD

for_value

Number

The for period value when the for_option is set to 'For X UOT'

for_uot

String

The For unit of time when the for_option is set to 'For X UOT'. The supported values are the following:

DAYS, WEEKS, MONTHS, YEARS

additive discount renew object response data

Name

Type

Description

renew_option

String

How often the discount is renewed (provided again) which can have one of the following options:

Never
Every_x_UOT
Every_Billing_Cycle

renew_value

Number

The renew every 'x' value when the renew option is set to Every X UOT

renew_uot

String

The renew period unit of time when the renew option is set to Every X UOT.

The supported values are the following:

DAYS, WEEKS, MONTHS, YEARS

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

subscription object response data

Name	Type	Description
id	String	The ID of the retrieved subscription
number	String	The number of the retrieved subscription
life_cycle_state	String	The life cycle state of the subscription. One of the following values is returned DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, REPLACED, PENDING_VERIFICATION REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R17.0.0 PENDING_VERIFICATION life cycle state available from CRM.COM R15.0.0
first_activated_date	Date	The date that the subscription became effective for the first time (i.e. the date that the first effective period of that subscription started) Available from CRM.COM R9.0.0
rating_state	String	The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
accounts_receivable	Accounts receivable object	The accounts receivable owning the subscriptions
type	Subscription type object	The type of the retrieved subscription

Referred Objects Response Data

accounts_receivable object response data

Name	Type	Description
id	String	The ID of the retrieved accounts receivable
number	String	The number of the retrieved accounts receivable
name	String	The name of the retrieved accounts receivable
life_cycle_state	String	The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED
account_owner	Contact information object	The contact information owning the accounts receivable

Referred Objects Response Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

subscription type object response data

Name	Type	Description
id	String	The ID of the retrieved subscription type
name	String	The name of the retrieved subscription type
alternative_code	String	The alternative code of the retrieved subscription type
description	String	A description of the retrieved subscription type
classification	String	The classification of the retrieved subscription type, Flexible or Package Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0

job object response data

Name	Type	Description
id	String	The ID of the retrieved job
number	String	The number of the retrieved job
description	String	The description of the retrieved job
life_cycle_state	String	The life cycle state of the retrieved job The supported options are DRAFT PENDING IN PROGRESS COMPLETED CANCELLED
rating_state	String	The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
accounts_receivable	Accounts Receivable object	The accounts receivable related with the specified job
type	Job type object	The type information of the retrieved job Available from CRM.COM R11.2.0

Referred Objects Response Data

accounts_receivable object response data

Name	Type	Description
id	String	The ID of the retrieved accounts receivable
number	String	The number of the retrieved accounts receivable
name	String	The name of the retrieved accounts receivable
life_cycle_state	String	The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED
account_owner	Contact information object	The contact information owning the accounts receivable

Referred Objects Response Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

job_type response data object

Name	Type	Description
Id	String	The ID of the retrieved job type
name	String	The Name of the retrieved job type
alternative_code	String	The Alternative Code of the retrieved job type
description	String	The Description of the retrieved job type
billing_directive	String	The billing directive of the retrieved job type The supported billing directive options are BILLABLE NOT_BILLABLE Available from CRM.COM R10.0.0
billing_method	String	The billing method of the retrieved job type. Applicable only for billable job types with fulfillment scope GENERIC_PURPOSE The supported billing methods are BILL_ON_STARTING_PROGRESS BILL_ON_COMPLETION Available from CRM.COM R10.0.0 From CRM.COM R15.0.0 and onward, this attribute will be deprecated
fulfillment_scope	String	The fulfillment scope of the retrieved job type The supported fulfillment scopes are GENERIC_PURPOSE NEW_SUBSCRIPTION ACTIVATE_SUBSCRIPTION DEACTIVATE_SUBSCRIPTION CANCEL_SUBSCRIPTION ADD_SUBSCRIPTION_SERVICES CANCEL_SUBSCRIPTION_SERVICES CHANGE_SUBSCRIPTION_LOCATION SWAP_SUBSCRIPTION_SERVICES SWAP_SUBSCRIPTION_INSTALLED_ITEMS REPLACE_PHYSICAL_GOODS The following fulfillment scopes will be available from CRM.COM R8.0.0 ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION The following fulfillment scopes will be available from CRM.COM R9.0.0 SWAP_SUBSCRIPTION_SERVICES, SWAP_SUBSCRIPTION_INSTALLED_ITEMS The following fulfillment scope will be available from CRM.COM R11.0.0 REPLACE_PHYSICAL_GOODS From CRM.COM R15.0.0 and onward, all fulfillment scopes* will be deprecated*
fulfillment_method	String	The fulfillment method of the retrieved job type The supported fulfillment methods are BASED_ON_ORDERED_ITEMS BASED_ON_DELIVERED_ITEMS From CRM.COM R15.0.0 and onward, this attribute will be deprecated

invoice object response data

Name	Type	Description
id	String	The ID of the retrieved invoice
number	String	The number of the retrieved invoice
reference_number	String	The reference number of the retrieved invoice
life_cycle_state	String	The life cycle state of the invoice. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED
issued_on	Date	The date that the invoice was issued
posted_on	Date	The date that the invoice was posted
due_on	Date	The date that the credit period for that specific invoice is ending.
total_amount	Number	The total amount of the invoice
outstanding_amount	Number	The total outstanding amount of the invoice
unsettled_amount	Number	The total unsettled amount of the invoice
currency_rate_period	Currency Rate Period object	The currency rate period based on which the invoice's amounts were calculated Available from CRM.COM R10.0.0

Referred Objects Response Data

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The Currency with which the returned exchange rate information refers to

Referred Objects Response Data

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

additive_discount_definition object response data

Name	Type	Description
id	String	The ID of the retrieved additive discount definition
alternative_code	String	The alternative code of the retrieved additive discount definition
name	String	The name of the retrieved additive discount definition
life_cycle_state	String	The life cycle state of the retrieved additive discount definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE
classification	String	The classification of the retrieved additive discount definition which can be either SUBSCRIPTIONS, JOBS or GENERAL GENERAL classification available from CRM.COM R15.0.0 JOB classification is not available from CRM.COM R17.0.0
type	String	The type of the additive discount definition which can be AUTO_APPLY or AD_HOC

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

ad_hoc_discount_product response data object

Name	Type	Description
id	String	The ID of the ad hoc discount product
product	Product Object	The product related with the ad hoc discount

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

Examples

Example 1

HTTP Method: POST

Request:

Body:

Body

 {
 "token":"{{token}}",
 "additive_discount_definition_identifier":{"name":"Pricing Audit Trail"},
 "subscription_identifier":{"number":"S0000009447"},
 "discount_percentage":26,
 "products_set":[
 {
 "action":"add",
 "product_identifier":{"code":"Bronze"}
 }
 ]
 
}


Response:
{
 "data": {
 "log_information": {
 "created_by_unit": {
 "alternative_code": "adminunit",
 "group_name": null,
 "community_name": null,
 "name": "Admin Unit",
 "description": "admin unit",
 "id": "1"
 },
 "updated_by_unit": {
 "alternative_code": "adminunit",
 "group_name": null,
 "community_name": null,
 "name": "Admin Unit",
 "description": "admin unit",
 "id": "1"
 },
 "created_date": "2018-06-18T12:56:46",
 "updated_date": "2018-06-18T12:56:46",
 "updated_by_user": {
 "person_name": null,
 "id": "1",
 "email": null,
 "username": "MPAdministrator"
 },
 "created_by_user": {
 "person_name": null,
 "id": "1",
 "email": null,
 "username": "MPAdministrator"
 }
 },
 "applied": false,
 "discount_amount": null,
 "for": null,
 "currency_rate_period": null,
 "approved_on": "2018-06-18T12:56:19",
 "discount_percentage": 26,
 "subscription": {
 "number": "S0000009447",
 "first_activated_date": "2018-06-18T10:17:06",
 "rating_state": "PENDING",
 "accounts_receivable": {
 "number": "ACR0000008718",
 "name": "ACR0000008718 Test 18062018_01",
 "id": "5DD09993C3B64A10A594494CF6211D3C",
 "life_cycle_state": "ACTIVE",
 "account_owner": {
 "company_profile": null,
 "company_name": null,
 "name": "Test 18062018_01",
 "last_name": "18062018_01",
 "id": "922DBE8C2A1046AFADC133E52DFC9E97",
 "life_cycle_state": "FINANCIAL",
 "middle_name": null,
 "title": null,
 "type": "PERSON",
 "first_name": "Test",
 "demographics": {
 "id_number": "18062018_01",
 "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,
 "industry": null,
 "name_day": {
 "month": null,
 "day": null
 },
 "passport_number_expiration_date": null,
 "id_number_expiration_date": null,
 "passport_number": null,
 "social_security_number": null,
 "id_issued_by_country": null,
 "passport_issued_by_country": null
 }
 }
 },
 "id": "F23960758EE549FEBAEEAACE895C8BBC",
 "life_cycle_state": "EFFECTIVE",
 "type": {
 "alternative_code": "normalsub",
 "name": "Normal",
 "description": null,
 "id": "D1BAE6454A2248189EBCD7ADD3B4B65F",
 "classification": "FLEXIBLE"
 }
 },
 "expiration_date": null,
 "udf_date_2": null,
 "udf_date_1": null,
 "udf_date_4": null,
 "products_set": [
 {
 "product": {
 "code": "Bronze",
 "product_type": {
 "meter_reading_type": null,
 "service_type": "TERMED",
 "used_for_provisioning": true,
 "alternative_code": "Main Packages",
 "udr_type": null,
 "composition_method": "FLAT",
 "name": "Main Packages",
 "description": null,
 "id": "E186E293AAAB49EE86A729540A4287FE",
 "classification": "SERVICES",
 "physical_good_type": null
 },
 "alternative_code": "B",
 "description": "Bronze",
 "id": "F50CC52934BD4F119B6E18E215A4FC55",
 "priority_level": null
 },
 "id": "711F596A557247F5AA36CC6058CA7264"
 }
 ],
 "udf_date_3": null,
 "number": "14",
 "udf_float_3": null,
 "udf_float_4": null,
 "effective_date": null,
 "id": "C6F0301851834CBC82AA19B8437A12E4",
 "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": "PAT",
 "name": "Pricing Audit Trail",
 "id": "5DCEED7D776741EFAEDE281FB797AE06",
 "life_cycle_state": "EFFECTIVE",
 "classification": "SUBSCRIPTIONS",
 "type": "AD_HOC"
 },
 "life_cycle_state": "APPROVED",
 "cancelled_on": null,
 "provided_on": "2018-06-18T12:56:19",
 "approved_by": {
 "person_name": null,
 "id": "1",
 "email": null,
 "username": "MPAdministrator"
 },
 "applied_on": null,
 "provided_by": {
 "person_name": null,
 "id": "1",
 "email": null,
 "username": "MPAdministrator"
 },
 "renew": null,
 "udf_string_6": null,
 "job": null,
 "udf_string_7": null,
 "discount_free_usage": null,
 "udf_string_8": null
 },
 "status": {
 "code": "OK",
 "description": "",
 "message": ""
 }
}