Page Comparison

service_request

• PICK_UP
• OTHER

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 (semi-optional)	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 Tip For releases prior CRM.COM R14.0.0, this attribute is mandatory
accounts_receivable (semi-optional)	Accounts Receivable Object	The new job's accounts receivable Tip Available from CRM.COM R14.0.0
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 (optional)	String	The description of the new job
notes (optional)	String	The notes of the new job
start_date (optional)	Date	The date that the job is created
location_identifier (mandatory on conditions)	Job location identifier	The identifier of the location of the new job. The allowed job location identifier fields are the following: Include Page V4:accounts_receivableaddress_identifier V4:accountsaddress_receivable_identifier
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 (optional)	String	The description of the new job
notes (optional)	String	The notes of the new job
start_date (optional)	Date	The 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 Tip From CRM.COM R14.4.0 onwards the location_identifier is mandatory unless if the items_receipt_method is set to PICK_UP
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:addressprivacy_level_identifier V4:addressprivacy_level_identifier owned
service_by_grouprequest_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 service request identifier fields are the following: Include Page V4:groupservice_request_identifier V4:groupservice_request_identifier privacy_level_identifier
amount_to_be_paid_through_wallet (optional)	The identifier of the privacy level	The privacy level of the job. The allowed privacy level identifier fields	Float	The amount that the customer is intending to use from his wallet in order to pay for the specific job Tip Available from CRM.COM R14.0.0
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:include DELIVERY	V4:privacy_level_identifier	V4:privacy_level_identifier

Tip
Available from CRM.COM R14.0.0

pick_up_unit_identifier

(

optional)

mandatory and applicable on conditions)

Unit Identifier 

The identifier of the

service request

The service request related to the job. The allowed service request 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:

Include Page
V4:serviceunit_request_identifier V4:serviceunit_request_identifier

Tip
Available from CRM.COM R14.0.0

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

Date

The date that the job is expected to be completed. It is automatically calculated if estimated completion time is specified

Tip
From CRM.COM R14.4.0 onwards the expected_completion_date is mandatory if the items_receipt_method is set to PICK_UP

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 R14.1.0, this parameter will be applicable only when the 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_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.

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