Skip to main content

Create Work Order

deprecated

This endpoint is deprecated and will be removed in a future version. Please use the new v2 endpoint instead.

Creates a new Work Order

Request Body

  • issued_at 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_at date-time

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

  • completed_at 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_id integer required

    Possible values: >= 1

  • work_order_status_name string

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

  • invoice_number string

    Possible values: <= 255 characters

    The number of the Invoice associated with this Work Order.

  • vendor_id integer

    Possible values: >= 1

  • vendor_name string

    Possible values: <= 255 characters

    The name of the Vendor associated with this Work Order.

  • vehicle_id integer required

    Possible values: >= 1

  • vehicle_name string

    Possible values: <= 255 characters

    The name of the Vehicle associated with this Work Order.

  • discount_type string

    Possible values: [percentage, amount]

    The type of discount applied to this Work Order.

  • discount float

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

  • discount_percentage float

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

  • tax_1_percentage float

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

  • tax_1_type string

    Possible values: [fixed, percentage]

    Default value: percentage

    The type of tax to apply to this record.

  • tax_1 float

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

  • tax_2_percentage float

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

  • tax_2_type string

    Possible values: [fixed, percentage]

    Default value: percentage

    The type of tax to apply to this record.

  • tax_2 float

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

  • issued_by_id integer

    Possible values: >= 1

  • contact_id integer

    Possible values: >= 1

  • label_list string

    Possible values: <= 255 characters

    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_number string

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

  • description string

    A description of this Work Order.

  • number integer

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

  • meter_entry_attributes object

    A Work Order may also be associated with a Meter Entry.

  • value float

    The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.

  • void boolean

    If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.

  • secondary_meter_entry_attributes object

    A Work Order may also be associated with a secondary Meter Entry.

  • value float

    The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.

  • void boolean

    If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • ending_meter_same_as_start boolean

    Use start meter for completion meter?

  • vmrs_repair_priority_class_id integer

    Possible values: >= 1

Responses

OK

Response Headers


    Schema

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • number integer

      The unique number of this Work Order.

    • completed_at date-time

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

    • description string

      A description of this Work Order.

    • ending_meter_same_as_start boolean

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

    • duration_in_seconds integer

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

    • invoice_number string

      The number of the Invoice associated with this Work Order.

    • state string

      Possible values: [active, completed]

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

    • issued_at date-time

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

    • issued_by_id NullableId

      Possible values: >= 1

    • contact_id NullableId

      Possible values: >= 1

    • purchase_order_number string

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

    • started_at date-time

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

    • work_order_type_id NullableId

      Possible values: >= 1

    • vehicle_archived_at date-time

      The date and time at which the Vehicle associated with this Work Order was archived, if applicable.

    • send_email_notification_to_assignee boolean

      Indicates whether an email notification should be sent to the assignee of this Work Order.

    • scheduled_at date-time

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

    • vehicle_id integer

      Possible values: >= 1

    • vendor_id NullableId

      Possible values: >= 1

    • work_order_status_id integer

      Possible values: >= 1

    • custom_fields object

      *Full details on working with Custom Fields here.

    • attachment_permissions object
    • read_photos boolean

      Indicates whether the user has read permission for photos.

    • manage_photos boolean

      Indicates whether the user has permission to manage (eg. upload, delete) photos.

    • read_documents boolean

      Indicates whether the user has read permission for documents.

    • manage_documents boolean

      Indicates whether the user has permission to manage (eg. upload, delete) documents.

    • is_sample boolean

      Indicates whether this Work Order is sample data.

    • created_by_id NullableId

      Possible values: >= 1

    • vmrs_repair_priority_class_id NullableId

      Possible values: >= 1

    • label_list string[]

      Possible values: <= 255 characters

      A list of tags associated with this record.

    • fees_cents integer

      The sum of subtotals for any line items of the type ServiceEntryFeeLineItem.

    • tax_free_labor boolean

      Indicates whether or not to include labor subtotals in tax calculations.

    • currency string

      Default value: USD

      The currency code used for monetary values in this Work Order.

    • labor_subtotal object

      The total cost of labor for this record.

      anyOf

    • number
    • labor_subtotal_cents int32

      The total cost of labor in cents.

    • parts_subtotal object

      The total cost of parts for this record.

      anyOf

    • number
    • parts_subtotal_cents int32

      The total cost of parts in cents.

    • discount_type DiscountType

      Possible values: [fixed, percentage]

      Default value: percentage

      The type of discount applied to this record.

    • discount_percentage object

      The discount percentage. This field should be present when discount_type

      is set to percentage.

      anyOf

    • number float
    • discount_cents object

      The discount amount in cents.

      anyOf

    • integer
    • subtotal object

      The pre-tax subtotal amount.

      anyOf

    • number float
    • subtotal_cents object

      The pre-tax subtotal amount in cents.

      anyOf

    • integer
    • tax_1_type string

      Possible values: [fixed, percentage]

      Default value: percentage

      The type of tax to apply to this record.

    • tax_1_percentage object

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

      anyOf

    • number float
    • tax_1_cents integer

      The primary tax amount in cents.

    • tax_2_type string

      Possible values: [fixed, percentage]

      Default value: percentage

      The type of tax to apply to this record.

    • tax_2_percentage object

      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.

      anyOf

    • number float
    • tax_2_cents object

      The secondary tax amount in cents.

      oneOf

    • string
    • total_amount object

      The total amount.

      anyOf

    • number
    • total_amount_cents object

      The total amount in cents.

      anyOf

    • number
    • watchers_count int32

      The count of watchers associated with the record.

    • watchable_options object

      Options related to watching the record.

    • bulk_watch_record boolean

      Indicates if a bulk watch record is created.

    • skip_automatic_watchers_callbacks boolean

      Indicates if automatic watchers callbacks are skipped.

    • is_watched boolean

      Indicates whether the record is being watched.

    • comments object[]

      A list of the comments made on this record.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • commentable_type CommentableType

      Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]

      The type of record that the Comment will be left on. Must be associated with a matching commentable_id.

    • commentable_id integer

      Possible values: >= 1

    • user_id integer

      Possible values: >= 1

    • title string deprecated

      The title of the Comment.

    • comment string

      The content of the Comment message body.

    • user_full_name string

      The full name of the User who created the Comment.

    • user_image_url string

      The image url for the User who created the Comment.

    • rich_content object
    • html_content string

      The comment message body rendered as HTML.

    • with_mentions boolean

      Indicates if the message body contains @mentions.

    • comments_count integer

      The number of comments made on this record.

    • images object[]

      A list of the images attached to this record.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • imageable_id integer

      Possible values: >= 1

    • imageable_type ImageableType

      Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]

    • file_name string

      The name of the image file.

    • file_mime_type Image MIME Type

      Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]

    • file_size number

      The size of the image file in bytes.

    • file_url string

      The URL to access the image file.

    • full_url string

      The full URL to access the image file, including any necessary authentication or parameters.

    • images_count integer

      The number of images attached to this record.

    • documents object[]

      A list of the documents attached to this record.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • documentable_id integer

      Possible values: >= 1

    • documentable_type DocumentableType

      Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]

    • file_name string

      The name of the file.

    • file_mime_type string

      The MIME type of the file.

    • file_size number

      The size of the file in bytes.

    • file_url string

      The URL to access the file.

    • full_file_url string

      The full URL to access the file, including any necessary authentication or parameters.

    • documents_count integer

      The number of documents attached to this record.

    Loading...