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_state
expiration_dateDate

The date on which the job expires.

Tip

Available form CRM.COM R13.0.0

scheduled_date

Date

The date on which the job is scheduled, which also indicates the date on which the Cancel Subscription Service action will be scheduled to be performed

Tip

Available from CRM.COM R13.0.0

 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_toAssign ObjectThe assignment information of the retrieved job
typeJob type objectThe type information of the retrieved job
billing_termsJobs Billing Terms ObjectThe billing terms of the retrieved job
statusJob Status objectThe status information of the retrieved job
categoryJob Category objectThe category of the retrieved job
subscriptionSubscription Object

The subscription for which the subscription services were cancelled by the job.

service_requestService Request Object

The service request that was related with the retrieved job.

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_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 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 to be cancelled from the subscription.

requested_physical_goods_setSet of Requested Physical Goods Objects

The physical goods that were requested by the retrieved job

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.

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_set

Set of Bill Objects

A set of bills that were generated by the billing engine in relation to the specific job

 

Anchor
job referred objects
job referred objects
Referred Objects Response Data

...

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
price_plan_short
price_plan_short

Include Page
address_short
address_short

...

Include Page
activity_short
activity_short

Include Page
bill_short
bill_short

Include Page
log_information_short
log_information_short