Name | Type | Description | ||
|---|---|---|---|---|
id | String | The ID of the retrieved job | ||
number | String | The number of the retrieved job | ||
| description | String | The description of the retrieved job | ||
| notes | String | The notes of the retrieved job | ||
| contact_email | String | The email of the customer related with the retrieved job, which will be used in order to communicate the job | ||
| contact_phone | String | 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_date | Date | The date that the job is created | ||
| expected_completion_date | Date | The date that the job is expected to be completed | ||
| actual_completed_date | Date | The date that the job is actually completed | ||
| expiration_date | Date | The date on which the job expires.
| ||
| rating_state | String | The rating state of the job that can be PENDING or 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_paid | Float | 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 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 the following:
| ||
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_to | Assign Object | The assignment information of the retrieved job | ||
| type | Job Type Object | The type information of the retrieved job | ||
| billing_terms | Jobs Billing Terms Object | The billing terms of the retrieved job | ||
| status | Job Status object | The status information of the retrieved job | ||
| category | Job Category object | The category of the retrieved job | ||
| service_request | Service Request Object | The service request that was related to the retrieved job. | ||
| estimated_completion_time | Time Period Object | The time that is estimated to complete the job, measured in minutes, hours, days, weeks, years | ||
| time_to_completion | Time Period Object | The time that is left up to the expected completion date | ||
| time_overdue | Time Period Object | The time past the expected completion date | ||
Accounts Receivable object | The accounts receivable related with the specified job | |||
| pricing_agreement_price_plan | Price 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
| ||
| location | Address Object | The physical location that the job should be performed and delivered to | ||
| cancellation_reason | Jobs 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_group | Group Object | The group that is owning the job | ||
| privacy_level | Privacy Level Object | The job privacy level | ||
| cloned_job | Job 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
| ||
Log Information Object | The log information related to the retrieved job | |||
| Unit object | The identifier of the unit that the customer requested to pick up the job physical goods from
| |||
| requested_physical_goods_set | Set of Requested Physical Goods Objects | The physical goods that were requested by the retrieved job | ||
| requested_expenses_set | Set of Requested Expenses Objects | The expenses that were requested by the retrieved job | ||
| requested_activity_services_set | Set of Requested Activity Services Objects | The activity services that were requested by the retrieved job | ||
| physical_goods_set | Set of Physical Goods Objects | The physical goods that will be provided as part of the job | ||
| expenses_set | Set of Expense Objects | A list of one time services which are applied on the job as expenses | ||
| activities_set | Set of Activity Objects | A 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 |
...