Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Price Plan Object

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

The supported options are

  • PENDING
  • COMPLETED
amount_to_be_paid_through_wallet Float

The amount that the customer was intending to use from his wallet in order to pay for the specific job

amount_already_paidFloat

The amount that was already paid for that job, calculated dynamically based on the payments that were submitted against that job

items_receipt_method String

 Determines if the customer prefers the job physical goods to be send to him at the specified delivery address, to pick them up from a specific unit or in any other way

The supported options are

  • DELIVERY
  • PICK_UP
  • ELECTRONIC_DELIVERY

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

The service request that was related to 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_plan

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

locationAddress ObjectThe physical location that the job should be performed and delivered to
cancellation_reasonJobs Cancellation Object

The reason that the job was canceled. This is applicable only if the job is on a canceled life cycle state

owned_by_groupGroup ObjectThe group that is owning the job
privacy_levelPrivacy Level ObjectThe job privacy level
cloned_jobJob Object

The job that was cloned in order to create the new job

This is applicable only if the job is a clone of another job

pick_up_unit

 Unit object

The identifier of the unit that the customer requested to pick up the job physical goods from

Applicable only if the items_receipt_method is set as PICK_UP

requested_milestones_set

Set of Milestone Objects

A set of milestones that were reached in relation to the specific job

physical_goods_setSet of Requested Ordered Physical Goods Objects

The physical goods that were requested by the retrieved job

requested_expenses_setSet of Requested Ordered Expenses Objects

The expenses that were requested by the retrieved job

requested_activity_services_setSet of Requested Ordered Activity Services Objects

The activity services that were requested by the retrieved job

physicalsubscriptions_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 Ordered Subscription and Subscription Action Object

The subscription and subscription actions that were requested by the retrieved job

log_information

Log Information Object

The log information related to the retrieved job

...

Include Page
job_category_short
job_category_short
Include Page
service_request_shortservice_request_short

Include Page
time_period_short
time_period_short

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
price_plan_shortprice_plan_short
Include Page
address_short
address_short

...

Include Page
privacy_level_short
privacy_level_short

Include Page
jobunit_shortjob
unit_short

Include Page
unitjob_milestones_shortunit
job_milestones_short

Include Page
jobjobs_requested_physical_goods_shortjob_requested
jobs_physical_goods_short

Include Page
jobjobs_requested_expenses_shortjob_requested
jobs_expenses_short

Include Page
jobjobs_requested_activity_services_shortjob
jobs_requested_activity_services_short

Include Page
jobjobs_physical_goodssubscriptions_shortjob_physical_goods_short
Include Page
job_expense_shortjob_expense_short
Include Page
activity_short
activity_short
Include Page
bill_shortbilljobs_subscriptions_short

Include Page
log_information_short
log_information_short