Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Available from CRM.COM R10
Tip
Tip

Available from CRM.COM R10.0.0

Excerpt

This method updates jobs of fulfillment scope Generic Purpose. Single job can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.

...

privacy_level
  • PICK_UP
  • OTHER

Name

Type

Description

token

String

The token retrieved from the login method

job_identifier
(mandatory)
Job identifier

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

Include Page
V4:job_identifier
V4:job_identifier

status_identifier
(optional)

Job status identifier

The identifier of the status of the new job. 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

description
(optional)
StringThe description of the new job

notes
(optional)

StringThe notes of the new job

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

start_date
(optional)

DateThe date that the activity is created

location_identifier
(optional)

Job location identifierlocation 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 location privacy level

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

Include Page
V4:addressprivacy_level_identifier
V4:addressprivacy_level_identifier
owned_by_group

_identifieramount_to_be_paid_through_wallet

(optional)

The identifier of the owned by group information

The owned by group information of the job. The allowed group 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:group_identifierV4:group_identifier
Tip

Available from CRM.COM R14.0.0

pick_up_unit_identifier

(optional and applicable on conditions)

Unit Identifier 

The identifier of the

privacy level

The privacy level of the job. The allowed privacy level unit that the customer requested to pick up the job physical goods from. This is applicable only if the items_receipt_method is set to PICK_UP. The allowed unit identifier fields are the following:

Include Page
V4:privacy_levelunit_identifier
V4:privacyunit_level_identifieridentifier

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

Date

The date that the job is expected to be completed. It is automatically calculated if estimate completion time 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

estimated_completion_time
(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_time 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
(optional)Billing terms object

The billing terms of the retrieved job.This information is applicable if the job is still draft or pending and if the job is billable

assigned_to
(optional)Assigned to objectThe assignment information for the retrieved job. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules.

requested_physical_goods_set

(optional)

Set of Requested Physical Good Objects

The requested physical goods. This information is applicable only if the job is draft or pending

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

requested_expenses_set

(optional)

Set of Requested Expense Objects

The requested expenses. This information is applicable only if the job is draft or pending

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

requested_activity_services_set

(optional)

Set of Requested Activity Service Objects

The requested activity services. This information is applicable only if the job is draft or pending

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

physical_goods_set
(optional)Set of physical good to be provided objects

The physical goods that will be provided as part of the retrieved job. This information is applicable only if the job is in progress

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

expenses_set
(optional)Set of expense objects

A list of one time services which are applied on the retrieved job as expenses. This information is applicable only if the job is in progress

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

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

...