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.
This method returns information related with jobs that are pending.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
| accounts_receivable_identifier (optional) | Accounts receivable identifier | The identifier of the accounts receivable in which the jobs that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
type_identifier | Job type identifier | The identifier of the type of the retrieved job. The allowed job type 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 |
| rating_state | String | The rating state of the job that can be PENDING or COMPLETED |
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 |
| requested_subscription_type | Subscription Type Object | The type of the subscription which is requested by the retrieved job. This information is available only if the job type fulfillment scope is set to New Subscription
|
| billing_terms | Jobs Billing Terms Object | The billing terms of the retrieved job |
| requested_subscription_billing_terms | Subscription Billing Terms Object | The billing terms of the subscription which is requested by the retrieved job. This information is available only if the job type fulfillment scope is set to New Subscription |
| status | Job Status object | The status information of the retrieved job |
| category | Job Category object | The category of the retrieved job |
| subscription | Subscription Object | The subscription that was related with the retrieved job. This information is available only if the job type fulfillment scope is set to New Subscription |
| service_request | Service Request Object | The service request that was related with 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 cancelled. This is applicable only if the job is on a cancelled life cycle state |
| owned_by_group | Group object | The group that is owning the job |
| privacy_level | Privacy level object | The job privacy level |
Log Information Object | The log information related with the retrieved job | |
| requested_subscription_services_set | Set of Requested Subscription Services Objects | The subscription services that were requested by the retrieved job. This information is available only if the job type fulfillment scope is set to New Subscription, Add Subscription Services, Cancel Subscription Services or Swap Subscription Services
|
| requested_physical_goods_set | Set of Requested Physical Goods Objects | The physical goods that were requested by the retrieved job
|
| requested_subscription_physical_goods_set | Set of Requested Subscription Physical Goods Objects | The subscription physical goods that were requested by the retrieved job. This information is available only if the job type fulfillment scope is set to New Subscription, Add Subscription or Swap Subscription Installed Items.
|
| 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
|
| subscription_services_set | Set of Subscription Services Objects | The subscription services that will be provided as part of the job. This information is available only if the job type fulfillment scope is set to New Subscription, Add Subscription Services, Cancel Subscription Services or Swap Subscription Services |
| subscription_physical_goods_set | Set of Subscription Physical Goods Objects | The subscription physical goods that will be provided as part of the job. This information is available only if the job type fulfillment scope is set to New Subscription, Add Subscription Services or Swap Subscription Installed Items |
| 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": null,
"description": null,
"code": "OK"
},
"data":
[
{
"notes": null,
"billing_terms":
{
"binding_information": null,
"agreement_date": "2014-12-05T15:49:59",
"billing_term_scheme":
{
"billing_method": "PERIOD",
"life_cycle_state": "EFFECTIVE",
"classification": "JOBS",
"name": "Normal Billing Scheme J",
"id": "AC225A76B462EE4A7371467DDF5B1F47",
"code": "NBSJ",
"billing_type": "NORMAL"
},
"concurrent_usage_based_pricing":
{
"rate_percentage": null,
"concurrent_usage": null
},
"effective_date": "2014-10-27T00:00:00",
"frequency_information": null,
"id": "CE84F7CD5BE95C91924F4F1531B24478",
"allowed_cancel_date": null,
"expiration_date": null,
"price_plan":
{
"effective_date": "2014-06-26T00:00:00",
"type": "CONDITIONAL",
"name": "my Conditional Plan",
"id": "FC0730468947E4F7B8C2199E60525450",
"description": null,
"code": "MCP",
"expiration_date": "2015-06-26T00:00:00",
"version_num": 1
},
"billing_cycle_day": null
},
"udf_float_1": 10,
"udf_float_2": 20,
"udf_float_3": 30,
"number": "277",
"udf_float_4": 40,
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"assigned_to":
{
"unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Marketing Unit",
"id": "83922FE923563679768A94F58CAB5569",
"description": "r1c1",
"alternative_code": null
},
"user": null
},
"privacy_level":
{
"number": "61",
"hierarchy_level": 6,
"name": "DPLG6",
"id": "02D0A95A45CCC1D1834FFA6DC3D31F3D"
},
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"activities_set":
[
],
"udf_string_6": "udf string 6",
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Lucia",
"name": "Lucia Papapavlou",
"id": "691E4101DE919D4C87D3E1006EDDE08B",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": null,
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "330",
"name": "luc1",
"id": "08D8AE790F1EE11887654469CC9F4C37"
},
"id": "91F438891630A913014DBB4C64ACA633",
"udf_date_1": "2014-05-05T15:49:59",
"udf_date_2": "2014-06-05T15:49:59",
"udf_date_3": "2014-07-05T15:49:59",
"expected_completion_date": "2014-05-10T15:49:59",
"start_date": "2014-05-05T15:49:59",
"udf_date_4": "2014-08-05T15:49:59",
"time_to_completion":
{
"time_period_value": null
},
"time_overdue":
{
"time_period_value": 5.612903225806452,
"time_period_uot": "MONTHS"
},
"bills_set":
[
],
"physical_goods_to_be_provided_set":
[
],
"owned_by_group":
{
"community_name": "Main Community",
"name": "Nicosia Office",
"id": "68D54DA033606669621E3D2E4B355DA0",
"description": null,
"alternative_code": "NO"
},
"log_information":
{
"updated_date": "2014-10-27T13:12:25",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-10-27T13:12:21",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"status":
{
"name": "Assigned",
"id": "D5D244EC302EEBAB424F9896B7F10425",
"alternative_code": "AS"
},
"actual_completed_date": null,
"life_cycle_state": "PENDING",
"location":
{
"care_of": "111",
"street_number": "111",
"udf_string_10": null,
"udf_float_1": null,
"udf_string_11": null,
"street_name": "1111",
"udf_float_2": null,
"udf_string_12": null,
"udf_float_3": null,
"udf_string_13": null,
"udf_float_4": null,
"udf_string_14": null,
"udf_string_15": null,
"po_box": "111",
"udf_string_1": null,
"udf_string_16": null,
"udf_string_2": null,
"floor": 121,
"udf_string_3": null,
"area": "1",
"udf_string_4": null,
"district": "1",
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"state": "Active",
"udf_string_8": null,
"udf_string_9": null,
"country":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"id": "725D4B23253D4AB73849C1E1C92C022D",
"postal_code": "111",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"po_box_postal_code": "1111",
"apartment_number": "111",
"town_city": "1",
"type": "Home",
"municipality": "1"
},
"estimate_completion_time":
{
"time_period_value": 5,
"time_period_uot": "DAYS"
},
"type":
{
"name": "Installations",
"id": "A2BB42B91DBA4D3FEE5613D20C161A17",
"alternative_code": "IN"
},
"description": "tv installation",
"category": null,
"expenses_set":
[
]
},
{
"notes": "postponed for next month",
"billing_terms": null,
"udf_float_1": 10,
"udf_float_2": 20,
"udf_float_3": 30,
"number": "J00000009",
"udf_float_4": 40,
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"assigned_to":
{
"unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"privacy_level":
{
"number": "61",
"hierarchy_level": 6,
"name": "DPLG6",
"id": "02D0A95A45CCC1D1834FFA6DC3D31F3D"
},
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"activities_set":
[
],
"udf_string_6": "udf string 6",
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Lucia",
"name": "Lucia Papapavlou",
"id": "691E4101DE919D4C87D3E1006EDDE08B",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": null,
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "330",
"name": "luc1",
"id": "08D8AE790F1EE11887654469CC9F4C37"
},
"id": "6A910AAC45B074048BC76667BCF41812",
"udf_date_1": "2014-05-05T15:49:59",
"udf_date_2": "2014-06-05T15:49:59",
"udf_date_3": "2014-07-05T15:49:59",
"expected_completion_date": "2014-05-10T15:49:59",
"start_date": "2014-05-05T15:49:59",
"udf_date_4": "2014-08-05T15:49:59",
"time_to_completion":
{
"time_period_value": null
},
"time_overdue":
{
"time_period_value": 5.612903225806452,
"time_period_uot": "MONTHS"
},
"bills_set":
[
],
"physical_goods_to_be_provided_set":
[
{
"installed_item":
{
"state": "EFFECTIVE",
"serial_number": "d0000000003",
"id": "B822DB0FDD449694B6C90C83BA41BDB2",
"product":
{
"product_type":
{
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"id": "E8672BB71A9B1BD25E30705AC34D7D61",
"description": "Decoders 2",
"code": "Decoders 1",
"alternative_code": "D1"
},
"alternative_code": "d0000000003"
},
"quantity": null,
"id": "7F180467A89E33858567CA691953288C",
"product":
{
"product_type":
{
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"id": "E8672BB71A9B1BD25E30705AC34D7D61",
"description": "Decoders 2",
"code": "Decoders 1",
"alternative_code": "D1"
}
},
{
"installed_item": null,
"quantity": 31,
"id": "4299E65F6F1E2FF06BE0ED2A44B1C32C",
"product":
{
"product_type":
{
"physical_good_type": "NONTRACEABLE",
"service_type": null,
"used_for_provisioning": false,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Accessories",
"id": "0F94B51F175F06A475EB2948B4030074",
"description": "A type which is used for accessories physical goods",
"alternative_code": "005"
},
"id": "97CF748815BEBA2B294148694D9E0B14",
"description": null,
"code": "Wires",
"alternative_code": "WI"
}
},
{
"installed_item":
{
"state": "EFFECTIVE",
"serial_number": "d2000000000",
"id": "10225F6DF089E18951E01D11F8C766FE",
"product":
{
"product_type":
{
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"id": "12A61F321368703D77C48A0A085D9B7D",
"description": "Decoders 2",
"code": "Decoders 2",
"alternative_code": "D2"
},
"alternative_code": "d2000000000"
},
"quantity": null,
"id": "1DA626ECA3B50E30A9126852003EE5B4",
"product":
{
"product_type":
{
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"id": "12A61F321368703D77C48A0A085D9B7D",
"description": "Decoders 2",
"code": "Decoders 2",
"alternative_code": "D2"
}
}
],
"owned_by_group":
{
"community_name": "Main Community",
"name": "Nicosia Office",
"id": "68D54DA033606669621E3D2E4B355DA0",
"description": null,
"alternative_code": "NO"
},
"log_information":
{
"updated_date": "2014-10-29T14:05:03",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-10-29T14:05:02",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"status":
{
"name": "Pending",
"id": "A72F80D3B0C42597240DBA79AC295173",
"alternative_code": "P1"
},
"actual_completed_date": null,
"life_cycle_state": "PENDING",
"location":
{
"care_of": "111",
"street_number": "111",
"udf_string_10": null,
"udf_float_1": null,
"udf_string_11": null,
"street_name": "1111",
"udf_float_2": null,
"udf_string_12": null,
"udf_float_3": null,
"udf_string_13": null,
"udf_float_4": null,
"udf_string_14": null,
"udf_string_15": null,
"po_box": "111",
"udf_string_1": null,
"udf_string_16": null,
"udf_string_2": null,
"floor": 121,
"udf_string_3": null,
"area": "1",
"udf_string_4": null,
"district": "1",
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"state": "Active",
"udf_string_8": null,
"udf_string_9": null,
"country":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"id": "725D4B23253D4AB73849C1E1C92C022D",
"postal_code": "111",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"po_box_postal_code": "1111",
"apartment_number": "111",
"town_city": "1",
"type": "Home",
"municipality": "1"
},
"estimate_completion_time":
{
"time_period_value": 5,
"time_period_uot": "DAYS"
},
"type":
{
"name": "Installation Job",
"id": "DD56C4D55BACC20DED28F7EAB8F15BE9",
"alternative_code": "001"
},
"description": "tv installation",
"category": null,
"expenses_set":
[
{
"id": "2F983F2D1B41801E851D272CCF23652D",
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "ONETIME",
"used_for_provisioning": false,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Magazine Subscription",
"id": "BB0025655ABF9B6AB0AF96B59A7B7513",
"description": "Magazine Subscription",
"alternative_code": "MS"
},
"id": "BA96B8FE1299C4F364CA8EF3D7F1FC17",
"description": "FEE9",
"code": "FEE9",
"alternative_code": null
}
},
{
"id": "74A8D43976637023A139A5C5B3659D6E",
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "ONETIME",
"used_for_provisioning": false,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Magazine Subscription",
"id": "BB0025655ABF9B6AB0AF96B59A7B7513",
"description": "Magazine Subscription",
"alternative_code": "MS"
},
"id": "1C7A9DF9605034D0423FE645923E4514",
"description": "FEE4",
"code": "FEE4",
"alternative_code": null
}
}
]
}
]
}