FLfleetio
Work Orders

Create Work Order

Changed on

Creates a new work order.

post/work_orders

Request

Request body

issued_atstring date-time required

The date and time at which this Work Order was issued. We recommend using ISO-8601 formatted dates to avoid ambiguity.

started_atstring date-time

The date and time at which this Work Order was started. We recommend using ISO-8601 formatted dates to avoid ambiguity.

completed_atstring date-time

The date and time at which this Work Order was completed. We recommend using ISO-8601 formatted dates to avoid ambiguity.

work_order_status_idinteger required
invoice_numberstring

The number of the Invoice associated with this Work Order.

vendor_idinteger nullable
vendor_namestring

The name of the Vendor associated with this Work Order.

vehicle_idinteger required
vehicle_namestring

The name of the Vehicle associated with this Work Order.

discount_type'percentage' | 'amount'

The type of discount applied to this Work Order.

discountnumber float

The discount amount in decimal currency units applied to this Work Order.

discount_percentagenumber float

The percentage of the discount applied to this Work Order. Used if discount_type is set to percentage.

parts_markup_percentagenumber float

The percentage of the parts markup applied to this Work Order. Used if parts_markup_type is set to percentage.

Note: Parts markup fields are only writiable for Premium tier Fleetio Plan.

parts_markup_type'fixed' | 'percentage'

The type of parts markup to apply to this record.

Note: Parts markup fields are only writiable for Premium tier Fleetio Plan.

parts_markupnumber float

The amount of the parts markup applied to this Work Order. Used if parts_markup_type is set to fixed.

Note: Parts markup fields are only writiable for Premium tier Fleetio Plan.

labor_markup_percentagenumber float

The percentage of the labor markup applied to this Work Order. Used if labor_markup_type is set to percentage.

Note: Labor markup fields are only writiable for Premium tier Fleetio Plan.

labor_markup_type'fixed' | 'percentage'

The type of labor markup to apply to this record.

Note: Labor markup fields are only writiable for Premium tier Fleetio Plan.

labor_markupnumber float

The amount of the labor markup applied to this Work Order. Used if labor_markup_type is set to fixed.

Note: Labor markup fields are only writiable for Premium tier Fleetio Plan.

tax_1_percentagenumber float

The percentage of the first tax applied to this Work Order. Used if tax_1_type is set to percentage.

tax_1_type'fixed' | 'percentage' nullable

The type of tax to apply to this record.

tax_1number float

The amount of the first tax applied to this Work Order. Used if tax_1_type is set to amount.

tax_2_percentagenumber float

The percentage of the second tax applied to this Work Order. Used if tax_2_type is set to percentage.

tax_2_type'fixed' | 'percentage' nullable

The type of tax to apply to this record.

tax_2number float

The amount of the second tax applied to this Work Order. Used if tax_2_type is set to amount.

issued_by_idinteger nullable
contact_idinteger nullable
label_liststring

A comma separated list of tags associated with this record. The only delimiter allowed is a comma (,). Please remove any commas from your labels before saving the record.

purchase_order_numberstring

The number of the Purchase Order associated with this Work Order.

descriptionstring

A description of this Work Order.

numberinteger

The number to be applied to this Work Order. Must be unique.

custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

ending_meter_same_as_startboolean

Use start meter for completion meter?

vmrs_repair_priority_class_idinteger nullable
scheduled_atstring date-time

The date and time at which this Work Order is scheduled. We recommend using ISO-8601 formatted dates to avoid ambiguity.

expected_completed_atstring date-time

The date and time at which this Work Order is expected to be completed. We recommend using ISO-8601 formatted dates to avoid ambiguity.

issue_idsNullableId[]

A list of Issues to be added to this Work Order.

label_idsNullableId[]

A list of Labels to be added to this Work Order.

auto_link_inspection_line_itemsboolean

When true, any new Service Task Line Item in the request whose Service Task has a linked Inspection Form automatically gets a corresponding Inspection Form Sub Line Item, provided the work order's asset has an active Inspection Schedule for that form. Auto-linked inspections are returned under work_order_sub_line_items.

Example request

{
  "issued_at": "2023-03-14T13:46:27-06:00",
  "started_at": "2023-03-14T13:46:27-06:00",
  "completed_at": "2023-03-14T13:46:27-06:00",
  "label_list": "High Priority",
  "meter_entry_attributes": {
    "value": 108043
  },
  "secondary_meter_entry_attributes": {
    "value": 108043
  },
  "starting_meter_entry_attributes": {
    "value": 108043
  },
  "ending_meter_entry_attributes": {
    "value": 108043
  },
  "starting_secondary_meter_entry_attributes": {
    "value": 108043
  },
  "ending_secondary_meter_entry_attributes": {
    "value": 108043
  }
}

Response

OK

idinteger required
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

numberstring required

The unique number of this Work Order.

completed_atstring date-time nullable required

The date and time at which the Work Order was completed.

descriptionstring nullable required

A description of this Work Order.

ending_meter_same_as_startboolean required

Indicates whether or not the ending meter is the same as the starting meter.

duration_in_secondsinteger nullable required

The number of seconds elapsed between beginning this Work Order and completing it.

invoice_numberstring nullable required

The number of the Invoice associated with this Work Order.

created_by_idinteger required

The id of the User who created this Work Order.

state'active' | 'completed' required

Indicates whether this Work Order is currently active or has already been completed.

issued_atstring date-time required

The date and time at which the Work Order was issued.

issued_by_idinteger nullable required
issued_by_namestring nullable required

The name of the Contact associated with the User who issued this Work Order.

contact_idinteger nullable required
contact_namestring nullable required

The name of the Contact currently assigned to this Work Order.

purchase_order_numberstring nullable required

The number of any Purchase Order associated with this Work Order.

started_atstring date-time nullable required

The date and time at which the Work Order was started.

expected_completed_atstring date-time nullable

The date and time at which the Work Order is expected to be completed.

contact_image_urlstring nullable

The URL of the image associated with the Contact currently assigned to this Work Order.

scheduled_atstring date-time nullable required

The date and time at which the Work Order was scheduled.

vehicle_idinteger required
vehicle_namestring required

The name of the Vehicle associated with this Work Order.

vendor_idinteger nullable required
vendor_namestring nullable required

The name of the Vendor associated with this Work Order.

work_order_status_idinteger required
work_order_status_namestring required

The name of the Work Order Status associated with this Work Order.

work_order_status_colorstring nullable required

The color of the Work Order Status seen in the UI.

custom_fieldsCustomFields nullable required

*Full details on working with Custom Fields here.

watchers_countinteger

The number of Users watching this Work Order.

is_watchedboolean

Indicates whether the current User is watching this Work Order.

discount_type'fixed' | 'percentage' nullable required

The type of discount applied to this record.

discount_percentagenumber float nullable required

The discount percentage. This field should be present when discount_type is set to percentage.

discountnumber float nullable required

The discount amount.

parts_subtotalnumber float nullable required

The total cost of parts for this record.

labor_subtotalnumber float nullable required

The total cost of labor for this record.

subtotalnumber float nullable required

The pre-tax subtotal amount.

tax_1_type'fixed' | 'percentage' nullable required

The type of tax to apply to this record.

tax_1_percentagenumber float nullable required

The primary tax percentage amount. This field should be present when tax_1_type is set to percentage.

tax_2_type'fixed' | 'percentage' nullable required

The type of tax to apply to this record.

tax_2_percentagenumber float nullable required

The secondary tax percentage amount. This field should be present when tax_2_type is set to percentage. Note that this secondary tax must be configured in your Account Settings.

tax_1number float nullable required

The primary tax amount.

tax_2number float nullable required

The secondary tax amount. Note that this secondary tax must be configured in your Account Settings.

parts_markup_type'fixed' | 'percentage'

The type of parts markup applied to the record Note that this is a readonly value that will default to percentage for non-premium plans

parts_markupnumber float

The parts markup amount. Note that this is a readonly value that will default to 0.0 for non-premium plans

parts_markup_percentagenumber float

The parts markup percentage amount. This field should be present when parts_markup_type is set to percentage.

Note that this is a readonly value that will default to 0.0 for non-premium plans

labor_markup_type'fixed' | 'percentage'

The type of labor markup applied to the record Note that this is a readonly value that will default to percentage for non-premium plans

labor_markupnumber float

The labor markup amount. Note that this is a readonly value that will default to 0.0 for non-premium plans

labor_markup_percentagenumber float

The labor markup percentage amount. This field should be present when labor_markup_type is set to percentage.

Note that this is a readonly value that will default to 0.0 for non-premium plans

total_amountnumber float nullable required

The total amount.

labor_time_in_secondsinteger nullable

The sum, in seconds, of the duration of all labor line items of a completed Work Order.

comments_countinteger

The number of comments made on this record.

images_countinteger

The number of images attached to this record.

documents_countinteger

The number of documents attached to this record.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "completed_at": "2023-03-14T13:46:27-06:00",
  "issued_at": "2023-03-14T13:46:27-06:00",
  "started_at": "2023-03-14T13:46:27-06:00",
  "expected_completed_at": "2023-03-14T13:46:27-06:00",
  "work_order_sub_line_items": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "contact": {
        "group_hierarchy": "Group 1|Group 2|Group 3",
        "birth_date": "2023-03-14",
        "street_address": "123 Main St",
        "street_address_line_2": "Apt 1",
        "license_expiration": "2023-03-14"
      },
      "labor_time_entries": [
        {
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00",
          "ended_at": "2023-03-14T13:46:27-06:00",
          "started_at": "2023-03-14T13:46:27-06:00"
        }
      ]
    }
  ],
  "scheduled_at": "2023-03-14T13:46:27-06:00",
  "work_order_line_items": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "work_order_sub_line_items": [
        {
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00",
          "contact": {
            "group_hierarchy": "Group 1|Group 2|Group 3",
            "birth_date": "2023-03-14",
            "street_address": "123 Main St",
            "street_address_line_2": "Apt 1",
            "license_expiration": "2023-03-14"
          },
          "labor_time_entries": [
            {
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00",
              "ended_at": "2023-03-14T13:46:27-06:00",
              "started_at": "2023-03-14T13:46:27-06:00"
            }
          ]
        }
      ],
      "subtotal": 1.23,
      "labor_cost": 1.23,
      "parts_cost": 1.23
    }
  ],
  "labor_time_entries": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "ended_at": "2023-03-14T13:46:27-06:00",
      "started_at": "2023-03-14T13:46:27-06:00"
    }
  ],
  "meter_entry": {
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "date": "2023-03-14"
  },
  "starting_meter_entry": {
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "date": "2023-03-14"
  },
  "ending_meter_entry": {
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "date": "2023-03-14"
  },
  "secondary_meter_entry": {
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "date": "2023-03-14"
  },
  "starting_secondary_meter_entry": {
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "date": "2023-03-14"
  },
  "ending_secondary_meter_entry": {
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "date": "2023-03-14"
  },
  "discount_percentage": 1.23,
  "discount": 1.23,
  "parts_subtotal": 1.23,
  "labor_subtotal": 1.23,
  "subtotal": 1.23,
  "tax_1_percentage": 1.23,
  "tax_2_percentage": 1.23,
  "tax_1": 1.23,
  "tax_2": 1.23,
  "parts_markup": 1.23,
  "parts_markup_percentage": 1.23,
  "labor_markup": 1.23,
  "labor_markup_percentage": 1.23,
  "total_amount": 1.23,
  "comments": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  ],
  "images": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  ],
  "documents": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  ]
}

Changes

  • 49558d744bd7Revision changes
    • warning

      the // request property's maxLength was set to 100000

    • warning

      the request property's maxLength was set to 100000

    • warning

      the // request property's maxLength was set to 100000

    • warning

      the //// request property's maxLength was set to 100000

    • warning

      the //// request property's maxLength was set to 100000

    • warning

      the //// request property's maxLength was set to 100000

    • warning

      the // request property's maxLength was set to 100000

    • info

      added the new optional request property

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added to the //// response property anyOf list for the response status

    • info

      added to the // response property anyOf list for the response status

  • 6daa53a03224Revision changes
    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property //////// to the response with the status