job_type_complete

Name	Type	Description
id	String	The ID of the retrieved job type
name	String	The name of the retrieved job type
alternative_code	String	The alternative code of the retrieved job type
description	String	A description of the retrieved job type
life_cycle_state	String	The life cycle state of the retrieved job type The supported values are EFFECTIVE or NOT_EFFECTIVE Available from CRM.COM R15.0.0
billing_directive	String	The billing directive of the retrieved job type. The supported billing directives are the following: BILLABLE or NOT_BILLABLE
fulfillment_scope	String	The fulfillment scope of the retrieved job type. The supported fulfillment scopes are the following: GENERIC_PURPOSE, NEW_SUBSCRIPTION, ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION, SWAP_SUBSCRIPTION_INSTALLED_ITEMS, SWAP_SUBSCRIPTION_SERVICES, REPLACE_PHYSICAL_GOODS, SUBSCRIPTION_MAINTAINANCE The following fulfillment scopes will be available from CRM.COM R8.0.0 ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION The following fulfillment scopes will be available from CRM.COM R9.0.0 SWAP_SUBSCRIPTION_INSTALLED_ITEMS, SWAP_SUBSCRIPTION_SERVICES The following fulfillment scope will be available from CRM.COM R11.0.0 REPLACE_PHYSICAL_GOODS The following fulfillment scope will be available from CRM.COM R13.0.0 SUBSCRIPTION_MAINTAINANCE
fulfillment_method	String	The fulfillment method of the retrieved job type. The supported fulfillment methods are the following: BASED_ON_ORDERED_ITEMS, BASED_ON_DELIVERED_ITEMS BASED_ON_DELIVERED_ITEMS not applicable for SUBSCRIPTION_MAINTENANCE jobs.
billing_method	String	The billing method of the retrieved job type. Applicable only for billable job types with fulfillment scope GENERIC_PURPOSE. The supported billing methods are the following: BILL_ON_STARTING_PROGRESS, BILL_ON_COMPLETION. Available from CRM.COM R10.0.0
expiration_settings	String	The expiration settings of the retrieved job type. Applicable for all fulfillment scopes and methods. The supported expiration settings are the following: NONE X_DAYS_AFTER_JOB_CREATION ON_PENDING_STATE ON_START_PROGRESS Available from CRM.COM R13.0.0
expiration_days	Number	The number of days in which jobs of the retrieved job type will get expired after their creation date. Applicable only if the job type's expiration settings is defined as X_DAYS_AFTER_JOB_CREATION. Available from CRM.COM R13.0.0
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
estimated_completion_time	Time Period Object	The time that is estimated to be required in order complete jobs of this type, measured in minutes, hours, days, weeks, years
subscription_type	Subscription Type Object	The type of subscription that will be delivered by jobs of this type. This information is available only if the fulfillment scope is set to NEW_SUBSCRIPTION
subscription_billing_term_scheme	Billing Term Scheme Object	The billing term scheme of the the subscription that will be delivered by jobs of this type. This information is available only if the fulfillment scope is set to NEW_SUBSCRIPTION
job_billing_term_scheme	Billing Term Scheme Object	The billing term scheme that will be used by jobs of this type. This information is available only if the fulfillment scope is set to NEW_SUBSCRIPTION
log_information	Log Information Object	The log information of the retrieved job type

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

subscription type object response data

Name	Type	Description
id	String	The ID of the retrieved subscription type
name	String	The name of the retrieved subscription type
alternative_code	String	The alternative code of the retrieved subscription type
description	String	A description of the retrieved subscription type
classification	String	The classification of the retrieved subscription type, Flexible or Package Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0

billing_term_scheme object response data

Name	Type	Description
id	String	The ID of the retrieved billing term scheme
code	String	The code of the retrieved billing term scheme
name	String	The name of the retrieved billing term scheme
life_cycle_state	String	The life cycle state of the retrieved billing term scheme. The supported life cycle states are the following DRAFT, EFFECTIVE, TERMINATED
classification	String	The classification of the retrieved billing term scheme which can be either NORMAL or PREPAID Classification options NORMAL and PREPAID are available from CRM.COM R15.0.0 Prior CRM.COM R15.0.0 the options are SUBSCRIPTIONS or JOBS
billing_type	String	The billing type of the billing term scheme which can be PRE_BILL or POST_BILL for NORMAL billing term schemes and PRE_RATED or POST_RATED for PREPAID billing term schemes Billing type options PRE/POST_BILL and PRE/POST_RATED are available from CRM.COM R15.0.0 Prior CRM.COM R15.0.0 the options are NORMAL and PREPAID
billing_method	String	The billing method of the billing term scheme which can be ANNIVERSARY or PERIOD

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user