| Tip |
|---|
Starting from CRM.COM R10.0.0 the specified Web API method will be deprecated, and although they will still be available in CRM.COM R10.0.0 they will not be maintained furthermore. |
| Excerpt |
|---|
This method creates a job. Single job can be created by each call. Only customer jobs can be created through this method. |
...
Name | Type | Description | ||||||||||
token | String | The token retrieved from the login method | ||||||||||
type_identifier | Job type identifier | The identifier of the type of the new job. The allowed job type identifier fields are the following:
| ||||||||||
status_identifier | 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:
| ||||||||||
category_identifier | Job category identifier | The identifier of the category of the new job. The allowed job category identifier fields are the following:
| ||||||||||
| accounts_receivable_identifier (mandatory) | Accounts receivable identifier | The identifier of the new job accounts receivable. The allowed accounts receivable identifier fields are the following:
| ||||||||||
subscription_identifier (mandatory on conditions) | Subscriptions Identifier | The identifier of the subscription that will be maintained through the new job. This information is applicable and mandatory only if the specified job type has fulfillment scope equal to ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION, SWAP_SUBSCRIPTION_INSTALLED_ITEMS, SWAP_SUBSCRIPTION_SERVICES. The allowed subscription identifier fields are the following:
| ||||||||||
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 | String | The description of the new job | ||||||||||
notes | String | The notes of the new job | ||||||||||
start_date | Date | The date that the job is created | ||||||||||
location_identifier | Job location identifier | The identifier of the location of the new job. The allowed job location identifier fields are the following:
| ||||||||||
owned_by_group_identifier | The identifier of the owned by group information | The owned by group information of the job. The allowed group identifier fields are the following:
| ||||||||||
privacy_level_identifier | The identifier of the privacy level | The privacy level of the job. The allowed privacy level identifier fields are the following:
| ||||||||||
| 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:
| ||||||||||
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 | ||||||||||
expected_completion_date | Date | The date that the job is expected to be completed. It is automatically calculated if estimate completion time is specified. | ||||||||||
estimated_completion_time | 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. | ||||||||||
| billing_terms (mandatory on conditions) | Job Billing terms object | The billing terms of the job to be created. This information is applicable and mandatory if the job type fulfillment method is set to Generic Purpose
| ||||||||||
requested_subscription_billing_terms (optional) | Subscription Billing terms object | The billing terms of the subscription that will be provided as part of the job. This information is applicable and mandatory if the job type fulfillment method is set to New Subscription
| ||||||||||
| assigned_to (mandatory on conditions) | Assigned to object | The assignment information for 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
| ||||||||||
| activities_set (optional) | Set of activity objects | A set of activities which are planned for the specific job
| ||||||||||
requested_subscription_services_set (mandatory on conditions) | Set of Requested Subscription Service Objects | A list of services that were requested by the customer and should be provided as part of the subscription that will be delivered. This information is applicable and mandatory only if the job type fulfillment method is set to New Subscription, Add Subscription Services, Cancel Subscription Services or Swap Subscription Services. 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
| ||||||||||
(mandatory on conditions) | 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_subscription_physical_goods_set (mandatory on conditions) | Set of Requested Subscription Physical Good Objects | A list of physical goods (products only) that were requested by the customer and should be provided as part of the subscription that will be delivered. This information is applicable and mandatory only if the job type fulfillment method is set to New Subscription, Add Subscription Services and Swap Subscription Installed Items. The subscription physical goods are filtered based on the specified subscription type. All the subscription related rules and restrictions are applicable on the requested subscription physical goods as well
| ||||||||||
(mandatory on conditions) | 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 (mandatory on conditions) | 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.
| ||||||||||
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
|
Anchor job_create referred objects parameters job_create referred objects parameters
Referred Parameter Objects Data
| job_create referred objects parameters | |
| job_create referred objects parameters |
...