Work Order

 
Field
Type
Value
Purpose
entity_id Field int Unique identifier
service_buyer Array of objects

Inner fields:

id

address

agreements

Service Buyer user who was Project Creator for the parent project of work order. Identified by user ID, contains address data and user agreements as a compliance part of the work order
service_provider Array of objects

Inner fields:

id

address

agreements

Service Provider user who was Service Buyer for the parent project of work order. Identified by user ID, contains address data and user agreements as a compliance part of the work order
status Field

0 - New

1 - Open

2 - Invoiced

3 - Received

Work order has its own workflow:

New - just create

Open  - mixed items in the work order (some invoiced, some not)

Invoiced - all items were invoiced

Received - all items were receieved

approved_status Field 1 or 0

1 - all approvers have performed approval

0 - not all Open  - mixed items in the work order

work_order_start_date Field datetime in UTC+0 The reference date for the work order to start. Doesn't directly affect the work order status
work_order_end_date Field datetime in UTC+0 The reference date for the work order to end. Doesn't directly affect the work order status
business_function Field String with comma-separated category IDs Categories of business functions taxonomy of the parent project for the work order
business_industry Field String with comma-separated category IDs Categories of business industry taxonomy of the parent project for the work order
business_metro_area Field String with comma-separated category IDs  Categories of business region taxonomy of the parent project for the work order
project_cost_tier Field

1 - Up to $999
2 - $1,000 to $9,999
3 - $10,000 - $49,999
4 - $50,000 - $149,999
5 - $150,000 and above

Tier is based on total of work order
project_description Field text

Parent project description

project_name Field varchar

Parent project name

grand_total Field decimal Total of all service items in the current work order
approvers Array of objects

Inner fields:

company_id

customer_id

link_id

role_id

status

name

image_url

  1. Project Creator & Service Provider (role_id=1 & role_id=4)
  2. All Project Watchers and Project Apprrovers (role_id=3 & role_id=2)
  3. Any additional approvers (role_id=3)  added from any side

Status indicates whether a particular approver has approved the work order for invoicing

 

work_order_options Array of objects

Inner fields:

quote_option_id

quote_id

invoice_status

from_project

product_id

type

uom

units_qty

price

title

 

Service items of the work order.

Each service item has one of the following possible types:

  • Deliverable
  • Milestone
  • Service
  • Resource

Each service item has one of the following Units of Measure:

  • Hour
  • Day
  • Week
  • Month
  • Each

Each service item has a fixed price that is multiplied by entered unit quantity. That creates a row total. The grand total of work order is a sum of row totals.

Service item invoice_status field defines whether or not it is possible to create an invoice for the item. 0 means it is possible, 1 - invoice was already created for the service item.

Work order can be expanded with any amount of extra service items, but it is not possible to delete the items which originate in the parent project for the work order.

The rest of fields are used to properly relate the items to other entities

 

Was this article helpful?

0 out of 0 found this helpful