| Tip |
|---|
Available from CRM.COM R10.0.0 |
| Excerpt |
| Tip |
Available from CRM.COM R10.0.0 |
| Excerpt |
|---|
This method creates a job of fulfillment scope Generic Purpose. A 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 (semi-optional) | Accounts receivable identifier | The identifier of the new job accounts receivable. The allowed accounts receivable identifier fields are the following:
| |||||||||||||||||
| accounts_receivable (semi-optional) | Accounts Receivable Object | The new job's accounts receivable
| |||||||||||||||||
contact_email (optional) | String | The email of the customer related to the job, which will be used in order to communicate the job | |||||||||||||||||
contact_phone (optional) | String | The phone of the customer related to 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 | |||||||||||||||||
contact_phone (optional) | String | The phone of the customer related to the job, which will be used in order to communicate the job | |||||||||||||||||
descriptionlocation identifier fields are the following:
| |||||||||||||||||||
owned_by_group_identifier | String | The description identifier 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 identifierowned 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 location privacy level | The privacy level of the new job. The allowed job location privacy level identifier fields are the following:
| |||||||||||||||||
| service_byrequest_group_identifier (optional) | The identifier of the owned by group informationThe owned by group information of service request | The service request related to the job. The allowed group identifier fields are the following: | V4:group_identifier | V4:group_identifier | privacy_level_identifier | The identifier of the privacy level | |||||||||||||
| Include Page | V4:privacy_level_identifier | V4:privacy_level_identifier | service_request_identifier (optional) | The identifier of the service request | The service request related to the job. The allowed service request service request identifier fields are the following:
| ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
amount_to_be_paid_through_wallet (optional) | Float | The amount that the customer is intending to use from his wallet in order to pay for the specific job
| |||||||||||||||||
items_receipt_method (optional) | String | Determines if the customer prefers the job physical goods to be send to him at the specified delivery address, to pick them up from a specific unit or in any other way. The supported options are the following:
| |||||||||||||||||
pick_up_unit_identifier (mandatory and applicable on conditions) | Unit Identifier | The identifier of the unit that the customer requested to pick up the job physical goods from. This is mandatory and applicable only if the items_receipt_method is set to PICK_UP. The allowed unit 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 estimated 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 only if the job is billable | |||||||||||||||||
| assigned_to (mandatory) | Assigned to object | The assignment information for the job | |||||||||||||||||
(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. | |||||||||||||||||
(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. | |||||||||||||||||
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 |
...