job_parameter object data

Name

Type

Description

type_identifier

(mandatory)

Job type identifier

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

Name

Type

Description

(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

owned_by_group_identifier

(optional)

Group identifier

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

Name

Type

Description

(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 job. The allowed business unit identifier fields are the following:

Name

Type

Description

(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 on conditions)

Billing terms object

The billing terms of the job. Mandatory and applicable on all fulfillment scopes except NEW_SUBSCRIPTION

requested_subscription_billing_terms

(mandatory on conditions)

Subscription Billing terms object

The billing terms of the job's subscription. Mandatory and applicable if the job is of fulfillment scope NEW_SUBSCRIPTION

requested_subscription_services_set

(optional)

Set of Requested Subscription Service Objects

The services that will be added on the subscription through the Job. Applicable only if the job's fulfillment scope is set to ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, NEW_SUBSCRIPTION, SWAP_SUBSCRIPTION_SERVICES

requested_subscription_physical_goods_set

(optional)

Set of Requested Subscription Physical Good Objects

The physical goods that will be added on the subscription through the Job. Applicable only if the job's fulfillment scope is set to ADD_SUBSCRIPTION_SERVICES, NEW_SUBSCRIPTION, SWAP_SUBSCRIPTION_INSTALLED_ITEMS

requested_physical_goods_set

(optional)

Set of Requested Physical Good Objects

A list of requested physical goods that are requested by the customer and should be delivered as part of fulfilling the ordered job. The requested physical goods are filtered based on the selected job type. Mandatory physical goods are added automatically

requested_expenses_set

(optional)

Set of Requested Expense Objects

A list of requested expenses that are requested by the customer and should be delivered as part of fulfilling the ordered job. The requested expenses are filtered based on the selected job type. Mandatory expenses are added automatically

requested_activity_services_set

(optional)

Set of Requested Activity Service Objects

A list of one time services that are requested by the customer and should be delivered by a scheduling and performing a specific activity. The requested activity services are defined by specifying the type of the activity and the activity services that should be performed. The activity types are filtered based on the selected job type. The activity services are filtered based on the selected activity type. Mandatory activity types and services are added automatically.

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

(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

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

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

subscription_billing_terms object parameter data

Name

Type

Description

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

(semi-optional)

String

The ID of the price plan

code

(semi-optional)

String

The code of the price plan

billing_cycle_day

(optional)

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. If not specified then it defaults to the billing cycle day specified on 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.

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"

performed_by_user_identifier

(optional)

User identifier

The user that actually performed the action. This information is applicable only if the job type fulfillment scope is set to New Subscription. The allowed user identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user

performed_on

(optional)

Date

The date that the action was actually performed. This information is applicable only if the job type fulfillment scope is set to New Subscription.

binding_information

(optional)

Binding information object

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

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)

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

job_requested_subscription_service object parameter data

Name

Type

Description

service_identifier

(mandatory)

Service identifier

The identifier of the subscription service. Only products classified as services are retrieved. The allowed product identifier fields are the following:

Name

Type

Description

(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

swap_service_identifier

(mandatory)

Service identifier

The service of the subscription service which will swap the existing subscription service. This is applicable and mandatory only if the job type's fulfillment scope is set to Swap Subscription Services. Only products classified as services are retrieved.

Name

Type

Description

(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

Available from CRM.COM R9.0.0

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.

Available from CRM.COM R14.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

provisioning_distribution_set

(optional)

Set of Subscription Service Distribution objects

The distribution of the requested subscription services

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

(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

(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

job_requested_subscription_physical_good object parameter data

Name

Type

Description

product_identifier
(mandatory based on conditions)

Product Identifier

The identifier of the physical good related with the requested subscription physical good. This is applicable and mandatory if the job type's fulfillment scope is not set to Swap Subscription Installed Items. The allowed physical good product identifier fields are the following:

Name

Type

Description

(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

Job Type fulfillment scope Swap Subscription Installed Items is available from CRM.COM R9.0.0

installed_item_identifier

(mandatory based on conditions)

Installed Item Identifier

The identifier of the installed item which is requested to be swapped with another installed item. This is applicable and mandatory only if the job type fulfillment scope is set to Swap Subscription Installed Items. The allowed installed item identifier fields are the following:

Name

Type

Description

(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

Available from CRM.COM R9.0.0

quantity
(optional)

Number

The quantity of the requested subscription physical good. If not specified then it is set to 1

warranty_coverage_reason_identifier

(mandatory based on conditions)

Warranty Coverage Reason Identifier

The Warranty Coverage Reason which indicates if the requested to be swapped subscription installed item's warranty will eventually cover the replacement or not. This is applicable and mandatory in Swap Subscription Installed Items jobs and only if the requested to be swapped installed item is still under warranty.

Name

Type

Description

(semi-optional)

String

The ID of the warranty coverage reason

name

(semi-optional)

String

The name of the warranty coverage reason

alternative_code

(semi-optional)

String

The alternative code of the warranty coverage reason

Available from CRM.COM R9.0.0

notes

(optional)

String

The notes of the job requested subscription physical goods

Available form CRM.COM R12.3.0

provisioning_distribution_set

(optional)

Set of Subscription Physical Good Provisioning Distribution objects

The distribution of the requested subscription physical good

Referred Parameter Objects Data

subscription_physical_good_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

(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

job_requested_physical_good object parameter data

Name

Type

Description

product_identifier
(mandatory)

Product Identifier

The identifier of the physical good related with the requested physical good. The allowed physical good product identifier fields are the following:

Name

Type

Description

(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
(optional)

Number

The quantity of the requested physical good. If not specified then it is set to 1

notes

(optional)

String

The notes of the retrieved job requested physical goods

Available form CRM.COM R12.3.0

components_set

(applicable on conditions)

Set of Product Components objects

The physical good components that should be composing the specified physical good. This information is applicable only if the specified physical good is classified as a flexible product bundle

Available form CRM.COM R12.3.0

Referred Parameter Objects Data

product component object parameter data

Name

Type

Description

product_identifier

(mandatory)

Product identifier

The identifier of the product component. Only products that are allowed to be added on the related flexible product bundle are retrieved. The allowed product identifier fields are the following:

Name

Type

Description

(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

job_requested_expense object parameter data

Name

Type

Description

product_identifier

(mandatory)

Identifier

The identifier of the product related with the job requested expense. The allowed product identifier fields are the following:

Name

Type

Description

(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

job_requested_activity_service object parameter data

Name

Type

Description

activity_type_identifier

(mandatory)

Activity Type Identifier

The identifier of the activity type that will be created in order to deliver the requested activity service. The activity service is filtered based on the services allowed by the specified activity type. The allowed activity type identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the activity type

name

(semi-optional)

String

The code of the activity type

alternative_code

(semi-optional)

String

The alternative code of the activity type

product_identifier
(mandatory)

Product Identifier

The identifier of the product related with the requested activity service. The allowed product identifier fields are the following:

Name

Type

Description

(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

Browser not supported