WorkOrder

Property NameProperty ValueProperty Description
NumberStringGets a work order number. Automatically generated if not supplied automatically. Max Length=32
TypeCategoryWOType enumeration memberType: Unknown, Basic, PMRM(Preventive Maintenance/Routine Maintenance), Turn, Request. It determines behavior of the work order during its lifecycle. Is required.
WorkOrderCost{WorkOrderCost entity reference}WO Invoice. Financial Record represents Work Order's data related to financial side of the workflow: costs tracking, vendor invoice, service fees etc.
Priority{WoPriority entity reference}It indicates the urgency level of the work order.
StatusIdWorkOrderStatus enumeration memberStatus: Unknown, Open, Paused, Cancelled, Closed, Attention, New, OnHold, InProgress, Completed
RequestorContact{Contact entity reference}Requestor contact data
AccessPTEType enumeration memberAccess: Unknown, PTE, Appointment, CallFirst, NotApplicable
MainAsset{Location entity reference}Asset representing main WO location
ShortLocationStringShortened asset inventory location for display purposes. Max Length=128
TaskRefinementStringContains work description for the Work Order. This value is automatically generated or entered by user manually. Max Length=512
WorkZone{WorkZone entity reference}NonUpdatable. Specifies an area in which service is provided
Employee{Employee entity reference}NonUpdatable. Primary technician responsible for executing of the work order
DurationIntegerExpected duration for the work related to this work order in minutes.
VendorNte{MoneyValue entity reference}NTE (Not to Exceed) for vendor invoice.
Specialty{Specialty entity reference}Specifies what type of work needs to be done for this work order
PoNumberStringPurchase Order Number. Max Length=50
SubType{WorkOrderType entity reference}Work order custom type. Each custom type corresponds to one of the base work order type. References table [vlangWOTypeLookup]. Is required.
RepairCode{RepairCode entity reference}Repair codes are a means of gathering completion data in the field. These codes are not limited to repair data. It can be customized and used to capture whatever kind of information that is most useful for organization to collect.
Customer{Customer entity reference}Customer. Is required.
ContactNameStringContact name. Max Length=256
WonIdIntegerWON (Work Order Network) Id.
IsWarrantyBoolean"True" means WO might be covered by provider's warranty.
Flag{WoActionReasonLookup entity reference}Action Reason. References table [WOActionReasonLookup]
FlagIdIntegerAction Reason ID.
TimeZoneIntegerTime Zone
CurrencyTypeIdCurrencyType enumeration memberCurrency Type
LastActionDateDateTimeLast Action Date
DtCreatedDateTimeDate the work order was created. If not specified will be Now().
DtScheduledStartDateTime or NULLWork Order scheduled start time
DtDueDateTime or NULLLocal time indicating moment when WO becomes overdue; Computed based on work zone settings and WO priority (which makes it dependent on WO items); can be overridden by end user
DtAcknowledgeByDateTime or NULLLocal time indicating moment by which WO needs to be "acknowledged", i.e. picked up; NULL means value is undefined.
AcknowledgeByUtcDateTime or NULLUTC time indicating moment by which WO needs to be "acknowledged", i.e. picked up; NULL means value is undefined.
LastActionDateUtcDateTimeLast Action Date Utc
CreatedDateUtcDateTimeDate Utc the work order was created. If not specified will be UtcNow().
ScheduledStartUtcDateTime or NULLWork Order scheduled Utc start time. If not specified will be UtcNow().
DueDateUtcDateTime or NULLUtc time indicating moment when WO becomes overdue
DtOnSiteByDateTime or NULLLocal time indicating moment by which WO needs to be "responded to", i.e. started; Computed based on WO priority (which makes it dependent on WO items); can be overridden by end user.
DtUtcOnSiteByDateTime or NULLUtc time indicating moment by which WO needs to be "responded to", i.e. started
LastAction{WoLastAction entity reference}Last Action. WO Shadow record.
Address{Address2 entity reference}Address
Items[{WoItem entity reference}, ...]Work order tasks.
EquipmentWorkedOn[{WoEquipment entity reference}, ...]Equipment
Notes[{WoNote entity reference}, ...]Notes
CompletionNote{WoNote entity reference}Completion Note
ContactAddress{ContactInfo entity reference}Contact Address. Is required.
Assignments[{WoAssignment entity reference}, ...]Assignments
Procedures[{WoProcedure entity reference}, ...]Punch List Items
Documents[{Document entity reference}, ...]Documents
CustomFields[{CustomField2 entity reference}, ...]Custom Fields
Verifications[{WoVerification entity reference}, ...]Verifications. (WO Ratings)
Quote{WoQuote entity reference}Quote
CheckInOuts[{WoOnSite entity reference}, ...]Check In/Outs Log
ActionLogRecords[{WoActionLog entity reference}, ...]Action Logs
Estimate{WoEstimate entity reference}Customer Estimate
Owner{Employee entity reference}WO Owner
InductionAndSafetyStatusIDIsmStatus enumeration memberInduction and Safety Management(ISM) status ID, references vlangIsmStatus.ID; also matches enumeration IsmStatus. This field is not supposed to be updated directly.
Flags[{WoFlag entity reference}, ...]
WoSecondarySchedules[{WoSchedule entity reference}, ...]
ScoreIntegerWo Score
TravelTimeFromIntegerEstimated time to travel from the work order location.
TravelTimeToIntegerEstimated time to travel to the work order location.
Visits[{WoVisit entity reference}, ...]
VisitServices[{WoVisitSvc entity reference}, ...]Visit Services Data.
WoVisitCfgList[{WoVisitCfg entity reference}, ...]Visit Configuration List
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.
Properties[{PropertyTreeNode object reference}, ...]List of filled properties
LimitMultipleEntitiesNumberBehaviourBooleanReturn exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API