Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Type

Description

id

String

The ID of the retrieved job

number

String

The number of the retrieved job 

descriptionStringThe description of the retrieved job 
notesStringThe notes of the retrieved job
contact_emailString

The email of the customer related with the retrieved job, which will be used in order to communicate the job


contact_phoneString

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_dateDateThe date that the job is created
expected_completion_dateDateThe date that the job is expected to be completed
actual_completed_dateDateThe date that the job is actually completed
rating_stateString 

The rating state of the job that can be PENDING or COMPLETED

Tip

Available from CRM.COM R9.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

assigned_toAssign ObjectThe assignment information of the retrieved job
typeJob type objectThe type information of the retrieved job
requested_subscription_typeSubscription 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_termsJobs Billing Terms ObjectThe billing terms of the retrieved job
requested_subscription_billing_termsSubscription 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


statusJob Status objectThe status information of the retrieved job
categoryJob Category objectThe category of the retrieved job
subscriptionSubscription 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_requestService Request Object

The service request that was related with the retrieved job.

Tip

Available from CRM.COM R7.0.0

estimated_completion_timeTime Period ObjectThe time that is estimated to complete the job, measured in minutes, hours, days, weeks, years
time_to_completionTime Period ObjectThe time that is left up to the expected completion date
time_overdueTime Period ObjectThe time past the expected completion date

accounts_receivable

Accounts Receivable object

The accounts receivable related with the specified job

pricing_agreementPricing Agreement _price_planPrice 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 and/or Usage Service Catalog was agreed as part of a special pricing agreement

Applicable for Accounts Receivables that are members in the related Corporate Account Group as well

Tip

Available from CRM.COM R14.0.0

locationAddress ObjectThe physical location that the job should be performed and delivered to
cancellation_reasonJobs 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_groupGroup objectThe group that is owning the job
privacy_levelPrivacy level objectThe job privacy level

log_information

Log Information Object

The log information related with the retrieved job

requested_subscription_services_setSet 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

 

Tip

Information is available for Swap Subscription Services job from CRM.COM R9.0.0


requested_physical_goods_setSet of Requested Physical Goods Objects

The physical goods that were requested by the retrieved job

 

requested_subscription_physical_goods_setSet 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.

 

Tip

Information is available in Swap Subscription Installed Items jobs too from CRM.COM R9.0.0

requested_expenses_setSet of Requested Expenses Objects

The expenses that were requested by the retrieved job

 

requested_activity_services_setSet of Requested Activity Services Objects

The activity services that were requested by the retrieved job

 

subscription_services_setSet 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_setSet 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_setSet of Physical Goods Objects

The physical goods that will be provided as part of the job

 

expenses_setSet of Expense ObjectsA list of one time services which are applied on the job as expenses
activities_setSet of Activity ObjectsA set of activities which are planned for the specific job
bills_setSet of Bill ObjectsA set of bills that were generated by the billing engine in relation to the specific job

...

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
pricingprice_plan_agreementshortpricing
price_plan_agreementshort

Include Page
address_short
address_short

...