| Tip |
|---|
Available from CRM.COM R13.0.0 |
| Table of Contents | ||
|---|---|---|
|
GET jobs/subscription_maintenance/show
...
| Tip |
|---|
Available from CRM.COM R13.0.0 |
| Table of Contents | ||
|---|---|---|
|
GET jobs/subscription_maintenance/show
This method returns information related with a job of fulfillment scope Subscription Maintenance . A single job is returned by each call
...
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 |
...
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) | Subscription Identifier | The identifier of the subscription that will be maintained as part of the new job's fulfillment.The allowed subscription identifier fields are the following:
| ||||||
|
| |||||||
|
| |||||||
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 | ||||||
requested_billing_term_amendment (optional) | Requested Subscription Billing Term Amendments Object | The Subscription's billing terms amendments that are requested by the customer and should be perofmed on the subscription as part of fulfilling this new 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. | ||||||
requested_subscription_physical_goods_set (optional) | Set of Requested Subscription Physical Good Objects | A list of physical goods (products only) that are requested by the customer to be added on the subscription and should be delivered as part of fulfilling the ordered job. The requested physical goods are filtered based on the selected subscription's type. | ||||||
requested_subscription_services_to_be_added_set (optional) | Set of Requested Subscription Services to be added Objects | A list of services that were requested by the customer and should be provided as part of the subscription that will be updated. 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 | ||||||
requested_subscription_services_to_be_swapped_set (optional) | Set of Requested Subscription Services to be swapped Objects | A list of subscription services that were requested by the customer to be swapped 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 | ||||||
requested_subscription_expenses_set (optional) | Set of Requested Subscription Expenses Objects | A list of subscription expenses that were requested by the customer and should be provided as part of the subscription that will be updated. | ||||||
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 |
...
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
...
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 | ||||||
|
| |||||||
|
| |||||||
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_15 | String | User Defined Field of type String | ||||||
udf_string_26 | String | User Defined Field of type String | ||||||
udf_string_37 | String | User Defined Field of type String | ||||||
udf_string_48 | 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_stringfloat_5 3 | String Float | User Defined Field of type StringFloat | ||||||
udf_stringfloat_64 | String Float | User Defined Field of type StringFloat | ||||||
udf_stringdate_71 | String Date | User Defined Field of type StringDate | ||||||
udf_ | stringdate_ | 82 | StringDate | User Defined Field of type | StringDate | |||
udf_floatdate_13 | FloatDate | User Defined Field of type FloatDate | ||||||
udf_floatdate_24 | FloatDate | User Defined Field of type FloatDate | ||||||
udfexpected_floatcompletion_3date | Date | The date that the job is expected to be completed. It is automatically calculated if estimate completion time is specified. | ||||||
estimated_completion_time | Float | User Defined Field of type Float | ||||||
udf_float_4 | Float | User Defined Field of type Float | ||||||
udf_date_1 | 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) | Date | User Defined Field of type Date | udf_date_2Billing 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) | Date | User Defined Field of type Date | udf_date_3Assigned 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. | ||||
subscription_billing_term_amendments (optional) | Date | User Defined Field of type Date | udf_date_4Subscription Billing Term Amendments | The Billing term amendments that will be performed on the subscription as part of this job. This information is applicable only if the job is in progress and account owner requested billing term amendments. | ||||
(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_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_physical_goodsSet of Requested Physical Good Objects | The requested physical goods. This information is applicable only if the job is draft or pending
| |||||||
(optional) | Set of Requested Expense Objects | The requested expenses. This information is applicable only if the job is draft or pending
| ||||||
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
| ||||||
requested_subscription_physical_goods_set (optional) | Set of Requested Subscription Physical Goods | The requested subscription physical goods. This information is applicable only if the job is draft or pending
| ||||||
requested_subscription_services_to_be_added_set (optional) | Set of Requested Physical Good ObjectsSubscription Services to be added | The requested physical goodssubscription services to be added. This information is applicable only if the job is draft or pending
| ||||||
requested_expenses_subscription_services_to_be_swapped_set (optional) | Set of Requested Expense ObjectsSubscription Services to be swapped | The requested expensessubscription service to be swapped. This information is applicable only if the job is draft or pending
| ||||||
requestedrequested_subscription_activityexpense_services_set (optional) | Set of Requested Activity Subscription Service ObjectsExpenses | The requested activity subscription expense services. This information is applicable only if the job is draft or pending
| ||||||
| 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
| ||||||
| expenses_set (optional) | Set of expense objects | A list of one time expense services which are applied on the retrieved job as expenses. This information is applicable only if the job is in progress
| ||||||
subscription_physical_goods_set (optional) | Set of subscription physical goods to be provided objects | The physical goods that will be added on the subscription as part of the retrieved job. This information is applicable only if the job is in progress
| ||||||
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 |
...
| Include Page | ||||
|---|---|---|---|---|
|
fdfd
| Include Page | ||||
|---|---|---|---|---|
|
...