Available from CRM.COM R10.0.0
GET jobs/generic_purpose/show
This method returns information related with a job of fullfilment scope Generic Purpose. Single job is returned by each call
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
| job_identifier (mandatory) | Job identifier | The identifier of the job that should be returned as a result. The allowed jobs identifier fields are the following:
| |||||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved job |
number | String | The number of the retrieved job |
| description | String | The description of the retrieved job |
| notes | String | The notes of the retrieved job |
| contact_email | String | The email of the customer related with the retrieved job, which will be used in order to communicate the job |
| contact_phone | String | The phone of the customer related with the retrieved job, which will be used in order to communicate the job |
life_cycle_state | String | The life cycle state of the retrieved job which can be DRAFT, PENDING, IN PROGRESS, COMPLETED, CANCELLED |
| start_date | Date | The date that the job is created |
| expected_completion_date | Date | The date that the job is expected to be completed |
| actual_completed_date | Date | The date that the job is actually completed |
| expiration_date | Date | The date on which the job expires. Available from CRM.COM R13.0.0 |
| rating_state | String | The rating state of the job that can be PENDING or COMPLETED |
| amount_to_be_paid_through_wallet | Float | The amount that the customer was intending to use from his wallet in order to pay for the specific job Available from CRM.COM R14.4.0 |
| amount_already_paid | Float | The amount that was already paid for that job, calculated dynamically based on the payments that were submitted against that job Available from CRM.COM R14.4.0 |
| items_receipt_method | 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:
Available from CRM.COM R14.4.0 |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| assigned_to | Assign Object | The assignment information of the retrieved job |
| type | Job Type Object | The type information of the retrieved job |
| billing_terms | Jobs Billing Terms Object | The billing terms of the retrieved job |
| status | Job Status object | The status information of the retrieved job |
| category | Job Category object | The category of the retrieved job |
| service_request | Service Request Object | The service request that was related to the retrieved job. |
| estimated_completion_time | Time Period Object | The time that is estimated to complete the job, measured in minutes, hours, days, weeks, years |
| time_to_completion | Time Period Object | The time that is left up to the expected completion date |
| time_overdue | Time Period Object | The time past the expected completion date |
Accounts Receivable object | The accounts receivable related with the specified job | |
| pricing_agreement_price_plan | Price Plan Object | The pricing agreement that was assigned against an Accounts Receivable Applicable for an Accounts Receivable that is owned by a Company (Corporate Account) and a Price Plan was agreed as part of a special pricing agreement Applicable for Accounts Receivables that are members in the related Corporate Account Group as well Available from CRM.COM R14.0.0 |
| location | Address Object | The physical location that the job should be performed and delivered to |
| cancellation_reason | Jobs Cancellation Object | The reason that the job was canceled. This is applicable only if the job is on a canceled life cycle state |
| owned_by_group | Group Object | The group that is owning the job |
| privacy_level | Privacy Level Object | The job privacy level |
| cloned_job | Job Object | The job that was cloned in order to create the new job This is applicable only if the job is a clone of another job Available on CRM.COM 12.4.0 and from CRM.COM 13.1.0 |
Log Information Object | The log information related to the retrieved job | |
| Unit object | The identifier of the unit that the customer requested to pick up the job physical goods from Available from CRM.COM R14.4.0 | |
| requested_physical_goods_set | Set of Requested Physical Goods Objects | The physical goods that were requested by the retrieved job |
| requested_expenses_set | Set of Requested Expenses Objects | The expenses that were requested by the retrieved job |
| requested_activity_services_set | Set of Requested Activity Services Objects | The activity services that were requested by the retrieved job |
| physical_goods_set | Set of Physical Goods Objects | The physical goods that will be provided as part of the job |
| expenses_set | Set of Expense Objects | A list of one time services which are applied on the job as expenses |
| activities_set | Set of Activity Objects | A set of activities which are planned for the specific job |
| bills_set | Set of Bill Objects | A set of bills that were generated by the billing engine in relation to the specific job |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"notes": null,
"requested_physical_goods_set": [
{
"id": "843826CADAA24CE8AA4669604A60AF0C",
"quantity": 1,
"product": {
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": true,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "FA802647636A11B7B74B582A688B968D",
"name": "Cameras",
"description": "Cameras",
"alternative_code": "CA"
},
"id": "13C42638B34C902F16D4EB516F775E0F",
"description": "HD Camera Version 1",
"code": "HD Camera V1",
"alternative_code": "HDCV1"
}
},
{
"id": "6FAFA4E29EAE483482D099DB7D095AB2",
"quantity": 1,
"product": {
"product_type": {
"service_type": null,
"physical_good_type": "NONTRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "0F94B51F175F06A475EB2948B4030074",
"name": "Accessories",
"description": "A type which is used for accessories physical goods",
"alternative_code": "005"
},
"id": "70FFDF2B2A74466DD7D0D5246ED1DD2D",
"description": "Antenna v1",
"code": "Antenna 1",
"alternative_code": "ANT1"
}
}
],
"billing_terms": {
"binding_information": null,
"agreement_date": "2016-06-09T00:00:00",
"concurrent_usage_based_pricing": {
"concurrent_usage": 1,
"rate_percentage": 100
},
"billing_term_scheme": {
"life_cycle_state": "EFFECTIVE",
"billing_method": "PERIOD",
"classification": "JOBS",
"id": "1B708E843AF1497595A4EE39A1F62ED0",
"name": "Jobs Scheme - Concurrent",
"code": "Jobs Scheme - Concurrent",
"billing_type": "NORMAL"
},
"effective_date": "2016-06-09T00:00:00",
"billing_frequency": null,
"id": "173339DAB13B468EA61F099665BC01F2",
"allowed_cancel_date": null,
"expiration_date": null,
"billing_cycle_day": null,
"price_plan": {
"effective_date": "2016-04-08T00:00:00",
"type": "BASE",
"id": "62F4D4E787AD4ACC895FD1D066037353",
"name": "BPP0614",
"description": "Base Price PLan June 14 for Subscription Test Case 6",
"code": "BPP0614",
"expiration_date": null
}
},
"service_request": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "JOB000581",
"udf_float_4": null,
"udf_string_1": null,
"assigned_to": {
"unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"udf_string_2": null,
"privacy_level": {
"number": "30",
"hierarchy_level": 4,
"id": "7A1073B8F31C648A8D6103BD4F83F90D",
"name": "Low"
},
"estimated_completion_time": {
"time_period_value": 2,
"time_period_uot": "DAYS"
},
"udf_string_3": null,
"udf_string_4": null,
"contact_phone": null,
"udf_string_5": null,
"activities_set": [
{
"life_cycle_state": "PENDING",
"number": "ACT000557",
"type": {
"id": "B163FF3F08B44CBEB00F1CCD875C54DE",
"name": "Installation",
"description": null,
"alternative_code": "INS"
},
"id": "52C79D29E4934AABA9FE72BC3B3C27F2",
"contact_information": {
"last_name": "Ioannou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mr",
"first_name": "Michalis",
"type": "PERSON",
"id": "DCEC3B6FBD82EE5C91382D2AA27ACE21",
"name": null,
"company_name": null,
"demographics": {
"gender": "MALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": 2,
"day": 1
},
"date_of_birth": {
"month": 3,
"day": 2,
"year": 1992
},
"id_number": "973453",
"industry": null,
"id_issued_by_country": null
}
}
},
{
"life_cycle_state": "PENDING",
"number": "ACT000558",
"type": {
"id": "938B9B6411AAB03DC25B3F569A443C6D",
"name": "InstallationsX",
"description": "Test",
"alternative_code": "INX"
},
"id": "59CAAEC5D31D4854A3DBE346E1490A29",
"contact_information": {
"last_name": "Ioannou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mr",
"first_name": "Michalis",
"type": "PERSON",
"id": "DCEC3B6FBD82EE5C91382D2AA27ACE21",
"name": null,
"company_name": null,
"demographics": {
"gender": "MALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": 2,
"day": 1
},
"date_of_birth": {
"month": 3,
"day": 2,
"year": 1992
},
"id_number": "973453",
"industry": null,
"id_issued_by_country": null
}
}
},
{
"life_cycle_state": "PENDING",
"number": "ACT000556",
"type": {
"id": "6D0C79835F7B0059D3BD1A51F2A03F41",
"name": "Maintenance visits",
"description": "maintenance visits",
"alternative_code": "MV"
},
"id": "F7063937BA1445BBBC177A9BC5508A5D",
"contact_information": {
"last_name": "Ioannou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mr",
"first_name": "Michalis",
"type": "PERSON",
"id": "DCEC3B6FBD82EE5C91382D2AA27ACE21",
"name": null,
"company_name": null,
"demographics": {
"gender": "MALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": 2,
"day": 1
},
"date_of_birth": {
"month": 3,
"day": 2,
"year": 1992
},
"id_number": "973453",
"industry": null,
"id_issued_by_country": null
}
}
}
],
"udf_string_6": null,
"physical_goods_set": [],
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable": {
"account_owner": {
"last_name": "Ioannou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mr",
"first_name": "Michalis",
"type": "PERSON",
"id": "DCEC3B6FBD82EE5C91382D2AA27ACE21",
"name": "Ioannou Michalis",
"company_name": null,
"demographics": {
"gender": "MALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": 2,
"day": 1
},
"date_of_birth": {
"month": 3,
"day": 2,
"year": 1992
},
"id_number": "973453",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000474",
"id": "675126D59CB94D92BFADC8975E907C18",
"name": "MI001"
},
"id": "942DF67CC5224504845B7C46723AF98F",
"requested_activity_services_set": [
{
"activity_type": {
"id": "938B9B6411AAB03DC25B3F569A443C6D",
"name": "InstallationsX",
"description": "Test",
"alternative_code": "INX"
},
"id": "D8FB73B96FA144C28FA2061D51FAE8D8",
"product": {
"product_type": {
"service_type": "ONETIME",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "7EDF537A938DECAB1352E6EEAD54A5D0",
"name": "One Time Services - Flat",
"description": "A type which is used for one time services",
"alternative_code": "OTS-F"
},
"id": "CDE67382805CD657E02865B07D8F8602",
"description": null,
"code": "Testing",
"alternative_code": "OTS"
}
},
{
"activity_type": {
"id": "938B9B6411AAB03DC25B3F569A443C6D",
"name": "InstallationsX",
"description": "Test",
"alternative_code": "INX"
},
"id": "D3A96789BC7A464A95C70BFE70C91C6A",
"product": {
"product_type": {
"service_type": "EXPENSE",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "67FA013211E348C58F7CD27F8399AADE",
"name": "Expense Type",
"description": null,
"alternative_code": "ET"
},
"id": "8F7A45F44BBEB320718F309F58CCE097",
"description": "Installation",
"code": "Installation Fee",
"alternative_code": "Ins"
}
},
{
"activity_type": {
"id": "6D0C79835F7B0059D3BD1A51F2A03F41",
"name": "Maintenance visits",
"description": "maintenance visits",
"alternative_code": "MV"
},
"id": "13EE89DA513D464CB3DA0928CBE96CC2",
"product": {
"product_type": {
"service_type": "ONETIME",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "7EDF537A938DECAB1352E6EEAD54A5D0",
"name": "One Time Services - Flat",
"description": "A type which is used for one time services",
"alternative_code": "OTS-F"
},
"id": "8B58C14194D51E560F0E49B0292EA56F",
"description": null,
"code": "Maintenance Fee",
"alternative_code": "MC"
}
},
{
"activity_type": {
"id": "B163FF3F08B44CBEB00F1CCD875C54DE",
"name": "Installation",
"description": null,
"alternative_code": "INS"
},
"id": "72D73EB0F8914CC9B0B40214AEBF410A",
"product": {
"product_type": {
"service_type": "ONETIME",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FIXEDBUNDLE",
"id": "391D5E5E5F4F70FCA75C4D01ECAD0B6C",
"name": "One Time Services - Fixed",
"description": "One Time Services - Fixed",
"alternative_code": "OTS-F_1"
},
"id": "690A6B1932D34421A1EE254425F2CB12",
"description": null,
"code": "Installation Service",
"alternative_code": "IS"
}
}
],
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"expected_completion_date": "2016-06-11T13:29:08",
"udf_date_4": null,
"start_date": "2016-06-09T13:29:08",
"time_overdue": {
"time_period_value": 1.4516129032258065,
"time_period_uot": "MONTHS"
},
"time_to_completion": {
"time_period_value": null,
"time_period_uot": null
},
"bills_set": [],
"requested_expenses_set": [],
"rating_state": "PENDING",
"log_information": {
"updated_date": "2016-06-09T14:25:56",
"created_date": "2016-06-09T13:29:08",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"owned_by_group": {
"community_name": "Internal Community",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"name": "Main Group",
"description": "Main Group",
"alternative_code": "MG1"
},
"status": {
"life_cycle_state": "IN_PROGRESS",
"id": "D67BE6044C7F5802480FD591FC09319B",
"name": "In Progress",
"description": "In Progress",
"alternative_code": "IP"
},
"actual_completed_date": null,
"location": {
"udf_string_10": null,
"street_number": null,
"care_of": null,
"udf_string_11": null,
"udf_float_1": null,
"street_name": "ST Name",
"udf_string_12": null,
"udf_float_2": null,
"udf_string_13": null,
"udf_float_3": null,
"udf_string_14": null,
"udf_float_4": null,
"udf_string_15": null,
"udf_string_16": null,
"po_box": null,
"udf_string_1": null,
"floor": null,
"udf_string_2": null,
"area": null,
"udf_string_3": null,
"district": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"state": "Active",
"udf_string_8": null,
"udf_string_9": null,
"country": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"id": "EC3D0DDD618C4051A2B36E62464FB4E4",
"postal_code": "123",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"po_box_postal_code": null,
"apartment_number": null,
"town_city": null,
"type": "HOME",
"municipality": null
},
"life_cycle_state": "IN_PROGRESS",
"type": {
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"fulfillment_scope": "GENERIC_PURPOSE",
"id": "DD56C4D55BACC20DED28F7EAB8F15BE9",
"name": "Installation Job",
"description": "Job for installing Smartcard and Set Top Box on Subscriber's house if requested",
"alternative_code": "001"
},
"description": null,
"contact_email": null,
"expenses_set": [],
"category": null
}
}
POST jobs/generic_purpose/create
This method creates a job of fulfillment scope Generic Purpose. Single job can be created by each call. Only customer jobs can be created through this method.
Resource URL
Parameters
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:
| ||||||||||||
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 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 |
Referred Parameter Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved job |
number | String | The number of the retrieved job |
| description | String | The description of the retrieved job |
| notes | String | The notes of the retrieved job |
| contact_email | String | The email of the customer related with the retrieved job, which will be used in order to communicate the job |
| contact_phone | String | The phone of the customer related with the retrieved job, which will be used in order to communicate the job |
life_cycle_state | String | The life cycle state of the retrieved job which can be DRAFT, PENDING, IN PROGRESS, COMPLETED, CANCELLED |
| start_date | Date | The date that the job is created |
| expected_completion_date | Date | The date that the job is expected to be completed |
| actual_completed_date | Date | The date that the job is actually completed |
| expiration_date | Date | The date on which the job expires. Available from CRM.COM R13.0.0 |
| rating_state | String | The rating state of the job that can be PENDING or COMPLETED |
| amount_to_be_paid_through_wallet | Float | The amount that the customer was intending to use from his wallet in order to pay for the specific job Available from CRM.COM R14.4.0 |
| amount_already_paid | Float | The amount that was already paid for that job, calculated dynamically based on the payments that were submitted against that job Available from CRM.COM R14.4.0 |
| items_receipt_method | 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:
Available from CRM.COM R14.4.0 |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| assigned_to | Assign Object | The assignment information of the retrieved job |
| type | Job Type Object | The type information of the retrieved job |
| billing_terms | Jobs Billing Terms Object | The billing terms of the retrieved job |
| status | Job Status object | The status information of the retrieved job |
| category | Job Category object | The category of the retrieved job |
| service_request | Service Request Object | The service request that was related to the retrieved job. |
| estimated_completion_time | Time Period Object | The time that is estimated to complete the job, measured in minutes, hours, days, weeks, years |
| time_to_completion | Time Period Object | The time that is left up to the expected completion date |
| time_overdue | Time Period Object | The time past the expected completion date |
Accounts Receivable object | The accounts receivable related with the specified job | |
| pricing_agreement_price_plan | Price Plan Object | The pricing agreement that was assigned against an Accounts Receivable Applicable for an Accounts Receivable that is owned by a Company (Corporate Account) and a Price Plan was agreed as part of a special pricing agreement Applicable for Accounts Receivables that are members in the related Corporate Account Group as well Available from CRM.COM R14.0.0 |
| location | Address Object | The physical location that the job should be performed and delivered to |
| cancellation_reason | Jobs Cancellation Object | The reason that the job was canceled. This is applicable only if the job is on a canceled life cycle state |
| owned_by_group | Group Object | The group that is owning the job |
| privacy_level | Privacy Level Object | The job privacy level |
| cloned_job | Job Object | The job that was cloned in order to create the new job This is applicable only if the job is a clone of another job Available on CRM.COM 12.4.0 and from CRM.COM 13.1.0 |
Log Information Object | The log information related to the retrieved job | |
| Unit object | The identifier of the unit that the customer requested to pick up the job physical goods from Available from CRM.COM R14.4.0 | |
| requested_physical_goods_set | Set of Requested Physical Goods Objects | The physical goods that were requested by the retrieved job |
| requested_expenses_set | Set of Requested Expenses Objects | The expenses that were requested by the retrieved job |
| requested_activity_services_set | Set of Requested Activity Services Objects | The activity services that were requested by the retrieved job |
| physical_goods_set | Set of Physical Goods Objects | The physical goods that will be provided as part of the job |
| expenses_set | Set of Expense Objects | A list of one time services which are applied on the job as expenses |
| activities_set | Set of Activity Objects | A set of activities which are planned for the specific job |
| bills_set | Set of Bill Objects | A set of bills that were generated by the billing engine in relation to the specific job |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"556240FE3F49469F9A2C868A66DE5C05",
"type_identifier":{"name":"Installation Job 2"},
"status_identifier": {"name":"Draft"},
"accounts_receivable_identifier":{"number":"ACR001182"},
"contact_email":"m_antoniadou@crm.com",
"contact_phone":"99632587",
"notes":"Installation Job",
"start_date":"2016-07-27T15:30:00",
"location_identifier":{"type":"HOME"},
"owned_by_group_identifier":{"name":"Main Group"},
"estimated_completion_time":
{
"time_period_value":2,
"time_period_uot":"DAYS"
},
"billing_terms":
{
"billing_term_scheme_identifier":{"code":"PJBTS"},
"price_plan_identifier":{"code":"BPP0614"},
"agreement_date":"2016-07-27T15:30:00"
},
"assigned_to":
{
"user_identifier":{"username":"MPAdministrator"}
},
"requested_physical_goods_set":
[
{
"product_identifier":{"code":"Monitor"},
"quantity":1
},
{
"product_identifier":{"alternative_code":"T_1"}
}
],
"requested_expenses_set":
[
{
"product_identifier":{"code":"Expence 1"}
}
],
"requested_activity_services_set":
[
{
"activity_type_identifier":{"name":"Onside Deliveries"},
"product_identifier":{"code":"Home Delivery"}
}
]
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"notes": "Marios Lannister\t27/7/2016 11:42:19\tInstallation Job",
"requested_physical_goods_set": [
{
"id": "BF4383284F7845F4B1D680AB26D9141C",
"quantity": 1,
"product": {
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": true,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "FA802647636A11B7B74B582A688B968D",
"name": "Cameras",
"description": "Cameras",
"alternative_code": "CA"
},
"id": "1133F2CA7DEF919EB7328B2C32097152",
"description": null,
"code": "Monitor",
"alternative_code": "MT"
}
},
{
"id": "F6986C8922D04E428F6353B12D4983DE",
"quantity": 1,
"product": {
"product_type": {
"service_type": null,
"physical_good_type": "NONTRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "7E2B868514DC42FE8E253431F92C8FEE",
"name": "STBControl",
"description": null,
"alternative_code": "S_1"
},
"id": "5BA4D41973AA4353852B1A284E8EDC91",
"description": null,
"code": "TV-Control",
"alternative_code": "T_1"
}
}
],
"billing_terms": {
"binding_information": null,
"agreement_date": "2016-07-27T00:00:00",
"concurrent_usage_based_pricing": {
"concurrent_usage": null,
"rate_percentage": null
},
"billing_term_scheme": {
"life_cycle_state": "EFFECTIVE",
"billing_method": "PERIOD",
"classification": "JOBS",
"id": "9C0B2B52003EFEEE0864212F34D41229",
"name": "P Job Billing Term Scheme",
"code": "PJBTS",
"billing_type": "NORMAL"
},
"effective_date": "2016-07-27T00:00:00",
"billing_frequency": null,
"id": "090E734D931044FE9F5B3D502ABEB638",
"allowed_cancel_date": null,
"expiration_date": null,
"billing_cycle_day": null,
"price_plan": {
"effective_date": "2016-04-08T00:00:00",
"type": "BASE",
"id": "62F4D4E787AD4ACC895FD1D066037353",
"name": "BPP0614",
"description": "Base Price PLan June 14 for Subscription Test Case 6",
"code": "BPP0614",
"expiration_date": null
}
},
"service_request": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "JOB000801",
"udf_float_4": null,
"udf_string_1": null,
"assigned_to": {
"unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"udf_string_2": null,
"privacy_level": null,
"estimated_completion_time": {
"time_period_value": 2,
"time_period_uot": "DAYS"
},
"udf_string_3": null,
"udf_string_4": null,
"contact_phone": "99632587",
"udf_string_5": null,
"activities_set": [],
"udf_string_6": null,
"physical_goods_set": [],
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable": {
"account_owner": {
"last_name": "Anton",
"middle_name": "333",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Mara",
"type": "PERSON",
"id": "3358197AD0334CE2834DB60933B2CE88",
"name": "Anton Mara",
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "568941",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001182",
"id": "570169F05EF949E89FF987AD086A09BE",
"name": "ACR001182"
},
"id": "91B21624D91B4CC183D7E86E82793779",
"requested_activity_services_set": [
{
"activity_type": {
"id": "CB7953F4D06C4135A794623C9F1620D8",
"name": "Onside Deliveries",
"description": null,
"alternative_code": "OD"
},
"id": "FFA4F154E4AA4836AE090FF6D14B43F4",
"product": {
"product_type": {
"service_type": "ONETIME",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FIXEDBUNDLE",
"id": "391D5E5E5F4F70FCA75C4D01ECAD0B6C",
"name": "One Time Services - Fixed",
"description": "One Time Services - Fixed",
"alternative_code": "OTS-F_1"
},
"id": "2AEC889AEC884E83B67A1FF478E34FE0",
"description": null,
"code": "Home Delivery",
"alternative_code": "H_D"
}
}
],
"udf_date_1": null,
"udf_date_2": null,
"expected_completion_date": "2016-07-29T15:30:00",
"udf_date_3": null,
"udf_date_4": null,
"start_date": "2016-07-27T15:30:00",
"time_overdue": {
"time_period_value": null,
"time_period_uot": null
},
"time_to_completion": {
"time_period_value": 2,
"time_period_uot": "DAYS"
},
"rating_state": "PENDING",
"requested_expenses_set": [
{
"id": "15E0E1408F424A27971A5A3599F1F4F3",
"product": {
"product_type": {
"service_type": "EXPENSE",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "67FA013211E348C58F7CD27F8399AADE",
"name": "Expense Type",
"description": null,
"alternative_code": "ET"
},
"id": "2855ACFCB7D94ED69A5FC3B9557EB6D6",
"description": "Expence 1",
"code": "Expence 1",
"alternative_code": "exp1"
}
}
],
"log_information": {
"updated_date": "2016-07-27T13:12:20",
"created_date": "2016-07-27T13:12:19",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"owned_by_group": {
"community_name": "Internal Community",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"name": "Main Group",
"description": "Main Group",
"alternative_code": "MG1"
},
"status": {
"life_cycle_state": "DRAFT",
"id": "0F1EE97BD63642699FFAEB461F471147",
"name": "Draft",
"description": null,
"alternative_code": "D"
},
"actual_completed_date": null,
"location": {
"udf_string_10": null,
"street_number": "10",
"care_of": null,
"udf_string_11": null,
"udf_float_1": null,
"street_name": "Athaslassis",
"udf_string_12": null,
"udf_float_2": null,
"udf_string_13": null,
"udf_float_3": null,
"udf_string_14": null,
"udf_float_4": null,
"udf_string_15": null,
"udf_string_16": null,
"po_box": null,
"udf_string_1": null,
"floor": 2,
"udf_string_2": null,
"area": null,
"udf_string_3": null,
"district": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"state": "Active",
"udf_string_8": null,
"udf_string_9": null,
"country": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"id": "168CD026F5F74AFBA31CF02E291793AE",
"postal_code": "2335",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"po_box_postal_code": null,
"apartment_number": "201",
"town_city": null,
"type": "HOME",
"municipality": null
},
"life_cycle_state": "DRAFT",
"type": {
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"fulfillment_scope": "GENERIC_PURPOSE",
"id": "98523D8F88354CFAA8BF66E51DEA0A40",
"name": "Installation Job 2",
"description": "Job for installing Smartcard and Set Top Box on Subscriber's house if requested",
"alternative_code": "002"
},
"description": null,
"contact_email": "m_antoniadou@crm.com",
"expenses_set": [],
"category": null
}
}
HTTP Method: POST
Request:
Body:
{
"token":"556240FE3F49469F9A2C868A66DE5C05",
"type_identifier":{"name":"L Jobs"},
"status_identifier": {"name":"Assigned"},
"accounts_receivable_identifier":{"number":"ACR001183"},
"contact_email":"m_antoniadou@crm.com",
"notes":"Generic Job",
"start_date":"2016-07-27T14:30:00",
"location_identifier":{"type":"BUSINESS"},
"owned_by_group_identifier":{"name":"Main Group"},
"estimated_completion_time":
{
"time_period_value":1,
"time_period_uot":"DAYS"
},
"billing_terms":
{
"billing_term_scheme_identifier":{"code":"L Jobs All Price Plans"},
"price_plan_identifier":{"code":"BPP0614"},
"agreement_date":"2016-07-27T14:30:00"
},
"assigned_to":
{
"unit_identifier":{"name":"Admin Unit"}
},
"requested_physical_goods_set":
[
{
"product_identifier":{"code":"Monitor"},
"quantity":1
},
{
"product_identifier":{"alternative_code":"TM"}
}
],
"requested_expenses_set":
[
{
"product_identifier":{"code":"Expence 1"}
}
],
"requested_activity_services_set":
[
{
"activity_type_identifier":{"name":"Customer Training"},
"product_identifier":{"code":"Material Delivery"}
},
{
"activity_type_identifier":{"name":"Customer Training"},
"product_identifier":{"code":"Support"}
}
],
"fields_set":"id,number,notes,expected_completion_date,type,status,location,owned_by_group,requested_physical_goods_set,requested_expenses_set,requested_activity_services_set"
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"requested_activity_services_set": [
{
"activity_type": {
"id": "09EE47872CF8414A98C2EC5655936BF5",
"name": "Customer Training",
"description": null,
"alternative_code": "CT"
},
"id": "02C0A8EA0D404CB4BEF60DD168D8B825",
"product": {
"product_type": {
"service_type": "ONETIME",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "7EDF537A938DECAB1352E6EEAD54A5D0",
"name": "One Time Services - Flat",
"description": "A type which is used for one time services",
"alternative_code": "OTS-F"
},
"id": "362AF22847BA4ED0CDED5CDFF8BABBC1",
"description": "Delivery of Materials Service Charge",
"code": "Material Delivery",
"alternative_code": "MD"
}
},
{
"activity_type": {
"id": "09EE47872CF8414A98C2EC5655936BF5",
"name": "Customer Training",
"description": null,
"alternative_code": "CT"
},
"id": "416D876B6A90444EA31D796CA2ADAF4E",
"product": {
"product_type": {
"service_type": "ONETIME",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "7EDF537A938DECAB1352E6EEAD54A5D0",
"name": "One Time Services - Flat",
"description": "A type which is used for one time services",
"alternative_code": "OTS-F"
},
"id": "2E1C3761B6701C1DC4652D5E1D826AD6",
"description": null,
"code": "Support",
"alternative_code": "Support"
}
}
],
"owned_by_group": {
"community_name": "Internal Community",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"name": "Main Group",
"description": "Main Group",
"alternative_code": "MG1"
},
"notes": "Marios Lannister\t27/7/2016 11:40:17\tGeneric Job",
"requested_physical_goods_set": [
{
"id": "4D1FD0304B274C9EB46DA6B5BB0A25F9",
"quantity": 1,
"product": {
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": true,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "249F5EA21B317E4B7BB6F696E7496F03",
"name": "Modem",
"description": "Modem",
"alternative_code": "MODEM"
},
"id": "10E2DC528CC865A383FBB25A7DB97436",
"description": null,
"code": "Thomson Modem",
"alternative_code": "TM"
}
},
{
"id": "DECEFDE283724836A0CE07A390DA988F",
"quantity": 1,
"product": {
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": true,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "FA802647636A11B7B74B582A688B968D",
"name": "Cameras",
"description": "Cameras",
"alternative_code": "CA"
},
"id": "1133F2CA7DEF919EB7328B2C32097152",
"description": null,
"code": "Monitor",
"alternative_code": "MT"
}
}
],
"status": {
"life_cycle_state": "PENDING",
"id": "JobStatus1",
"name": "Assigned",
"description": null,
"alternative_code": "AS"
},
"location": {
"udf_string_10": null,
"street_number": "10",
"care_of": null,
"udf_string_11": null,
"udf_float_1": null,
"street_name": "Arsinoes",
"udf_string_12": null,
"udf_float_2": null,
"udf_string_13": null,
"udf_float_3": null,
"udf_string_14": null,
"udf_float_4": null,
"udf_string_15": null,
"udf_string_16": null,
"po_box": null,
"udf_string_1": null,
"floor": 4,
"udf_string_2": null,
"area": null,
"udf_string_3": null,
"district": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"state": "Active",
"udf_string_8": null,
"udf_string_9": null,
"country": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"id": "59A2696666C94730AFFCE58319B429E6",
"postal_code": "1256",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"po_box_postal_code": null,
"apartment_number": "400",
"town_city": null,
"type": "BUSINESS",
"municipality": null
},
"number": "JOB000800",
"type": {
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"fulfillment_scope": "GENERIC_PURPOSE",
"id": "B0014F0386234D24806758951A4B389E",
"name": "L Jobs",
"description": null,
"alternative_code": "L Jobs"
},
"expected_completion_date": "2016-07-28T14:30:00",
"id": "81F2BC825CC340C7A972E1E8D9182447",
"requested_expenses_set": [
{
"id": "2893537483D64253A618259F4B79FD0F",
"product": {
"product_type": {
"service_type": "EXPENSE",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "67FA013211E348C58F7CD27F8399AADE",
"name": "Expense Type",
"description": null,
"alternative_code": "ET"
},
"id": "2855ACFCB7D94ED69A5FC3B9557EB6D6",
"description": "Expence 1",
"code": "Expence 1",
"alternative_code": "exp1"
}
}
]
}
}
POST jobs/generic_purpose/update
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.
Resource URL
Parameters
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:
| ||||||||||||
status_identifier | Job status identifier | The identifier of the status of the new job. 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:
| ||||||||||||
| description (optional) | String | The description of the new job | ||||||||||||
notes | String | The 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 | Date | The date that the activity 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:
| ||||||||||||
udf_string_1 | String | User Defined Field of type String | ||||||||||||
udf_string_2 | String | User Defined Field of type String | ||||||||||||
udf_string_3 | String | User Defined Field of type String | ||||||||||||
udf_string_4 | String | User Defined Field of type String | ||||||||||||
udf_string_5 | String | User Defined Field of type String | ||||||||||||
udf_string_6 | String | User Defined Field of type String | ||||||||||||
udf_string_7 | String | User Defined Field of type String | ||||||||||||
udf_string_8 | String | User Defined Field of type String | ||||||||||||
udf_float_1 | Float | User Defined Field of type Float | ||||||||||||
udf_float_2 | Float | User Defined Field of type Float | ||||||||||||
udf_float_3 | Float | User Defined Field of type Float | ||||||||||||
udf_float_4 | Float | User Defined Field of type Float | ||||||||||||
udf_date_1 | Date | User Defined Field of type Date | ||||||||||||
udf_date_2 | Date | User Defined Field of type Date | ||||||||||||
udf_date_3 | Date | User Defined Field of type Date | ||||||||||||
udf_date_4 | 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_time is specified. | ||||||||||||
| 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 object | The assignment information for the retrieved job. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules. | ||||||||||||
(optional) | Set of Requested Physical Good Objects | The requested physical goods. This information is applicable only if the job is draft or pending If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
(optional) | Set of Requested Expense Objects | The requested expenses. This information is applicable only if the job is draft or pending If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
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 If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
| 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 If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
| 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 If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
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 |
Referred Parameter Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved job |
number | String | The number of the retrieved job |
| description | String | The description of the retrieved job |
| notes | String | The notes of the retrieved job |
| contact_email | String | The email of the customer related with the retrieved job, which will be used in order to communicate the job |
| contact_phone | String | The phone of the customer related with the retrieved job, which will be used in order to communicate the job |
life_cycle_state | String | The life cycle state of the retrieved job which can be DRAFT, PENDING, IN PROGRESS, COMPLETED, CANCELLED |
| start_date | Date | The date that the job is created |
| expected_completion_date | Date | The date that the job is expected to be completed |
| actual_completed_date | Date | The date that the job is actually completed |
| expiration_date | Date | The date on which the job expires. Available from CRM.COM R13.0.0 |
| rating_state | String | The rating state of the job that can be PENDING or COMPLETED |
| amount_to_be_paid_through_wallet | Float | The amount that the customer was intending to use from his wallet in order to pay for the specific job Available from CRM.COM R14.4.0 |
| amount_already_paid | Float | The amount that was already paid for that job, calculated dynamically based on the payments that were submitted against that job Available from CRM.COM R14.4.0 |
| items_receipt_method | 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:
Available from CRM.COM R14.4.0 |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| assigned_to | Assign Object | The assignment information of the retrieved job |
| type | Job Type Object | The type information of the retrieved job |
| billing_terms | Jobs Billing Terms Object | The billing terms of the retrieved job |
| status | Job Status object | The status information of the retrieved job |
| category | Job Category object | The category of the retrieved job |
| service_request | Service Request Object | The service request that was related to the retrieved job. |
| estimated_completion_time | Time Period Object | The time that is estimated to complete the job, measured in minutes, hours, days, weeks, years |
| time_to_completion | Time Period Object | The time that is left up to the expected completion date |
| time_overdue | Time Period Object | The time past the expected completion date |
Accounts Receivable object | The accounts receivable related with the specified job | |
| pricing_agreement_price_plan | Price Plan Object | The pricing agreement that was assigned against an Accounts Receivable Applicable for an Accounts Receivable that is owned by a Company (Corporate Account) and a Price Plan was agreed as part of a special pricing agreement Applicable for Accounts Receivables that are members in the related Corporate Account Group as well Available from CRM.COM R14.0.0 |
| location | Address Object | The physical location that the job should be performed and delivered to |
| cancellation_reason | Jobs Cancellation Object | The reason that the job was canceled. This is applicable only if the job is on a canceled life cycle state |
| owned_by_group | Group Object | The group that is owning the job |
| privacy_level | Privacy Level Object | The job privacy level |
| cloned_job | Job Object | The job that was cloned in order to create the new job This is applicable only if the job is a clone of another job Available on CRM.COM 12.4.0 and from CRM.COM 13.1.0 |
Log Information Object | The log information related to the retrieved job | |
| Unit object | The identifier of the unit that the customer requested to pick up the job physical goods from Available from CRM.COM R14.4.0 | |
| requested_physical_goods_set | Set of Requested Physical Goods Objects | The physical goods that were requested by the retrieved job |
| requested_expenses_set | Set of Requested Expenses Objects | The expenses that were requested by the retrieved job |
| requested_activity_services_set | Set of Requested Activity Services Objects | The activity services that were requested by the retrieved job |
| physical_goods_set | Set of Physical Goods Objects | The physical goods that will be provided as part of the job |
| expenses_set | Set of Expense Objects | A list of one time services which are applied on the job as expenses |
| activities_set | Set of Activity Objects | A set of activities which are planned for the specific job |
| bills_set | Set of Bill Objects | A set of bills that were generated by the billing engine in relation to the specific job |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
Response: