Create Work Order

POST https://secure.fleetio.com/api/v1/work_orders

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

application/json

Body

issued_atdate-timerequired

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

Example: 2023-03-14T13:46:27-06:00

started_atdate-time

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

Example: 2023-03-14T13:46:27-06:00

completed_atdate-time

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

Example: 2023-03-14T13:46:27-06:00

work_order_status_idId (integer)required

Possible values: >= 1

work_order_status_namestring

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

invoice_numberstring

The number of the Invoice associated with this Work Order.

Possible values: <= 255 characters

vendor_idId (integer)

Possible values: >= 1

vendor_namestring

The name of the Vendor associated with this Work Order.

Possible values: <= 255 characters

vehicle_idId (integer)required

Possible values: >= 1

vehicle_namestring

The name of the Vehicle associated with this Work Order.

Possible values: <= 255 characters

discount_typestring

The type of discount applied to this Work Order.

Possible values: [percentage, amount]

discountfloat

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

discount_percentagefloat

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

tax_1_percentagefloat

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

tax_1_typeTaxType (string)nullable

The type of tax to apply to this record.

Possible values: [fixed, percentage]

Default value: percentage

tax_1float

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

tax_2_percentagefloat

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

tax_2_typeTaxType (string)nullable

The type of tax to apply to this record.

Possible values: [fixed, percentage]

Default value: percentage

tax_2float

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

issued_by_idId (integer)

Possible values: >= 1

contact_idId (integer)

Possible values: >= 1

label_listLabelListParameters (string)

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.

Possible values: <= 255 characters

Example: High Priority

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.

meter_entry_attributes object

secondary_meter_entry_attributes object

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

ending_meter_same_as_startboolean

Use start meter for completion meter?

vmrs_repair_priority_class_idId (integer)

Possible values: >= 1

Responses

Response Headers

application/json

Schema
Example (auto)

Schema

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

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

Example: 2023-03-14T13:46:27-06:00

account_idId (integer)required

Possible values: >= 1

numberintegerrequired

The unique number of this Work Order.

completed_atdate-timenullablerequired

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

Example: 2023-03-14T13:46:27-06:00

expected_completed_atdate-timenullable

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

Example: 2023-03-14T13:46:27-06:00

descriptionstringnullablerequired

A description of this Work Order.

ending_meter_same_as_startbooleanrequired

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

duration_in_secondsintegernullablerequired

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

invoice_numberstringnullablerequired

The number of the Invoice associated with this Work Order.

statestringrequired

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

Possible values: [active, completed]

issued_atdate-timerequired

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

Example: 2023-03-14T13:46:27-06:00

issued_by_idNullableId (integer)nullablerequired

Possible values: >= 1

contact_idNullableId (integer)nullablerequired

Possible values: >= 1

purchase_order_numberstringnullablerequired

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

started_atdate-timenullablerequired

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

Example: 2023-03-14T13:46:27-06:00

work_order_type_idNullableId (integer)nullable

Possible values: >= 1

vehicle_archived_atdate-timenullable

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

Example: 2023-03-14T13:46:27-06:00

send_email_notification_to_assigneeboolean

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

scheduled_atdate-timenullablerequired

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

Example: 2023-03-14T13:46:27-06:00

vehicle_idId (integer)required

Possible values: >= 1

vendor_idNullableId (integer)nullablerequired

Possible values: >= 1

work_order_status_idId (integer)required

Possible values: >= 1

custom_fieldsobjectnullablerequired

*Full details on working with Custom Fields here.

is_sampleboolean

Indicates whether this Work Order is sample data.

created_by_idNullableId (integer)nullable

Possible values: >= 1

vmrs_repair_priority_class_idNullableId (integer)nullable

Possible values: >= 1

label_liststring[]

A list of tags associated with this record.

Possible values: <= 255 characters

fees_centsintegernullable

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

tax_free_laborbooleannullable

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

currencystring

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

Default value: USD

labor_subtotal_centsinteger

The total cost of labor in cents.

parts_subtotal_centsinteger

The total cost of parts in cents.

subtotal_centsintegernullable

The pre-tax subtotal amount in cents.

comments_countintegerrequired

The number of Comments on this Work Order.

documents_countintegerrequired

The number of documents attached to this Work Order.

images_countintegerrequired

The number of images attached to this Work Order.

watchers_countintegerrequired

The count of watchers associated with the record.

watchable_optionsobject

Options related to watching the record.

bulk_watch_recordboolean

Indicates if a bulk watch record is created.

skip_automatic_watchers_callbacksboolean

Indicates if automatic watchers callbacks are skipped.

total_amount_centsintegernullable

The total amount in cents.

tax_1_typeTaxType (string)nullable

The type of tax to apply to this record.

Possible values: [fixed, percentage]

Default value: percentage

tax_1_percentagestringnullable

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

tax_1_centsinteger

The primary tax amount in cents.

Example: 123

tax_2_typeTaxType (string)nullable

The type of tax to apply to this record.

Possible values: [fixed, percentage]

Default value: percentage

tax_2_percentagestringnullable

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_2_centsintegernullable

The secondary tax amount in cents.

discount_typeDiscountType (string)nullable

The type of discount applied to this record.

Possible values: [fixed, percentage]

Default value: percentage

discount_percentagestringnullable

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

Example: 1.23

discount_centsintegernullable

The discount amount in cents.

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "account_id": 0,
  "number": 0,
  "completed_at": "2023-03-14T13:46:27-06:00",
  "expected_completed_at": "2023-03-14T13:46:27-06:00",
  "description": "string",
  "ending_meter_same_as_start": true,
  "duration_in_seconds": 0,
  "invoice_number": "string",
  "state": "active",
  "issued_at": "2023-03-14T13:46:27-06:00",
  "issued_by_id": 0,
  "contact_id": 0,
  "purchase_order_number": "string",
  "started_at": "2023-03-14T13:46:27-06:00",
  "work_order_type_id": 0,
  "vehicle_archived_at": "2023-03-14T13:46:27-06:00",
  "send_email_notification_to_assignee": true,
  "scheduled_at": "2023-03-14T13:46:27-06:00",
  "vehicle_id": 0,
  "vendor_id": 0,
  "work_order_status_id": 0,
  "custom_fields": {},
  "is_sample": true,
  "created_by_id": 0,
  "vmrs_repair_priority_class_id": 0,
  "label_list": [
    "High Priority"
  ],
  "fees_cents": 0,
  "tax_free_labor": true,
  "currency": "USD",
  "labor_subtotal_cents": 0,
  "parts_subtotal_cents": 0,
  "subtotal_cents": 0,
  "comments_count": 0,
  "documents_count": 0,
  "images_count": 0,
  "watchers_count": 0,
  "watchable_options": {},
  "bulk_watch_record": true,
  "skip_automatic_watchers_callbacks": true,
  "total_amount_cents": 0,
  "tax_1_type": "percentage",
  "tax_1_percentage": "string",
  "tax_1_cents": 123,
  "tax_2_type": "percentage",
  "tax_2_percentage": "string",
  "tax_2_cents": 0,
  "discount_type": "percentage",
  "discount_percentage": "1.23",
  "discount_cents": 0
}

Request could not be authenticated

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Unprocessable Entity

application/json

Schema
Example (auto)
Example

Schema

errors object

{
  "errors": {}
}

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

Something unexpected happened

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

CURL

curl -L 'https://secure.fleetio.com/api/v1/work_orders' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "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",
  "work_order_status_id": 0,
  "work_order_status_name": "string",
  "invoice_number": "string",
  "vendor_id": 0,
  "vendor_name": "string",
  "vehicle_id": 0,
  "vehicle_name": "string",
  "discount_type": "percentage",
  "discount": 0,
  "discount_percentage": 0,
  "tax_1_percentage": 0,
  "tax_1_type": "percentage",
  "tax_1": 0,
  "tax_2_percentage": 0,
  "tax_2_type": "percentage",
  "tax_2": 0,
  "issued_by_id": 0,
  "contact_id": 0,
  "label_list": "High Priority",
  "purchase_order_number": "string",
  "description": "string",
  "number": 0,
  "meter_entry_attributes": {
    "value": "108043",
    "void": true
  },
  "secondary_meter_entry_attributes": {
    "value": "108043",
    "void": true
  },
  "custom_fields": {},
  "ending_meter_same_as_start": true,
  "vmrs_repair_priority_class_id": 0
}'

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Body

{
  "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",
  "work_order_status_id": 0,
  "work_order_status_name": "string",
  "invoice_number": "string",
  "vendor_id": 0,
  "vendor_name": "string",
  "vehicle_id": 0,
  "vehicle_name": "string",
  "discount_type": "percentage",
  "discount": 0,
  "discount_percentage": 0,
  "tax_1_percentage": 0,
  "tax_1_type": "percentage",
  "tax_1": 0,
  "tax_2_percentage": 0,
  "tax_2_type": "percentage",
  "tax_2": 0,
  "issued_by_id": 0,
  "contact_id": 0,
  "label_list": "High Priority",
  "purchase_order_number": "string",
  "description": "string",
  "number": 0,
  "meter_entry_attributes": {
    "value": "108043",
    "void": true
  },
  "secondary_meter_entry_attributes": {
    "value": "108043",
    "void": true
  },
  "custom_fields": {},
  "ending_meter_same_as_start": true,
  "vmrs_repair_priority_class_id": 0
}

ResponseClear

Click the Send API Request button above and see the response here!

Create Work Order

https://secure.fleetio.com/api/v1/work_orders

Request​

Body

Responses​

Authorization: Authorization

Request

Responses