Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Available from CRM.COM R15.0.0
NameType 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

descriptionStringA 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

Tip
billing_directiveString

The billing directive of the retrieved job type. The supported billing directives are the following:

BILLABLE or NOT_BILLABLE

fulfillment_scopeString

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

Tip

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

Tip

The following fulfillment scopes will be available from CRM.COM R9.0.0

SWAP_SUBSCRIPTION_INSTALLED_ITEMS, SWAP_SUBSCRIPTION_SERVICES 

Tip

The following fulfillment scope will be available from CRM.COM R11.0.0

REPLACE_PHYSICAL_GOODS 

Tip

The following fulfillment scope will be available from CRM.COM R13.0.0

SUBSCRIPTION_MAINTAINANCE

fulfillment_methodString

The fulfillment method of the retrieved job type. The supported fulfillment methods are the following:

BASED_ON_ORDERED_ITEMS, BASED_ON_DELIVERED_ITEMS

Tip

BASED_ON_DELIVERED_ITEMS not applicable for SUBSCRIPTION_MAINTENANCE jobs.

billing_methodString

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.

Tip

Available from CRM.COM R10.0.0

expiration_settingsString

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
Tip

Available from CRM.COM R13.0.0

expiration_daysNumber

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.

Tip

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_timeTime Period ObjectThe time that is estimated to be required in order complete jobs of this type, measured in minutes, hours, days, weeks, years
subscription_typeSubscription Type ObjectThe 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_schemeBilling Term Scheme ObjectThe 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_schemeBilling Term Scheme ObjectThe 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_informationLog Information ObjectThe log information of the retrieved job type

...