Available from CRM.COM R10.0.0
GET jobs/cancel_subscription_services/show
This method returns information related with a job of fulfillment scope Cancel Subscription Services. 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 form CRM.COM R13.0.0 |
scheduled_date | Date | The date on which the job is scheduled, which also indicates the date on which the Cancel Subscription Service action will be scheduled to be performed Available from CRM.COM R13.0.0 |
| 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 |
| 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 |
| subscription | Subscription Object | The subscription for which the subscription services were cancelled by the job. |
| 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 to be cancelled from the subscription. |
| 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 |
| subscription_services_set | Set of Subscription Services Objects | The subscription services that will be provided as part of the 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": {
"requested_physical_goods_set": [],
"service_request": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_float_4": null,
"udf_string_1": null,
"udf_string_2": null,
"assigned_to": {
"unit": null,
"user": {
"person_name": "retailer",
"username": "retailer",
"id": "3B04FBB34998EE8973100C0069482539",
"email": null
}
},
"udf_string_3": null,
"privacy_level": null,
"udf_string_4": null,
"udf_string_5": null,
"contact_phone": null,
"udf_string_6": null,
"activities_set": [],
"udf_string_7": null,
"physical_goods_set": [],
"udf_string_8": null,
"accounts_receivable": {
"account_owner": {
"last_name": "Papapavlou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Miss",
"first_name": "Loukia",
"type": "PERSON",
"id": "37072CF6ED884737B6592A7CBB6D5342",
"name": "Papapavlou Loukia",
"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": "LP1234",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000852",
"id": "A86D415E729945C6933177D83319FBE6",
"name": "ACR000852"
},
"id": "2F81FAF4ED4649AD9AFBFF86B10AA6FF",
"subscription": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Papapavlou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Miss",
"first_name": "Loukia",
"type": "PERSON",
"id": "37072CF6ED884737B6592A7CBB6D5342",
"name": "Papapavlou Loukia",
"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": "LP1234",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000852",
"id": "A86D415E729945C6933177D83319FBE6",
"name": "ACR000852"
},
"number": "S60843",
"type": {
"id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
"name": "London",
"description": "Subscription for London customers",
"alternative_code": "LND"
},
"id": "635729BCBBE0433387C607607D180D2E",
"first_activated_date": "2016-05-10T11:33:31",
"rating_state": "PENDING"
},
"requested_activity_services_set": [],
"expected_completion_date": "2016-05-10T12:54:11",
"time_to_completion": {
"time_period_value": null,
"time_period_uot": null
},
"time_overdue": {
"time_period_value": 2.3870967741935485,
"time_period_uot": "MONTHS"
},
"log_information": {
"updated_date": "2016-05-10T11:54:14",
"created_date": "2016-05-10T11:54:11",
"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"
}
},
"life_cycle_state": "PENDING",
"location": {
"udf_string_10": null,
"street_number": "4",
"care_of": null,
"udf_string_11": null,
"udf_float_1": null,
"street_name": "Markou Drakou",
"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": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"id": "2F132D5A059846EF8288B8A9AAC37E00",
"postal_code": "2213",
"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
},
"type": {
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"fulfillment_scope": "CANCEL_SUBSCRIPTION_SERVICES",
"id": "7BB388FDF9BB438CB4632E792981E082",
"name": "Cancel L Services",
"description": null,
"alternative_code": "CLS"
},
"contact_email": null,
"expenses_set": [],
"notes": null,
"billing_terms": {
"binding_information": null,
"agreement_date": "2016-03-20T00:00:00",
"concurrent_usage_based_pricing": {
"concurrent_usage": null,
"rate_percentage": null
},
"billing_term_scheme": {
"life_cycle_state": "EFFECTIVE",
"classification": "JOBS",
"id": "A93EE074C8C34311AB06EE325384B64A",
"name": "L Jobs",
"code": "L Jobs",
"billing_type": "NORMAL"
},
"effective_date": "2016-05-10T00:00:00",
"billing_frequency": null,
"id": "7E7EDA49EFA943458409F4B5CAEC5313",
"allowed_cancel_date": null,
"expiration_date": null,
"billing_cycle_day": null,
"price_plan": {
"effective_date": "2016-04-18T00:00:00",
"type": "BASE",
"id": "0410E96E76274F07B9F1F3B1446A2C4A",
"name": "Movies L",
"description": null,
"code": "Movies L",
"expiration_date": null
}
},
"number": "JOB000557",
"estimated_completion_time": {
"time_period_value": 1.6451612903225807,
"time_period_uot": "MONTHS"
},
"requested_subscription_services_set": [
{
"product_bundle": null,
"swap_product": null,
"provisioning_distributor": null,
"id": "675EE4C6DF8B4DA7B93588B514C49894",
"product": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "B18BD7B80DEF66E61ED3FBE4523F5383",
"name": "Termed - Flat",
"description": "Termed - Flat",
"alternative_code": "TS"
},
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"description": "Bronze Premium Package",
"code": "Bronze",
"alternative_code": "BP"
}
}
],
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"start_date": "2016-03-21T15:49:59",
"udf_date_4": null,
"rating_state": "PENDING",
"requested_expenses_set": [],
"bills_set": [],
"owned_by_group": {
"community_name": "Internal Community",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"name": "Main Group",
"description": "Main Group",
"alternative_code": "MG1"
},
"status": {
"life_cycle_state": "PENDING",
"id": "JobStatus1",
"name": "Assigned",
"description": null,
"alternative_code": "AS"
},
"actual_completed_date": null,
"description": null,
"category": null
}
}
POST jobs/cancel_subscription_services/create
This method creates a job of fulfillment scope Cancel Subscription Services. 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:
| ||||||||||||
subscription_identifier (mandatory) | Subscriptions Identifier | The identifier of the subscription for which the requested subscription services will be cancelled through the new job. The allowed subscription 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 | ||||||||||||
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 | ||||||||||||
requested_subscription_services_set (mandatory) | Set of Requested Subscription Service Objects | A list of subscription services that were requested by the customer to be cancelled through the new job. The subscription services are filtered based on the specified subscription type and billing term scheme. All the subscription related rules and restrictions are applicable on the requested subscription services as well | ||||||||||||
(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 form CRM.COM R13.0.0 |
scheduled_date | Date | The date on which the job is scheduled, which also indicates the date on which the Cancel Subscription Service action will be scheduled to be performed Available from CRM.COM R13.0.0 |
| 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 |
| 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 |
| subscription | Subscription Object | The subscription for which the subscription services were cancelled by the job. |
| 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 to be cancelled from the subscription. |
| 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 |
| subscription_services_set | Set of Subscription Services Objects | The subscription services that will be provided as part of the 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":"11700543499C449989E94F54362ED55A",
"type_identifier":{"name":"Cancel subscription services"},
"status_identifier": {"name":"Draft"},
"accounts_receivable_identifier":{"number":"ACR001183"},
"subscription_identifier":{"number":"S61011"},
"contact_email":"m_antoniadou@crm.com",
"contact_phone":"9965321",
"description":"Cancel Services Bronze and Movies 2",
"start_date":"2016-07-28T10:00:00",
"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":"PJBTS"},
"price_plan_identifier":{"code":"BPP0614"},
"agreement_date":"2016-07-28T10:00:00"
},
"assigned_to":
{
"unit_identifier":{"name":"Admin Unit"}
},
"requested_subscription_services_set":
[
{
"service_identifier":{"code":"Bronze"}
},
{
"service_identifier":{"code":"Movies 2"}
}
],
"requested_physical_goods_set":
[
{
"product_identifier":{"code":"Remote Control"},
"quantity":2
}
],
"requested_expenses_set":
[
{
"product_identifier":{"code":"Expence 3"}
}
],
"requested_activity_services_set":
[
{
"activity_type_identifier":{"name":"Demonstration"},
"product_identifier":{"code":"Installation Fee"}
},
{
"activity_type_identifier":{"name":"Meeting"},
"product_identifier":{"code":"MFee"}
}
]
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"requested_physical_goods_set": [
{
"id": "9F0B214A72124F01A08DD6C4C49E93E8",
"quantity": 2,
"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": "3F01BB0B40264DF7311660F63CB2180D",
"description": "Remote Control",
"code": "Remote Control",
"alternative_code": "REM"
}
}
],
"service_request": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_float_4": null,
"udf_string_1": null,
"udf_string_2": 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": null
},
"udf_string_3": null,
"privacy_level": null,
"udf_string_4": null,
"udf_string_5": null,
"contact_phone": "9965321",
"udf_string_6": null,
"activities_set": [],
"udf_string_7": null,
"physical_goods_set": [],
"udf_string_8": null,
"accounts_receivable": {
"account_owner": {
"last_name": "Anton",
"middle_name": "N",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Marina",
"type": "PERSON",
"id": "EE621BE231714DFE8CE370261BF6DB25",
"name": "Anton Marina",
"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": "8945612",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001183",
"id": "05924503D2054355B48BAB24646F9AC5",
"name": "ACR001183"
},
"id": "E1298733481F45858A2B39BA03B44C44",
"subscription": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Anton",
"middle_name": "N",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Marina",
"type": "PERSON",
"id": "EE621BE231714DFE8CE370261BF6DB25",
"name": "Anton Marina",
"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": "8945612",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001183",
"id": "05924503D2054355B48BAB24646F9AC5",
"name": "ACR001183"
},
"number": "S61011",
"type": {
"id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
"name": "London",
"description": "Subscription for London customers",
"alternative_code": "LND"
},
"id": "41248290B58647A5993DE4380B0A7763",
"first_activated_date": "2016-07-28T11:17:45",
"rating_state": "PENDING"
},
"requested_activity_services_set": [
{
"activity_type": {
"id": "F609C9D1CD43463DA810B1EC415BB5E1",
"name": "Meeting",
"description": null,
"alternative_code": "M"
},
"id": "62980FE3F90C407AB1014F457FCA6F64",
"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": "28709F00389D79015AF4511B4A1BDFF6",
"description": "Meeting Fees",
"code": "MFee",
"alternative_code": "MFee"
}
},
{
"activity_type": {
"id": "6DFD8FD0D5024AC48750368FC39D13A8",
"name": "Demonstration",
"description": "demo",
"alternative_code": "D"
},
"id": "F07931030F8F4CD989FC704EA5A4C812",
"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"
}
}
],
"expected_completion_date": "2016-07-29T10:00:00",
"time_to_completion": {
"time_period_value": 1,
"time_period_uot": "DAYS"
},
"time_overdue": {
"time_period_value": null,
"time_period_uot": null
},
"log_information": {
"updated_date": "2016-07-28T11:21:44",
"created_date": "2016-07-28T11:21:38",
"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"
}
},
"life_cycle_state": "DRAFT",
"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
},
"type": {
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"fulfillment_scope": "CANCEL_SUBSCRIPTION_SERVICES",
"id": "F3E2989718864DD1BE929A6519D7C4C1",
"name": "Cancel subscription services",
"description": null,
"alternative_code": "CSS"
},
"contact_email": "m_antoniadou@crm.com",
"expenses_set": [],
"notes": null,
"billing_terms": {
"binding_information": null,
"agreement_date": "2016-07-28T00: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-28T00:00:00",
"billing_frequency": null,
"id": "88420C44710443EFA79AAE0499CD1FE8",
"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
}
},
"number": "JOB000810",
"estimated_completion_time": {
"time_period_value": 1,
"time_period_uot": "DAYS"
},
"requested_subscription_services_set": [
{
"product_bundle": null,
"swap_product": null,
"provisioning_distributor": null,
"id": "80638907E0C141AA83DCB60899A3E8D2",
"product": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "B18BD7B80DEF66E61ED3FBE4523F5383",
"name": "Termed - Flat",
"description": "Termed - Flat",
"alternative_code": "TS"
},
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"description": "Bronze Premium Package",
"code": "Bronze",
"alternative_code": "BP"
}
},
{
"product_bundle": null,
"swap_product": null,
"provisioning_distributor": null,
"id": "36CADC26207A4EE3B1E67BFA689D9DBC",
"product": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "600438B64B0F05AB3D020C902674949F",
"name": "Subscription services",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "90578F46460B7C4530BE801CFE5CB9A1",
"description": "Movies 2",
"code": "Movies 2",
"alternative_code": "m2"
}
}
],
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"start_date": "2016-07-28T10:00:00",
"udf_date_4": null,
"requested_expenses_set": [
{
"id": "9B10B1ED50B04A0FA6065EB04E78D985",
"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": "740740215DE842E296529F1034DF84AB",
"description": "Expence 3",
"code": "Expence 3",
"alternative_code": "exp3"
}
}
],
"rating_state": "PENDING",
"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,
"description": "Cancel Services Bronze and Movies 2",
"category": null
}
}
HTTP Method: POST
Request:
Body:
{
"token":"78281A2382CC4F22B122A4DEC76F388E",
"type_identifier":{"name":"Cancel subscription services"},
"status_identifier": {"name":"To be Approved"},
"accounts_receivable_identifier":{"number":"ACR001143"},
"subscription_identifier":{"number":"S60999"},
"contact_email":"m_antoniadou@crm.com",
"contact_phone":"9965321",
"start_date":"2016-07-26T17:00:00",
"estimated_completion_time":
{
"time_period_value":2,
"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-26T17:00:00"
},
"assigned_to":
{
"unit_identifier":{"name":"Admin Unit"}
},
"requested_subscription_services_set":
[
{
"service_identifier":{"code":"Movies 1"}
},
{
"service_identifier":{"code":"Cartoons 2"}
}
],
"requested_expenses_set":
[
{
"product_identifier":{"code":"Expence 3"}
}
],
"fields_set":"id,number,description,life_cycle_state,rating_state,type,status,subscription,time_to_completion,requested_subscription_services_set,requested_expenses_set"
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"requested_subscription_services_set": [
{
"product_bundle": null,
"swap_product": null,
"provisioning_distributor": null,
"id": "B290879B8A3F4F35891EFCE8B82B0F18",
"product": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "600438B64B0F05AB3D020C902674949F",
"name": "Subscription services",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "5B3841D63F6CAE5973366EEAFF3444E3",
"description": "Movies 1",
"code": "Movies 1",
"alternative_code": "M1"
}
},
{
"product_bundle": null,
"swap_product": null,
"provisioning_distributor": null,
"id": "00A82B1C84BF49C086C77AE6D56D6EB3",
"product": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "600438B64B0F05AB3D020C902674949F",
"name": "Subscription services",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "E3600383FF2650A594594F10BEB358D5",
"description": "Cartoons 2",
"code": "Cartoons 2",
"alternative_code": "C2"
}
}
],
"status": {
"life_cycle_state": "PENDING",
"id": "59310E86D1DD626A04102462FC3E9D1B",
"name": "To be Approved",
"description": "To be Accepted",
"alternative_code": "TBA"
},
"life_cycle_state": "PENDING",
"number": "JOB000792",
"type": {
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"fulfillment_scope": "CANCEL_SUBSCRIPTION_SERVICES",
"id": "F3E2989718864DD1BE929A6519D7C4C1",
"name": "Cancel subscription services",
"description": null,
"alternative_code": "CSS"
},
"id": "A5CA23C8472B46969447BF3E0B6AA077",
"description": null,
"subscription": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Anton",
"middle_name": "N",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Marina",
"type": "PERSON",
"id": "EE621BE231714DFE8CE370261BF6DB25",
"name": "Anton Marina",
"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": "8945612",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001143",
"id": "C88FBE77E4504F3791C219A7DCE21843",
"name": "ACR001143"
},
"number": "S60999",
"type": {
"id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
"name": "London",
"description": "Subscription for London customers",
"alternative_code": "LND"
},
"id": "3B40CE5782C341779BD151E5C1597A31",
"first_activated_date": "2016-07-07T17:23:31",
"rating_state": "PENDING"
},
"time_to_completion": {
"time_period_value": 2,
"time_period_uot": "DAYS"
},
"requested_expenses_set": [
{
"id": "1763A990A1914A78BF32B29DD4158B91",
"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": "740740215DE842E296529F1034DF84AB",
"description": "Expence 3",
"code": "Expence 3",
"alternative_code": "exp3"
}
}
],
"rating_state": "PENDING"
}
}
POST jobs/cancel_subscription_services/update
This method updates jobs of fulfillment scope Cancel Subscription Services. 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 | ||||||||||||
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. | ||||||||||||
requested_subscription_services_set (optional) | Set of Requested Subscription Service Objects | The requested subscription services of the subscription to be cancelled through the job. 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 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 form CRM.COM R13.0.0 |
scheduled_date | Date | The date on which the job is scheduled, which also indicates the date on which the Cancel Subscription Service action will be scheduled to be performed Available from CRM.COM R13.0.0 |
| 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 |
| 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 |
| subscription | Subscription Object | The subscription for which the subscription services were cancelled by the job. |
| 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 to be cancelled from the subscription. |
| 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 |
| subscription_services_set | Set of Subscription Services Objects | The subscription services that will be provided as part of the 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":"7A47C11648B9499A8903EAEA2E6D9A97",
"job_identifier":{"number":"JOB000810"},
"contact_phone":"99656565",
"estimated_completion_time":
{
"time_period_value":2,
"time_period_uot":"DAYS"
},
"physical_goods_set":
[
{
"action":"ADD",
"product_identifier":{"alternative_code":"REM"},
"quantity":1
}
],
"expenses_set":
[
{
"action":"ADD",
"product_identifier":{"code":"Expence 3"}
}
]
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"requested_physical_goods_set": [
{
"id": "9F0B214A72124F01A08DD6C4C49E93E8",
"quantity": 2,
"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": "3F01BB0B40264DF7311660F63CB2180D",
"description": "Remote Control",
"code": "Remote Control",
"alternative_code": "REM"
}
}
],
"service_request": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_float_4": null,
"udf_string_1": null,
"udf_string_2": 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_3": null,
"privacy_level": null,
"udf_string_4": null,
"udf_string_5": null,
"contact_phone": "99656565",
"udf_string_6": null,
"activities_set": [
{
"life_cycle_state": "PENDING",
"number": "ACT000792",
"type": {
"id": "F609C9D1CD43463DA810B1EC415BB5E1",
"name": "Meeting",
"description": null,
"alternative_code": "M"
},
"id": "47CF031E8ECF488591E9DA1FDC8E186A",
"contact_information": {
"last_name": "Anton",
"middle_name": "N",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Marina",
"type": "PERSON",
"id": "EE621BE231714DFE8CE370261BF6DB25",
"name": null,
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "8945612",
"industry": null,
"id_issued_by_country": null
}
}
},
{
"life_cycle_state": "PENDING",
"number": "ACT000791",
"type": {
"id": "6DFD8FD0D5024AC48750368FC39D13A8",
"name": "Demonstration",
"description": "demo",
"alternative_code": "D"
},
"id": "7BADD9F8184A432886F7EAC4CDAFFF57",
"contact_information": {
"last_name": "Anton",
"middle_name": "N",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Marina",
"type": "PERSON",
"id": "EE621BE231714DFE8CE370261BF6DB25",
"name": null,
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "8945612",
"industry": null,
"id_issued_by_country": null
}
}
}
],
"udf_string_7": null,
"physical_goods_set": [
{
"installed_item": null,
"id": "3F3ADA1EA73D4B12AF1B486EE44A5D2C",
"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": "3F01BB0B40264DF7311660F63CB2180D",
"description": "Remote Control",
"code": "Remote Control",
"alternative_code": "REM"
}
}
],
"udf_string_8": null,
"accounts_receivable": {
"account_owner": {
"last_name": "Anton",
"middle_name": "N",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Marina",
"type": "PERSON",
"id": "EE621BE231714DFE8CE370261BF6DB25",
"name": "Anton Marina",
"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": "8945612",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001183",
"id": "05924503D2054355B48BAB24646F9AC5",
"name": "ACR001183"
},
"id": "E1298733481F45858A2B39BA03B44C44",
"subscription": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Anton",
"middle_name": "N",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Marina",
"type": "PERSON",
"id": "EE621BE231714DFE8CE370261BF6DB25",
"name": "Anton Marina",
"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": "8945612",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001183",
"id": "05924503D2054355B48BAB24646F9AC5",
"name": "ACR001183"
},
"number": "S61011",
"type": {
"id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
"name": "London",
"description": "Subscription for London customers",
"alternative_code": "LND"
},
"id": "41248290B58647A5993DE4380B0A7763",
"first_activated_date": "2016-07-28T11:17:45",
"rating_state": "PENDING"
},
"requested_activity_services_set": [
{
"activity_type": {
"id": "F609C9D1CD43463DA810B1EC415BB5E1",
"name": "Meeting",
"description": null,
"alternative_code": "M"
},
"id": "62980FE3F90C407AB1014F457FCA6F64",
"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": "28709F00389D79015AF4511B4A1BDFF6",
"description": "Meeting Fees",
"code": "MFee",
"alternative_code": "MFee"
}
},
{
"activity_type": {
"id": "6DFD8FD0D5024AC48750368FC39D13A8",
"name": "Demonstration",
"description": "demo",
"alternative_code": "D"
},
"id": "F07931030F8F4CD989FC704EA5A4C812",
"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"
}
}
],
"expected_completion_date": "2016-07-30T10:00:00",
"time_to_completion": {
"time_period_value": 2,
"time_period_uot": "DAYS"
},
"time_overdue": {
"time_period_value": null,
"time_period_uot": null
},
"log_information": {
"updated_date": "2016-07-28T12:07:37",
"created_date": "2016-07-28T11:21:38",
"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": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"life_cycle_state": "IN_PROGRESS",
"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
},
"type": {
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"fulfillment_scope": "CANCEL_SUBSCRIPTION_SERVICES",
"id": "F3E2989718864DD1BE929A6519D7C4C1",
"name": "Cancel subscription services",
"description": null,
"alternative_code": "CSS"
},
"contact_email": "m_antoniadou@crm.com",
"expenses_set": [
{
"id": "D0B419D34474434EBBA27FAAFA7A9EA6",
"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": "740740215DE842E296529F1034DF84AB",
"description": "Expence 3",
"code": "Expence 3",
"alternative_code": "exp3"
}
}
],
"notes": null,
"billing_terms": {
"binding_information": null,
"agreement_date": "2016-07-28T00: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-28T00:00:00",
"billing_frequency": null,
"id": "88420C44710443EFA79AAE0499CD1FE8",
"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
}
},
"number": "JOB000810",
"estimated_completion_time": {
"time_period_value": 2,
"time_period_uot": "DAYS"
},
"requested_subscription_services_set": [
{
"product_bundle": null,
"swap_product": null,
"provisioning_distributor": null,
"id": "36CADC26207A4EE3B1E67BFA689D9DBC",
"product": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "600438B64B0F05AB3D020C902674949F",
"name": "Subscription services",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "90578F46460B7C4530BE801CFE5CB9A1",
"description": "Movies 2",
"code": "Movies 2",
"alternative_code": "m2"
}
},
{
"product_bundle": null,
"swap_product": null,
"provisioning_distributor": null,
"id": "80638907E0C141AA83DCB60899A3E8D2",
"product": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "B18BD7B80DEF66E61ED3FBE4523F5383",
"name": "Termed - Flat",
"description": "Termed - Flat",
"alternative_code": "TS"
},
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"description": "Bronze Premium Package",
"code": "Bronze",
"alternative_code": "BP"
}
}
],
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"start_date": "2016-07-28T10:00:00",
"udf_date_4": null,
"requested_expenses_set": [
{
"id": "9B10B1ED50B04A0FA6065EB04E78D985",
"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": "740740215DE842E296529F1034DF84AB",
"description": "Expence 3",
"code": "Expence 3",
"alternative_code": "exp3"
}
}
],
"rating_state": "PENDING",
"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,
"description": "Cancel Services Bronze and Movies 2",
"category": null
}
}