- Created by George Rossides on Jan 29, 2015
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
Version 1 Next »
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. 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:
| ||||||||||||
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:
| ||||||||||||
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. | ||||||||||||
estimate_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 (optional) | Billing terms object | The billing terms of the job to be created | ||||||||||||
| assigned_to (mandatory) | 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 |
Referred Parameter Objects Data
Name | Type | Description |
|---|---|---|
time_period_value (mandatory) | Number | The time period value |
time_period_uot (mandatory) | String | The time period unit of time The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
billing_term_scheme_identifier (mandatory) | Billing term scheme identifier | The billing term scheme that will be used on the billing terms. The allowed billing term scheme identifier fields are the following:
| |||||||||
price_plan_identifier (mandatory on conditions) | Price plan identifier | The price plan that will be used on the billing terms. The allowed price plan identifier fields are the following:
The price_plan_identifier is considered as mandatory up until CRM.COM R11.2.0. From CRM.COM R11.2.0 the identifier becomes mandatory on conditions, which means that it is mandatory only as long as no default price plan is specified in the Billing Term Scheme | |||||||||
agreement_date (mandatory) | Date | The agreement date of the billing terms that will be created. Billing terms agreement date is used to log the date that the billing terms were agreed and signed by the customer. | |||||||||
concurrent_usage_based_pricing (mandatory on conditions) | Concurrent usage based pricing object | Concurrent usage based pricing is used to apply price plan rates based on the number of concurrent usage of the services or the installed items that will be billed, and a rate percentage which is agreed between the customer and the company providing those service. Concurrent usage based pricing is applicable and mandatory only if it is supported by the billing term schemes This object is deprecated in CRM.COM R10.0.0 onwards |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
concurrent_usage (mandatory) | Number | Defines the concurrent usage of services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0 |
rate_percentage (mandatory) | Number | Defines the rate percentage that should be applied on all services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0 |
number_of_installed_items (mandatory on conditions) | Number | The agreed number of installed items that will be concurrently consuming the related subscription's services. Applicable and mandatory if concurrent usage billing method is set to "based on number of installed items". Available from CRM.COM R15.0.0 |
concurrent_usage_billing_method (mandatory) | String | Defines how the subscription will be billed for the agreed concurrent usage. Available options are:
If not specified, then the billing method is considered as "based on number of installed items". Available from CRM.COM R15.0.0 |
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| user_identifier (semi-optional) | User Identifier | The identifier of the user that the assignable entity should be assigned to. The allowed user identifier fields are the following:
| ||||||||||||
business_unit_identifier (semi-optional) | Business Unit Identifier | The identifier of the business unit that the assignable entity should be assigned to. The allowed business unit identifier fields are the following:
Available from CRM.COM R18.0.0 | ||||||||||||
unit_identifier (semi-optional) | Unit Identifier | The identifier of the unit that the assignable entity should be assigned to. The allowed unit identifier fields are the following:
Deprecated from CRM.COM R18.0.0 |
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
installed_item_identifier | Installed Item Identifier | The identifier of the installed item related with the Job Physical Good. The allowed installed item identifier fields are the following:
| ||||||||||||
product_identifier | Product Identifier | The identifier of the physical good product related with the Job Physical Good. The allowed physical good product identifier fields are the following:
| ||||||||||||
quantity | Number | The quantity of the physical good. Need to be specified only in the case when a physical good product is specified. |
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| product_identifier (mandatory) | Identifier | The identifier of the product related with the job expense. The allowed product identifier fields are the following:
|
Name | Type | Description | |||||||||
activity_identifier (mandatory) | Activity identifier | The identifier of the activity to be used. The allowed activity identifier fields are the following
|
- No labels