additive_discount_job_parameters

 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)

DateThe date that the job will start

expected_completion_date
(mandatory)

DateThe 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 objectThe billing terms of the job
physical_goods_to_be_provided_set
(optional)
Set of physical good to be provided objectsThe physical goods that will be provided as part of the job
expenses_set
(optional)
Set of expense objectsA 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)

DateThe 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)

NumberThe 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