Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This method creates a job of fulfillment scope Subscription
Tip

Available from CRM.COM R13.1.0

Excerpt
Tip

Available from CRM.COM R13.1.0

Excerpt

This method creates a job of fulfillment scope Subscription Maintenance. Single job can be created by each call. Job of existing account owners can be created through this method.

...

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier
(mandatory)

Job type identifier

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

Include Page
V4:job_type_identifier
V4:job_type_identifier

status_identifier
(optional)

Job status identifier

The identifier of the status of the new job. If not specified then the default one will be used. The allowed job status identifier fields are the following:

Include Page
V4:job_status_identifier
V4:job_status_identifier

category_identifier
(optional)

Job category identifier

The identifier of the category of the new job. The allowed job category identifier fields are the following:

Include Page
V4:job_category_identifier
V4:job_category_identifier

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

The identifier of the new job accounts receivable. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

subscription_identifier

(mandatory)

Subscription Identifier

The identifier of the subscription that will be maintained as part of the new job's fulfillment.The allowed subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

contact_email

(optional)

String

The email of the customer related with the job, which will be used in order to communicate the job

contact_phone

(optional)

 String

 The phone of the customer related with the job, which will be used in order to communicate the job

description
(optional)

StringThe description of the new job

notes
(optional)

StringThe notes of the new job

start_date
(optional)

DateThe date that the job is created

location_identifier
(mandatory)

Job location identifier

The identifier of the location of the new job. The allowed job location identifier fields are the following:

Include Page
V4:address_identifier
V4:address_identifier

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:

Include Page
V4:group_identifier
V4:group_identifier

privacy_level_identifier
(optional)

The identifier of the privacy level

The privacy level of the job. The allowed privacy level identifier fields are the following:

Include Page
V4:privacy_level_identifier
V4:privacy_level_identifier

service_request_identifier
(optional)
The identifier of the service request

The service request related with the job. The allowed service request identifier fields are the following:

Include Page
V4:service_request_identifier
V4:service_request_identifier

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

scheduled_date

(optional)

Date

The date on which the job is scheduled, which also indicates the date on which the Cancel Subscription Service action will be scheduled to be performed

 

expected_completion_date
(semi-optional)

Date

The date that the job is expected to

be completed. It is automatically calculated if estimate completion time is specified.

be completed. It is automatically calculated if estimate completion time is specified

Tip

From CRM.COM R15.0.0, this parameter will be applicable only whenthe Recalculate Key Dates on Starting Progress option is not enabled through the related Job Type configuration

estimated_completion_time
(semi-optional)

Time Period Object

The time that is estimated to complete the job, measured in minutes, hours, days, weeks, years. It is automatically calculated if expected completion date is specified

Tip

From CRM.COM R15.0.0, this parameter will be applicable only whenthe Recalculate Key Dates on Starting Progress option is not enabled through the related Job Type configuration

billing_terms
(mandatory on conditions)
Job Billing terms object

The billing terms of the job to be created. This information is applicable and mandatory only if the job is billable

assigned_to
(mandatory)
Assigned to objectThe assignment information for the job

requested_billing_term_amendment

(optional)

Requested Subscription Billing Term Amendments ObjectThe Subscription's billing terms amendments that are requested by the customer and should be perofmed on the subscription as part of fulfilling this new job.

requested_physical_goods_set

(optional)

Set of Requested Physical Good Objects

A list of physical goods (products only) 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.

requested_subscription_physical_goods_set

(optional)

Set of Requested Subscription Physical Good ObjectsA list of physical goods (products only) that are requested by the customer to be added on the subscription and should be delivered as part of fulfilling the ordered job. The requested physical goods are filtered based on the selected subscription's type.

requested_subscription_services_to_be_added_set

(optional)

Set of Requested Subscription Services to be added ObjectsA list of services that were requested by the customer and should be provided as part of the subscription that will be updated. The subscription services are filtered based on the specified subscription type and billing term scheme. All the subscription related rules and restrictions are applicable on the requested subscription services as well

requested_subscription_services_to_be_swapped_set

(optional)

Set of Requested Subscription Services to be swapped ObjectsA list of subscription services that were requested by the customer to be swapped through the new job. The subscription services are filtered based on the specified subscription type and billing term scheme. All the subscription related rules and restrictions are applicable on the requested subscription services as well

requested_subscription_expenses_set

(optional)

Set of Requested Subscription Expenses ObjectsA list of subscription expenses that were requested by the customer and should be provided as part of the subscription that will be updated.

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

...