Page Comparison

Work Order Object Formats

Work Order Object Properties

 Required properties are in bold

{
  "Account": {
    "AccountNum": ""
  }
}

{
  "Account": {
    "AccountNum": "",
    "AccountType": "1001",
    "Addresses": [
      {
        "AddrLine1": "123 Main Street",
        "AddrLine2": "",
        "AddrLine3": "",
        "AddrLine4": "",
        "AddrType": "1001",
        "City": "McLean",
        "Country": "",
        "Intersection": "",
        "Lat": "",
        "Lon": "",
        "Region": "",
        "Zip": "22102"
      }
    ],
    "Contacts": [
      {
        "Email": "",
        "FirstName": "",
        "IsPrimary": true,
        "LastName": "",
        "Phones": [
          {
            "PhoneNum": "",
            "PhoneType": ""
          }
        ]
      }
    ],
    "Name": "Smith Home"
  }
}

Invoice

If this property is specified, then the FlexViews will be displayed on the Work Order Summary form within the mobile application.

Invoice

This optional object contains status information about generating invoice for a work order. The OrderStatus property value must be Closed complete/Closed Incomplete to enable invoice generation process.

The email address where a PDF copy of the invoice is to be emailed. Note, the invoice will only be emailed if the EmailInvoice property is true.

Identifies if the work order has been received by the mobile device. This property does not imply that the mobile worker has viewed the work order, only that it arrived on his mobile device.

If the mobile worker has previously received the work order and then it is modified by the back office, this property will automatically be reset back to false until the mobile worker receives the updated work order.

Valid values are:

• false = Invoice has not been created. This is the default value if this property is not specified.
• true = Invoice transaction was created successfully.

The email address where a PDF copy of the invoice is to be emailed. Note, the invoice will only be emailed if the EmailInvoice property is true.

• true - The work order has been received by the mobile application.
• false - The work order has not been received by the mobile

• application. This

• is the default value if the property is not present.

Specifies if the application should redact certain work order properties until it is accepted by the mobile worker. If this property is true, then the redact fields will be displayed with black bars on the mobile application. Once the mobile worker accepts the work order, then the redacted properties will automatically be reveled.

This field is used when a company is using third party mobile workers to prevent them from trying to steal the job.

Field that are redacted include:

• Account location street address
• Contact names and phone numbers
• Route mapping is disabled for this job

Valid values are:

• true - The application will redact specific work order

• properties until the mobile worker accepts the work order.
• false - The

• application will not redact any work order properties. This is the default value if the property is not present

• .

Specifies if the application should redact certain work order properties until it is accepted by the mobile worker. If this property is true, then the redact fields will be displayed with black bars on the mobile application. Once the mobile worker accepts the work order, then the redacted properties will automatically be reveled.

This field is used when a company is using third party mobile workers to prevent them from trying to steal the job.

Field that are redacted include:

• Account location street address
• Contact names and phone numbers
• Route mapping is disabled for this job

Valid values are:

• true - The application will redact specific work order properties until the mobile worker accepts the work order.
• false - The application will not redact any work order properties. This is the default value if the property is not present.

The Items collection contains line item details for the work order. Line items include parts used, parts returned, travel codes, labor codes, etc. Line items are grouped based on the line item type identified by the ProdAttrs.ProdType property.

The work order may, optionally, be pre-populated with lines items which can then be modified by the mobile worker in the field.

See: REST Object Definitions Inventory Related Objects Item Object

IVRMessageOverrides

IVRMessages

The Items collection contains line item details for the work order. Line items include parts used, parts returned, travel codes, labor codes, etc. Line items are grouped based on the line item type identified by the ProdAttrs.ProdType property.

The work order may, optionally, be pre-populated with lines items which can then be modified by the mobile worker in the field.

See: REST Object Definitions Inventory Related Objects Item Object

IVRMessageOverrides

IVRMessages

The account location identifies the actual location (address) of where the service is to be completed. For residential customers this is typically the same as the account information. However, there are cases such as in the auto insurance industry where this could be an auto body shop where a vehicle was towed after an accident. 

The Work Order API supports using managed Account Locations as well as ad-hoc Account Locations.

Managed Account Locations are those that exist in our system out side of a work order. They are managed either through our Portal Web Application or through the Account Location REST APIs. When using a manage account location, the only property that can be filled in is the LocNumber. The system will automatically expand this object with the existing account location information.

Ad-hoc Account Locations

When any additional properties beyond the LocationNum are specified the system assumes it is an ad-hoc account.

• The system will NOT verify the LocationNum for ad-hoc accounts
• The system will NOT create any new AccountLocation objects in the system
• The account location information is passed straight through to the mobile 

See: REST Object Definitions Account Location Related Objects Account Location Object

The optional MaxDiscounts object set limits on the maximum amount of discount that can be offered.

See: REST Object Definitions Work Order Activity Related Objects

The account location identifies the actual location (address) of where the service is to be completed. For residential customers this is typically the same as the account information. However, there are cases such as in the auto insurance industry where this could be an auto body shop where a vehicle was towed after an accident. 

The Work Order API supports using managed Account Locations as well as ad-hoc Account Locations.

Managed Account Locations are those that exist in our system out side of a work order. They are managed either through our Portal Web Application or through the Account Location REST APIs. When using a manage account location, the only property that can be filled in is the LocNumber. The system will automatically expand this object with the existing account location information.

Ad-hoc Account Locations

When any additional properties beyond the LocationNum are specified the system assumes it is an ad-hoc account.

• The system will NOT verify the LocationNum for ad-hoc accounts
• The system will NOT create any new AccountLocation objects in the system
• The account location information is passed straight through to the mobile 

See: REST Object Definitions Account Location Related Objects Account Location Object

The optional MaxDiscounts object set limits on the maximum amount of discount that can be offered.

See: Discounts Object

The Notes object contains an optional collection of notes associated with the work order. These can be recorded by anyone involved with taking and booking the work order.

• Notes are internal and not meant to be displayed to the Customer
• Notes are not included on any estimate or invoice. Use Remarks for free form text to be provided to the Customer.
• A note can be marked as static note by setting ReadOnly flag to true.

NonTaxable

Indicates whether the work order is exempt from collecting taxes

3.19.0

The total order amount of the work order. When the work order was created this field may contain an estimate for the work to be completed. When the work is completed this field will contains the actual, adjusted, order amount.

This optional collection contains a list of parts that were ordered by the mobile worker while on site. If no parts were ordered then this collection will either not be present or be an empty collection. There will be one entry in the collection for each part ordered.

See: REST Object Definitions Work Order Activity Related Objects Discounts OrderedPart Object

• Notes are internal and not meant to be displayed to the Customer
• Notes are not included on any estimate or invoice. Use Remarks for free form text to be provided to the Customer.
• A note can be marked as static note by setting ReadOnly flag to true.

NonTaxable

Indicates whether the work order is exempt from collecting taxes

3.19.0

The total order amount of the work order. When the work order was created this field may contain an estimate for the work to be completed. When the work is completed this field will contains the actual, adjusted, order amount.

This optional collection contains a list of parts that were ordered by the mobile worker while on site. If no parts were ordered then this collection will either not be present or be an empty collection. There will be one entry in the collection for each part ordered.

See: REST Object Definitions Work Order Activity Related Objects OrderedPart Object

Identifies the current status of the work order.

Valid values are:

• 1 - New (default) 
• 6 - Enroute (Travel Started)
• 7 - Onsite
• 8 - Travel Complete (Available starting with mobile 1.10)
• 9 - Pending
• 1001 - Rejected
• 4097 - Closed / Incomplete
• 4096 - Closed / Complete

Contains a Work Order Types System Category value identifying the type of work order.

Valid values are:

• 1001 – Install (default) 
• 1002 – Inspection
• 1003 – Maintenance
• 1004 – De-Install
• 1005 – Repair
• 1006 – Demo
• 1007 – Training

Identifies the current status of the work order.

Valid values are:

• 1 - New (default) 
• 6 - Enroute (Travel Started)
• 7 - Onsite
• 8 - Travel Complete (Available starting with mobile 1.10)
• 9 - Pending
• 1001 - Rejected
• 4097 - Closed / Incomplete
• 4096 - Closed / Complete

Contains a Work Order Types System Category value identifying the type of work order.

Valid values are:

• 1001 – Install (default) 
• 1002 – Inspection
• 1003 – Maintenance
• 1004 – De-Install
• 1005 – Repair
• 1006 – Demo
• 1007 – Training

This collection contains details about photos that were captured during the work order process. Note, this collection does not contain the actual photo but rather meta data about the photo. The photo images can be accessed either by the URL property or the REST Standard REST APIs Work Order Photos REST API.

Identifies the estimated planned start date and time, in UTC format, for the work order.

Identifies the priority of the work order.

Valid values are:

• 0 (highest) - 99 (lowest)

If the work order was closed and marked incomplete, then it will contain a REST System Categories Work Order Closed-Incomplete Reasons No Follow Up Required system category value.

If the work order was closed and marked complete, then it will contain a REST System Categories Work Order Closed Complete Reasons system category value.

Notes:

• The closed-incomplete selection will only be visible if the REST System Categories Work Order Closed-Incomplete Reasons No Follow Up Required system category has been configured

If the OrderStatus property is set to 1001 (rejected), then this property will contain the reason code of why the work order was rejected. The list of available reason codes and descriptions can be provided directly within the work order object by populating the RejectReasons property or the mobile can use the default list provided by the system category.

This optional object contains the reason why the mobile worker rejected the work order.

Notes:

• The CanReject property must be true to enable reject reason selection on the device
• The REST System Categories Work Order Reject Reason Codes system category must be configured to enable reject reason selection

This optional object contains the reason why the work order was rescheduled reasons a mobile worker may select when rescheduling a work order. The CanResched property must be true to enable reschedule reason selection

If CanResched is true , and this object is not specified then the mobile device will use the default reschedule reason codes provided by the system category definitions. 

The order the reasons appear in the array are the order they will be presented to the mobile worker.

See: Reschedule Reasons System Category

Identifies if this work order represents a repeat call.

Valid values are:

• false - This is not a repeat call for the same issue. This is the default value if this property is not specified.
• true - This is a repeat call for the same issue.

Identifies if pricing should be displayed on the work order.

Valid value are:

• true - Prices will be displayed. This is the default value if this property is not specified.
• false - Prices will not be displayed on the work order.

The signatures collection contains one or more optional signatures that were digitally captured on the device at the end of the work order.

An optional collection of Task Objects to be completed by the mobile worker for the work order. Tasks can be marked as required, in which case the mobile worker will not be able to close the work order unless all required tasks have been marked completed. Tasks can optionally track time and duration.

Taxes

TimeConstraints

This object represents totals for the work order.