POST additive_discounts/configurations/definitions/list

Available from CRM.COM R15.0.0

This method returns a list of discount definitions that are available to be applied on subscriptions or jobs having either specific characteristics (i.e. subscription type) or discounts for specific subscriptions or jobs. It is also possible to select whether the retrieved discounts definitions are ad hoc or autoapply. Multiple discount definitions 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

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

subscription

(semi-optional)

Subscriptions Object

Characteristics related to subscriptions that could possibly be discounted.

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:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

job

(semi-optional)

Job Object

Characteristics related to jobs that could possibly be discounted.

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the job

number

(semi-optional)

String

The number of the job

product

(optional)

Products Object

The product the discount is for.
Products used as conditions to decide whether a discount can be given are defined through either the subscription or job object.

date

(optional)

Date

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

from_date

(optional)

Date

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

Applicable only for termed services

to_date

(optional)

Date

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

Applicable only for termed services

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 SUBSCRIPTION, JOB, GENERAL

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

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

Referred Parameters Objects Data

accounts_receivable_parameter object data

Name

Type

Description

classification_identifier

(mandatory)

Accounts receivable classification identifier

The accounts receivable classification identifier. The allowed classification identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the classification

name

(semi-optional)

String

The name of the classification

alternative_code

(semi-optional)

String

The alternative code of the classification

billing_address

(optional)

Billing address Object

The accounts receivable billing address

presentment_preferences_set

(optional)

Set of Presentment Preferences Object

The presentment preferences of the accounts receivable.

payment_preferences_set

(optional)

Set of Payment Preferences Object

The payment preferences of the retrieved accounts receivable.

Referred Parameter Objects Data

billing_address object parameter data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing address will be used. In the case of an existing address then it also defines if the existing address should be updated or not. The supported values are the following:

NEW, EXISTING, EXISTINGUPDATED

type

(mandatory on conditions)

String

The contact information address that should be set as the billing address address. This is applicable and mandatory only if the action is set to EXISTING or EXISTINGUPDATED. The supported options are the following:

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

address

(mandatory on conditions)

Address object

The address to be created (if action is set to NEW) or updated (if action is set to EXISTINGUPDATED). This is applicable and mandatory only if the action is set to NEW or EXISTINGUPDATED.

Referred Objects Response Data

address parameter object data

From R14.2.0, the following object is applicable for CRM.COM Address Format

Name

Type

Description

type

(mandatory)

String

The type of the address which can be added

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

is_primary

(mandatory on conditions)

Boolean

Weather the address is the primary one

Applicable from CRM.COM R16.1.0 onwards

postal_code

(optional)

String

The postal code of the address

street_name

(mandatory on conditions)

String

The street name of the address

street_number

(optional)

String

The street number of the address

floor

(optional)

Integer

The floor of the address

apartment_number

(optional)

String

The apartment number of the address

area

(optional)

String

The area of the address

town_city

(optional)

String

The town/city of the address

district

(optional)

String

The district of the address

municipality

(optional)

String

The municipality of the address

country_identifier

(optional)

Country identifier

The country of the address. The allowed country identifier fields are the following:

Name	Type	Description
id (semi-optional)	String	The ID of the country
name (semi-optional)	String	The name of the country
alternative_code (semi-optional)	String	The alternative code of the retrieved country
two_character_code (semi-optional)	String	The two character code of the retrieved country
three_character_code (semi-optional)	String	The three character code of the retrieved country

po_box

(optional)

String

The PO box of the address

po_box_postal_code

(optional)

String

The PO box postal code of the address

care_of

(optional)

String

The care of person of the address

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_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(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

From R14.2.0, the following object is applicable for International Address Format

Name

Type

Description

type

(mandatory)

String

The type of the address which can be added

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

postal_code

(optional)

String

The postal code of the address

town_city

(optional)

String

The town/city of the address

country_identifier

(optional)

Country identifier

The country of the address. The allowed country identifier fields are the following:

Name	Type	Description
id (semi-optional)	String	The ID of the country
name (semi-optional)	String	The name of the country
alternative_code (semi-optional)	String	The alternative code of the retrieved country
two_character_code (semi-optional)	String	The two character code of the retrieved country
three_character_code (semi-optional)	String	The three character code of the retrieved country

address_line_1

(mandatory)

String

The address line 1

address_line_2

(optional)

String

The address line 2

state_province_county

(optional)

String

The state or province or county of the address.

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_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(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

accounts_receivable_presentment_preference object parameter data

Name

Type

Description

presentment_preference_identifier

(mandatory)

Identifier

The identifier of the presentment preference to be added on account presentment preference object. The allowed presentment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of presentment preference

name

(semi-optional)

String

The name of presentment preference

alternative_code

(semi-optional)

String

The alternative code of presentment preference

accounts_receivable_payment_preference object parameter data

Name

Type

Description

payment_preference_identifier

(mandatory)

Identifier

The identifier of the payment preference to be added on account payment preference object. The allowed payment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of payment preference

name

(semi-optional)

String

The name of payment preference

alternative_code

(semi-optional)

String

The alternative code of payment preference

subscription_parameter object data

Name

Type

Description

type_identifier

(mandatory)

Subscription type identifier

The type of the subscription. The allowed subscription type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the subscription type

name

(semi-optional)

String

The name of the subscription type

alternative_code

(semi-optional)

String

The alternative code of the subscription type

owned_by_group_identifier

(optional)

Group identifier

The group that will be owning the subscription. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

Deprecated from CRM.COM R18.0.0

owned_by_business_unit_identifier

(optional)

Business Unit identifier

The business unit that will be owning the subscription. The allowed business unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the business unit

name

(semi-optional)

String

The code of the business unit

code

(semi-optional)

String

The code of the business unit

Available from CRM.COM R18.0.0

billing_terms

(mandatory)

Billing Terms Object

The billing terms of the subscription

services_set

(mandatory)

Set of Subscription Services

The services that will be added on the subscription

installed_items_set

(optional)

Set of Subscription Installed Items

The installed items that will be added on the subscription

Referred Parameter Objects Data

billing_terms object parameter data

Name

Type

Description

billing_term_scheme_identifier

(mandatory on conditions)

Billing term scheme identifier

The billing term scheme that will be used on the billing terms. The allowed billing term scheme identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the billing term scheme

code

(semi-optional)

String

The code of the billing term scheme

The billing_term_scheme_identifier is considered as mandatory up until CRM.COM R13.0.0.

From CRM.COM R14.0.0 the identifier becomes mandatory on conditions, which means that it is mandatory only as long as the subscription's type is not of classification Package. Subscription Types of classification Package provide a default Billing Term scheme and the billing_term_scheme_identifier is not applicable in such cases.

price_plan_identifier

(mandatory on conditions)

Price plan identifier

The price plan that will be used on the billing terms. The allowed price plan identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the price plan

code

(semi-optional)

String

The code of the price plan

The price_plan_identifier is considered as mandatory up until CRM.COM R11.2.0. From CRM.COM R11.2.0 the identifier becomes mandatory on conditions, which means that it is mandatory only as long as no default price plan is specified in the Billing Term Scheme

From CRM.COM R14.0.0 if the subscription's type is of classification Package which provides a default Price Plan, then that price plan is automatically applied and the price_plan_identifier is not applicable.

Deprecated from CRM.COM R15.0.0

is_auto_renewed

(optional)

Boolean

Defines whether the subscription's billing terms will be auto-renewed or not. If not specified, then the subscription's billing terms are marked as auto-renewed.

Available from CRM.COM R15.0.0

billing_cycle_day

(mandatory on conditions)

Number

The billing cycle day of the billing terms that will be created. Billing cycle day is used to specify up to which day of the month a subscription should be billed. Applicable and mandatory only when Billing Term Scheme specifies an Anniversary Billing. Mandatory if no automations on how the billing cycle day should be set are defined in the Billing Term Scheme. Either a specific billing cycle day or the fact that the billing cycle day is the last day of each month are mandatory in this case.

From CRM.COM R12.0.0, billing_cycle_day becomes mandatory on conditions. In previous releases this is optional.

billing_cycle_last_day_of_month

(mandatory on conditions)

Boolean

Defines whether Anniversary Subscriptions will be billed up until the last day of each month. Applicable only for Anniversary subscriptions and only if no automations on how the billing cycle day is set are defined on the Billing Term Scheme. Either a specific billing cycle day or the fact that the billing cycle day is the last day of each month are mandatory in this case.

Available from CRM.COM R12.0.0

agreement_date

(mandatory)

Date

The agreement date of the billing terms that will be created. Billing terms agreement date is used to log the date that the billing terms were agreed and signed by the customer.

billing_frequency

(mandatory on conditions)

String

The billing frequency of the billing terms that will be created. Billing Frequencies are used to denote how often a subscription should be billed.The supported options are the following:

DAILY, WEEKLY, MONTHLY, QUARTERLY, BIANNUAL, ANNUAL, TWOYEARS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

Billing frequency is applicable and mandatory only if the specified billing term scheme is of type "Normal"

From CRM.COM R14.0.0 the billing frequency is not mandatory if the subscription's type is of classification Package that provides a default Billing Frequency (it can be amended though).

binding_information

(optional)

Binding information object

The binding information of the billing term that will be created. Binding information is used to determine if a customer is contractually committed to receive services from the service provider for a fixed period of time.

concurrent_usage_based_pricing

(mandatory on conditions)

Concurrent usage based pricing object

Concurrent usage based pricing is used to apply pricing and billing rules based on the subscription's concurrent usage which is agreed between the customer and the company providing those service. Concurrent usage based pricing is applicable and mandatory only if it is supported by the billing term schemes

period_billed_in_advance

(mandatory on conditions)

float

The period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated billing term scheme. If nothing is specified then the default value will be provided

Icon

Available from CRM.COM R15.0.0

period_billed_in_advance_uot

(mandatory on conditions)

String

The unit of time for the period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated billing term scheme. The supported values are DAYS, WEEKS or MONTHS. If nothing is specified then the default value will be provided

Icon

Available from CRM.COM R15.0.0

Referred Objects Response Data

binding_information object parameter data

Name

Type

Description

binding_period

(mandatory)

String

The binding period which can be one of the following:

WEEK, MONTH, QUARTER, BIANNUAL, ANNUAL, TWOYEARS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

From CRM.COM R14.0.0 the binding period becomes mandatory on conditions, which means that it is mandatory only as long as the subscription's type is not of classification Package which provides a default Binding period (it can be amended though).

From CRM.COM R18.0.0 the binding period is mandatory (Package subscription types are deprecated)

start_date

(mandatory on conditions)

Date

The date that the binding period starts.

From CRM.COM R14.0.0 onwards start_date is mandatory only if no configuration exists in Subscription Billing Term Definitions related to Binding Start Date Automation.

From CRM.COM R18.0.0 the binding period is mandatory (Package subscription types are deprecated)

concurrent_usage_based_pricing object parameter data

Name	Type	Description
concurrent_usage (mandatory)	Number	Defines the concurrent usage of services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0
rate_percentage (mandatory)	Number	Defines the rate percentage that should be applied on all services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0
number_of_installed_items (mandatory on conditions)	Number	The agreed number of installed items that will be concurrently consuming the related subscription's services. Applicable and mandatory if concurrent usage billing method is set to "based on number of installed items". Available from CRM.COM R15.0.0
concurrent_usage_billing_method (mandatory)	String	Defines how the subscription will be billed for the agreed concurrent usage. Available options are: BASED_ON_NUMBER_OF_INSTALLED_ITEMS BASED_ON_MAXIMUM_CAPACITY BASED_ON_ACTUAL_CAPACITY If not specified, then the billing method is considered as "based on number of installed items". Available from CRM.COM R15.0.0

new subscription service object parameter data

Name

Type

Description

service_identifier

(mandatory)

Service identifier

The identifier of the service. Only products classified as services are retrieved. The allowed service 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

From CRM.COM R14.0.0 onwards, if the Subscription's Type is of classification Package then any Services added on the Subscription are considered as Additional Services.

period_billed_in_advance

(mandatory on conditions)

Integer

The period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated services. If nothing is specified then the default value will be provided

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R15.0.0

period_billed_in_advance_uot

(mandatory on conditions)

String

The unit of time for the period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated services. The supported values are DAYS, WEEKS or MONTHS.

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R15.0.0

udf_string_1

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_2

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_3

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_4

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_5

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_6

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_7

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_8

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_float_1

(optional)

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_2

(optional)

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_3

(optional)

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_4

(optional)

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_date_1

(optional)

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_2

(optional)

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_3

(optional)

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_4

(optional)

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

services_distribution_set

(optional)

Set of subscription service distribution objects

The distribution of the services that will be added on the subscription

Deprecated from CRM.COM R15.0.0

components_set

(mandatory on conditions)

Set of subscription service components objects

The service components that should be composing the specified service. This information is available and mandatory if the specified service is a flexible product bundle

Referred Parameter Objects Data

subscription_service_distribution object parameter data

Name

Type

Description

provisioning_distributor_identifier

(mandatory)

Provisioning distributor identifier

The identifier of the provisioning distributor. The allowed provisioning distributor identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the provisioning distributor

name

(semi-optional)

String

The name of the provisioning distributor

alternative_code

(semi-optional)

String

The alternative code of the provisioning distributor

subscription_service_component object parameter data

Name

Type

Description

service_identifier

(mandatory)

Service identifier

The identifier of the service. Only products classified as services, which are also included in the product components of the related flexible product bundle are retrieved. The allowed service 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

subscription_installed_item object parameter data

Name

Type

Description

installed_item_identifier

(mandatory)

Installed item identifier

The identifier of the installed item. The allowed installed item identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of a installed item

udf_string_1

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_2

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_3

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_4

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_5

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_6

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_7

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_8

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_float_1

(optional)

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_2

(optional)

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_3

(optional)

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_4

(optional)

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_date_1

(optional)

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_2

(optional)

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_3

(optional)

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_4

(optional)

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

installed_items_distribution_set

(optional)

Set of subscription installed item distribution objects

The distribution of the installed items that will be added on the subscription

Deprecated from CRM.COM R15.0.0

Referred Parameter Objects Data

subscription_installed_item_distribution object parameter data

Name

Type

Description

provisioning_distributor_identifier

(mandatory)

Provisioning distributor identifier

The identifier of the provisioning distributor. The allowed provisioning distributor identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the provisioning distributor

name

(semi-optional)

String

The name of the provisioning distributor

alternative_code

(semi-optional)

String

The alternative code of the provisioning distributor

additive_discount_job_parameter object data

Name

Type

Description

type_identifier
(mandatory)

Job type identifier

The identifier of the type of the job. The allowed job type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the job type

name

(semi-optional)

String

The name of the job type

alternative_code

(semi-optional)

String

The alternative code of the job type

start_date
(mandatory)

Date

The date that the job will start

expected_completion_date
(mandatory)

Date

The date that the job is expected to be completed

owned_by_group_identifier
(optional)

The identifier of the owned by group information

The owned by group information of the job. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

Deprecated from CRM.COM R18.0.0

owned_by_business_unit_identifier

(optional)

Business Unit identifier

The business unit information of the job. The allowed business unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the business unit

name

(semi-optional)

String

The code of the business unit

code

(semi-optional)

String

The code of the business unit

Available from CRM.COM R18.0.0

billing_terms
(mandatory)

Billing terms object

The billing terms of the job

physical_goods_to_be_provided_set
(optional)

Set of physical good to be provided objects

The physical goods that will be provided as part of the job

expenses_set
(optional)

Set of expense objects

A list of one time services which are applied on the job as expenses

Referred Parameter Objects Data

job_billing_terms object parameter data

Name

Type

Description

billing_term_scheme_identifier

(mandatory)

Billing term scheme identifier

The billing term scheme that will be used on the billing terms. The allowed billing term scheme identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the billing term scheme

code

(semi-optional)

String

The code of the billing term scheme

price_plan_identifier

(mandatory on conditions)

Price plan identifier

The price plan that will be used on the billing terms. The allowed price plan identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the price plan

code

(semi-optional)

String

The code of the price plan

The price_plan_identifier is considered as mandatory up until CRM.COM R11.2.0. From CRM.COM R11.2.0 the identifier becomes mandatory on conditions, which means that it is mandatory only as long as no default price plan is specified in the Billing Term Scheme

agreement_date

(mandatory)

Date

The agreement date of the billing terms that will be created. Billing terms agreement date is used to log the date that the billing terms were agreed and signed by the customer.

concurrent_usage_based_pricing

(mandatory on conditions)

Concurrent usage based pricing object

Concurrent usage based pricing is used to apply price plan rates based on the number of concurrent usage of the services or the installed items that will be billed, and a rate percentage which is agreed between the customer and the company providing those service. Concurrent usage based pricing is applicable and mandatory only if it is supported by the billing term schemes

This object is deprecated in CRM.COM R10.0.0 onwards

Referred Objects Response Data

concurrent_usage_based_pricing object parameter data

Name	Type	Description
concurrent_usage (mandatory)	Number	Defines the concurrent usage of services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0
rate_percentage (mandatory)	Number	Defines the rate percentage that should be applied on all services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0
number_of_installed_items (mandatory on conditions)	Number	The agreed number of installed items that will be concurrently consuming the related subscription's services. Applicable and mandatory if concurrent usage billing method is set to "based on number of installed items". Available from CRM.COM R15.0.0
concurrent_usage_billing_method (mandatory)	String	Defines how the subscription will be billed for the agreed concurrent usage. Available options are: BASED_ON_NUMBER_OF_INSTALLED_ITEMS BASED_ON_MAXIMUM_CAPACITY BASED_ON_ACTUAL_CAPACITY If not specified, then the billing method is considered as "based on number of installed items". Available from CRM.COM R15.0.0

job_physical_good_to_be_provided object parameter data

Name

Type

Description

installed_item_identifier
(semi-optional)

Installed Item Identifier

The identifier of the installed item related with the Job Physical Good. The allowed installed item identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of a installed item

product_identifier
(semi-optional)

Product Identifier

The identifier of the physical good product related with the Job Physical Good. The allowed physical good 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

quantity
(mandatory if product is specified)

Number

The quantity of the physical good. Need to be specified only in the case when a physical good product is specified.

job_expense object parameter data

Name

Type

Description

product_identifier

(mandatory)

Identifier

The identifier of the product related with the job expense. 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. Only one semi-optional parameter can be specified.

Response Data

Unable to render {include} The included page could not be found.

Examples

Example 1

HTTP Method: POST

Request:

Body:

Body

Response:

Response

 {
 "data": [
 {
 "product": null,
 "from_date": "2015-05-05T00:00:00",
 "to_date": null,
 "discount_amount": null,
 "additive_discount_definition": {
 "alternative_code": "PS1A_1",
 "name": "Pricing SB 19 A",
 "id": "9080F73F6C4C41ECB6196F767AA0C186",
 "life_cycle_state": "EFFECTIVE",
 "classification": "GENERAL",
 "type": "AD_HOC"
 },
 "free_period": null,
 "discount_percentage": 10,
 "free_period_UOT": null,
 "discount_amount_UOT": null
 },
 {