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 creates a job. 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 on conditions) | Subscriptions Identifier | The identifier of the subscription that will be maintained through the new job. This information is applicable and mandatory only if the specified job type has fulfillment scope equal to ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION, SWAP_SUBSCRIPTION_INSTALLED_ITEMS, SWAP_SUBSCRIPTION_SERVICES. 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 | ||||||||||||
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 if the job type fulfillment method is set to Generic Purpose | ||||||||||||
requested_subscription_billing_terms (optional) | Subscription Billing terms object | The billing terms of the subscription that will be provided as part of the job. This information is applicable and mandatory if the job type fulfillment method is set to New Subscription | ||||||||||||
| assigned_to (mandatory on conditions) | Assigned to object | The assignment information for the job | ||||||||||||
| physical_goods_to_be_provided_set (optional) | Set of physical good to be provided objects | The physical goods that will be provided as part of the job | ||||||||||||
| expenses_set (optional) | Set of expense objects | A list of one time services which are applied on the job as expenses | ||||||||||||
| activities_set (optional) | Set of activity objects | A set of activities which are planned for the specific job | ||||||||||||
requested_subscription_services_set (mandatory on conditions) | Set of Requested Subscription Service Objects | A list of services that were requested by the customer and should be provided as part of the subscription that will be delivered. This information is applicable and mandatory only if the job type fulfillment method is set to New Subscription, Add Subscription Services, Cancel Subscription Services or Swap Subscription Services. 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 | ||||||||||||
(mandatory on conditions) | 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. | ||||||||||||
requested_subscription_physical_goods_set (mandatory on conditions) | Set of Requested Subscription Physical Good Objects | A list of physical goods (products only) that were requested by the customer and should be provided as part of the subscription that will be delivered. This information is applicable and mandatory only if the job type fulfillment method is set to New Subscription, Add Subscription Services and Swap Subscription Installed Items. The subscription physical goods are filtered based on the specified subscription type. All the subscription related rules and restrictions are applicable on the requested subscription physical goods as well | ||||||||||||
(mandatory on conditions) | 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 (mandatory on conditions) | 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 Available from CRM.COM R10.0.0 |
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 |
| 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: POST
Request:
Body:
{
"token":"739FF77CF7738B4219416AA092FA8D15",
"type_identifier":{"name":"Installation Job"},
"status_identifier":{"name":"Pending"},
"category_identifier":{"name":"Installations"},
"accounts_receivable_identifier":{"number":"330"},
"description":"tv installation",
"notes":"postponed for next month",
"start_date":"2014-11-12T15:49:59",
"location_identifier":{"type":"HOME"},
"owned_by_group_identifier":{"name":"Nicosia Office"},
"privacy_level_identifier":{"number":"61"},
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59",
"estimate_completion_time":{"time_period_value":5,"time_period_uot":"DAYS"},
"assigned_to":{"user_identifier":{"username":"MPAdministrator"}},
"activities_set":
[
{
"activity_identifier":{"number":"1"}
}
],
"physical_goods_to_be_provided_set":
[
{
"product_identifier" : { "code" : "Wires"},
"quantity" : 31
},
{
"installed_item_identifier" : { "serial_number" : "d2000000000"}
}
],
"expenses_set":
[
{
"product_identifier" : { "code" : "FEE4"}
},
{
"product_identifier" : { "code" : "FEE9"}
}
]
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"notes": "postponed for next month",
"billing_terms": null,
"udf_float_1": 10,
"udf_float_2": 20,
"udf_float_3": 30,
"number": "J00000018",
"udf_float_4": 40,
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"assigned_to":
{
"unit":
{
"group_name": null,
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
}
},
"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":
[
{
"life_cycle_state": "PENDING",
"number": "1",
"type":
{
"name": "Installations",
"id": "BF60960C7FC5B0E5B81DB7E5BCC7F140",
"description": null,
"alternative_code": "IN"
},
"id": "A384F82820398C8EEC26851EE5A11DFE",
"contact_information":
{
"last_name": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": "Andreas",
"company_profile": null,
"title": "Ms",
"type": "PERSON",
"first_name": "Lucia",
"name": "Lucia Papapavlou",
"id": "1D92B269658D80DEDF2499E25201739E",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"passport_number": "113115",
"social_security_number": "113116",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector":
{
"name": "GOVERNMENTAL",
"id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
"alternative_code": "GOV"
},
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1990
},
"name_day":
{
"month": 5,
"day": 5
},
"id_number": "113114",
"id_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"industry":
{
"name": "Interior Design",
"id": "06B638258885DA26FA2BD40D9128D04E",
"code": "INTDS"
}
}
}
}
],
"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": "A9FC958CCE090BC51650AEA5CF48AD29",
"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-11-17T15:49:59",
"start_date": "2014-11-12T15:49:59",
"udf_date_4": "2014-08-05T15:49:59",
"time_to_completion":
{
"time_period_value": 5,
"time_period_uot": "DAYS"
},
"time_overdue":
{
"time_period_value": null
},
"bills_set":
[
],
"physical_goods_to_be_provided_set":
[
{
"installed_item": null,
"quantity": 31,
"id": "86EBB22414AF089F125D2DA534100FAE",
"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": "86697663F6AC4EDFB8C6D5AC00D58FB6",
"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-11-12T10:34:18",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-11-12T10:34:17",
"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": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": null
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"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":
{
"name": "Installations",
"id": "194CA3ACB5783924488F5F7E49FE82CC",
"description": "Installations",
"code": "IN"
},
"expenses_set":
[
{
"id": "C40CDCDA4FAC98D13FBD0C838611F461",
"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
}
},
{
"id": "C877051C290BAF8B8E8E599C20F23107",
"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
}
}
]
}
}
HTTP Method: POST
Request:
Body:
{
"token":"3EEEA4A93F304D4AA81AB394507EDE82",
"type_identifier":{"name":"Swap Sub Installed Item LP"},
"status_identifier":{"name":"Assigned"},
"accounts_receivable_identifier":{"number":"ACR000852"},
"subscription_identifier":{"number":"S60692"},
"location_identifier":{"type":"HOME"},
"estimate_completion_time":{"time_period_value":5,"time_period_uot":"DAYS"},
"assigned_to":{"user_identifier":{"username":"MPAdministrator"}},
"billing_terms":{"price_plan_identifier":{"code":"BPP0614"},
"billing_term_scheme_identifier":{"code":"Jobs Scheme - Concurrent"},
"concurrent_usage_based_pricing":{"concurrent_usage":1,"rate_percentage":100}},
"requested_subscription_physical_goods_set":
[
{
"installed_item_identifier":{"serial_number":"sb20001118"}
}
]
}
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":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"udf_string_3": null,
"privacy_level": null,
"udf_string_4": null,
"udf_string_5": null,
"contact_phone": null,
"activities_set":
[
],
"udf_string_6": null,
"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": "9A87BFB77BF44CEF8C8F675926DD7EAE",
"requested_activity_services_set":
[
],
"requested_subscription_physical_goods_set":
[
{
"swap_installed_item": null,
"provisioning_distributor": null,
"installed_item":
{
"state": "EFFECTIVE",
"serial_number": "sb20001118",
"id": "BC4D9573AFD04E2EA59174AA7BE038FE",
"alternative_code": "sb20001118",
"product":
{
"product_type":
{
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": true,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"name": "Decoders",
"description": "Decoders",
"alternative_code": "D"
},
"id": "12A61F321368703D77C48A0A085D9B7D",
"description": "Decoders 2",
"code": "Decoders 2",
"alternative_code": "D2"
}
},
"id": "4E5A414F50E843659F9C05A3A170A709",
"quantity": 1,
"product":
{
"product_type":
{
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": true,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"name": "Decoders",
"description": "Decoders",
"alternative_code": "D"
},
"id": "12A61F321368703D77C48A0A085D9B7D",
"description": "Decoders 2",
"code": "Decoders 2",
"alternative_code": "D2"
}
}
],
"expected_completion_date": "2016-02-29T12:13:16",
"time_to_completion":
{
"time_period_value": 5,
"time_period_uot": "DAYS"
},
"time_overdue":
{
"time_period_value": null,
"time_period_uot": null
},
"log_information":
{
"updated_date": "2016-02-24T12:14:50",
"created_date": "2016-02-24T12:13:16",
"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": "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": "SWAP_SUB_INSTALLED_ITEMS",
"id": "6D1937BD1F1846CDA6AE994FD4C8B46F",
"name": "Swap Sub Installed Item LP",
"description": null,
"alternative_code": "Swap Sub Installed Item LP"
},
"contact_email": null,
"expenses_set":
[
],
"notes": null,
"billing_terms":
{
"binding_information": null,
"agreement_date": "2016-02-24T00:00:00",
"concurrent_usage_based_pricing":
{
"concurrent_usage": 1,
"rate_percentage": 100
},
"billing_term_scheme":
{
"life_cycle_state": "EFFECTIVE",
"billing_method": "PERIOD",
"classification": "JOBS",
"id": "1B708E843AF1497595A4EE39A1F62ED0",
"name": "Jobs Scheme - Concurrent",
"code": "Jobs Scheme - Concurrent",
"billing_type": "NORMAL"
},
"effective_date": "2016-02-24T00:00:00",
"billing_frequency": null,
"id": "8DEE60C3256642E9BD7A00DD0C218D91",
"allowed_cancel_date": null,
"expiration_date": null,
"billing_cycle_day": null,
"price_plan":
{
"effective_date": "2015-12-20T00:00:00",
"type": "BASE",
"id": "5AA9D4219DA549048AB263635CA6AD09",
"name": "BPP0614",
"description": "Base Price PLan June 14 for Subscription Test Case 6",
"code": "BPP0614",
"expiration_date": null
}
},
"number": "JOB000477",
"estimated_completion_time":
{
"time_period_value": 5,
"time_period_uot": "DAYS"
},
"requested_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": "S60692",
"type":
{
"udf_float_1": null,
"udf_float_2": null,
"udf_date_1": null,
"udf_float_3": null,
"udf_date_2": null,
"udf_float_4": null,
"udf_date_3": null,
"udf_date_4": null,
"name": "United Kingdom",
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"log_information":
{
"updated_date": "2016-01-30T09:57:23",
"created_date": "2014-06-25T15:44:04",
"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"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"udf_string_8": null,
"id": "1C81FBB1E5D90040F440ECE98D6A368D",
"description": "United Kingdom",
"alternative_code": "UK"
},
"id": "4ADBEF42548B4EF9B860B749E96C8E87"
},
"subscription_services_set":
[
{
"life_cycle_state": "EFFECTIVE",
"id": "C28C7352EBDF4B42A33B63038BF35C9A",
"service_bundle": null,
"product":
{
"product_type":
{
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "BC954969D3172372D498D3BB2BA590A0",
"name": "Subscription Packages",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
"description": "Gold Premium Package",
"code": "Gold",
"alternative_code": "GPP"
}
}
],
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"start_date": "2016-02-24T12:13:16",
"udf_date_4": null,
"bills_set":
[
],
"requested_expenses_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,
"subscription_physical_goods_set":
[
{
"ownership_status": "RENTED_TO_CUSTOMER",
"installed_item":
{
"state": "EFFECTIVE",
"serial_number": "SM0005",
"id": "BA0371AEB0AC4A259804014CBB657B94",
"alternative_code": "SM0005",
"product":
{
"product_type":
{
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"name": "Smartcards",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "EAC7A30429364176616CFEF5DF709941",
"description": "Smartcard 1",
"code": "Smartcard 1",
"alternative_code": "SC1"
}
},
"installed_item_bundle": null,
"id": "7832753D414A4C13BD823C7B7EC2CFF9"
},
{
"ownership_status": null,
"installed_item":
{
"state": "EFFECTIVE",
"serial_number": "sb20001118",
"id": "BC4D9573AFD04E2EA59174AA7BE038FE",
"alternative_code": "sb20001118",
"product":
{
"product_type":
{
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": true,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"name": "Decoders",
"description": "Decoders",
"alternative_code": "D"
},
"id": "12A61F321368703D77C48A0A085D9B7D",
"description": "Decoders 2",
"code": "Decoders 2",
"alternative_code": "D2"
}
},
"installed_item_bundle": null,
"id": "067B8687070F40A39780E737270CA9F3"
}
],
"description": null,
"category": null
}
}
HTTP Method: POST
Request:
Body:
{
"token":"3EEEA4A93F304D4AA81AB394507EDE82",
"fields_set":"requested_expenses_set,estimated_completion_time,billing_terms,assigned_to,accounts_receivable",
"type_identifier":{"name":"Installation Job"},
"status_identifier":{"name":"Draft"},
"category_identifier":{"name":"External"},
"accounts_receivable_identifier":{"number":"ACR000997"},
"description":"tv installation",
"notes":"postponed for next month",
"start_date":"2015-09-06T15:49:59",
"location_identifier":{"type":"HOME"},
"owned_by_group_identifier":{"name":"Main Group"},
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59",
"estimate_completion_time":{"time_period_value":5,"time_period_uot":"DAYS"},
"assigned_to":{"user_identifier":{"username":"MPAdministrator"}},
"activities_set":
[
{
"activity_identifier":{"number":"1"}
}
],
"billing_terms":{"price_plan_identifier":{"code":"BPP0614"},
"billing_term_scheme_identifier":{"code":"Jobs Scheme - Concurrent"},
"concurrent_usage_based_pricing":{"concurrent_usage":1,"rate_percentage":100}
},
"requested_expenses_set":
[
{
"product_identifier" : { "code" : "Expence 1"}
}
]
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"billing_terms": {
"binding_information": null,
"agreement_date": "2016-06-09T00:00:00",
"concurrent_usage_based_pricing": {
"concurrent_usage": 1,
"rate_percentage": 100
},
"billing_term_scheme": {
"life_cycle_state": "EFFECTIVE",
"billing_method": "PERIOD",
"classification": "JOBS",
"id": "1B708E843AF1497595A4EE39A1F62ED0",
"name": "Jobs Scheme - Concurrent",
"code": "Jobs Scheme - Concurrent",
"billing_type": "NORMAL"
},
"effective_date": "2016-06-09T00:00:00",
"billing_frequency": null,
"id": "A842FEA1CE1944A5A5519C4F46D05007",
"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
}
},
"accounts_receivable": {
"account_owner": {
"last_name": "Mika",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Ms",
"first_name": "Dina",
"type": "PERSON",
"id": "9ED00E7228634EF986807DF4D86A3F84",
"name": "Mika Dina",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "14587522",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000997",
"id": "ECA31D4A28C94AF4BCB15F794FFC3C27",
"name": "ACR000997"
},
"assigned_to": {
"unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"estimated_completion_time": {
"time_period_value": 9.166666666666666,
"time_period_uot": "MONTHS"
},
"requested_expenses_set": [
{
"id": "5666FD45F03F419FA80B67877E40CC3F",
"product": {
"product_type": {
"service_type": "EXPENSE",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "67FA013211E348C58F7CD27F8399AADE",
"name": "Expense Type",
"description": null,
"alternative_code": "ET"
},
"id": "2855ACFCB7D94ED69A5FC3B9557EB6D6",
"description": "Expence 1",
"code": "Expence 1",
"alternative_code": "exp1"
}
}
]
}
}