{"_id":"55103cc40f12ba0d00b2e1c5","__v":17,"version":{"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","forked_from":"54f8de14c6cabe23005c02a2","__v":31,"createdAt":"2015-03-05T22:53:02.044Z","releaseDate":"2015-03-05T22:53:02.044Z","categories":["54f8de4e4339bb1900c8bffc","54f8de4e4339bb1900c8bffd","54f8de4e4339bb1900c8bffe","54f8de4e4339bb1900c8bfff","54f8de4e4339bb1900c8c000","54ff6057563d7419002d666e","55007b6ecfeeea17004717dc","5501d779f2ef1e0d003116eb","55116ef89f7c7619005f853b","554bb366f245703100ddd39f","554d226b374fec0d007e64db","555e09f18ab3180d001ac605","555e0b2b4f5e5a0d00836d77","561d1f8b92a0cc350018b24f","562a956c96b5f40d0026eb60","5654c3378a26202b00c17cb8","5697a94b0b09a41900b24546","5739d89e37b52e3200a3a3cc","57ac94252c0b220e00a94570","57ac97a1ad44fc0e003be066","57ac9a3a8f312d0e00e96c75","57ac9c187ae5c60e004ba3a3","58178bee62e4500f009404f6","581a39711a63870f008b621d","581a3b4f0c65b20f00247fcb","5926e0606c729e0f00595f95","5954033ea5bbca002d27ae91","596ce53e0aeafe00157eb1ba","596ce87a8b79f4001a8f6139","598cad2e96193400190d879a","598cbcd3dc20c6000fdfb9c3","598cbd8496193400190d8955","59fcc7c9591add0026c91457","5a020b7856ea82001c8c9342","5a09bc64a91882001c56c2ed"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"project":"54c0e51215af820d001a38a6","parentDoc":null,"category":{"_id":"54ff6057563d7419002d666e","__v":6,"pages":["54ff60be422a14190073fb9e","54ff6161422a14190073fba1","54ff639a563d7419002d6675","54ff6440422a14190073fba8","54ff6468031aca0d00e480e4","55103cc40f12ba0d00b2e1c5"],"project":"54c0e51215af820d001a38a6","version":"54f8de4e4339bb1900c8bffb","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-03-10T21:21:27.743Z","from_sync":false,"order":9,"slug":"work-orders","title":"Work Orders"},"user":"54cba76f6d1eee0d00c33dee","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-03-23T16:18:12.983Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"Work orders are similar to service entries in that they both allow for vehicle maintenance to be tracked, but work orders allow for a larger amount of detail to be stored. For general information regarding work orders in Fleetio, check out our [help center article](http://help.fleetio.com/article/98-work-order-overview).\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Req?/Editable?\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"``completed_at``\",\n    \"0-1\": \"N*/Y\",\n    \"0-2\": \"Date on which the work order was completed. Required if the status is a completed one.\",\n    \"1-0\": \"``contact_id``\",\n    \"1-1\": \"N/Y\",\n    \"1-2\": \"Corresponds to the ``Assigned To`` field in the UI.\",\n    \"3-0\": \"``description``\",\n    \"3-1\": \"N/Y\",\n    \"3-2\": \"Open text field for work order description.\",\n    \"4-0\": \"``discount``\",\n    \"4-1\": \"N/Y\",\n    \"4-2\": \"The discount amount. This field should be present when ``discount_type`` is set to ``fixed``.\",\n    \"5-0\": \"``discount_percentage``\",\n    \"5-1\": \"N/Y\",\n    \"5-2\": \"The discount percentage. Should be present when ``discount_type`` is set to ``percentage``.\",\n    \"6-0\": \"``discount_type``\",\n    \"6-1\": \"N/Y\",\n    \"6-2\": \"Valid values are ``percentage`` and ``fixed``.\",\n    \"7-0\": \"``invoice_number``\",\n    \"7-1\": \"N/Y\",\n    \"7-2\": \"Used for reporting purposes only. If you attach invoice numbers to your work orders, add it here.\",\n    \"8-0\": \"``issued_at``\",\n    \"8-1\": \"N/Y\",\n    \"8-2\": \"Date on which the work order was first issued.\",\n    \"9-0\": \"``issued_by_id``\",\n    \"9-1\": \"N/Y\",\n    \"9-2\": \"Contact id for which the work order is issued to.\",\n    \"10-0\": \"``label_list``\",\n    \"10-1\": \"N/Y\",\n    \"10-2\": \"A comma separated list of tags/labels for the work order. The only delimiter allowed is a comma. Please remove any commas from your labels before saving the work order. Sample value: ``\\\"High Priority,Truck,Repair/Maintenance\\\"``\",\n    \"11-0\": \"``number``\",\n    \"11-1\": \"N*/Y\",\n    \"11-2\": \"Work order number. Must be unique across your account. You can either generate your own or leave it blank and have Fleetio generate one for you. Fleetio will simply use the next number in the sequence based on your existing work orders. This becomes the unique identifier, even in endpoints. Id is never used.\",\n    \"12-0\": \"``purchase_order_number``\",\n    \"12-1\": \"N/Y\",\n    \"12-2\": \"Similar to ``invoice number``, use this field if your use purchase order numbers in your system.\",\n    \"13-0\": \"``started_at``\",\n    \"13-1\": \"N*/Y\",\n    \"13-2\": \"Date on which work order was started. Required if work order status is set to completed.\",\n    \"14-0\": \"``tax_1``\",\n    \"14-1\": \"N/Y\",\n    \"14-2\": \"The amount for the Tax 1 line item. Use this if ``tax_1_type`` is set to fixed.\",\n    \"15-0\": \"``tax_1_percentage``\",\n    \"15-1\": \"N/Y\",\n    \"15-2\": \"The percentage for tax 1. Use this if ``tax_1_type`` is set to percentage.\",\n    \"16-0\": \"``tax_1_type``\",\n    \"16-1\": \"N/Y\",\n    \"16-2\": \"Can be either ``fixed`` or ``percentage``.\",\n    \"17-0\": \"``tax_2``\",\n    \"17-1\": \"N/Y\",\n    \"17-2\": \"Amount for the Tax 2 line item. Note that having this field enabled is an account level setting.\",\n    \"18-0\": \"``tax_2_percentage``\",\n    \"18-2\": \"Percentage for the Tax 2 line item. Note that having this field enabled is an account level setting.\",\n    \"19-0\": \"``tax_2_type``\",\n    \"19-1\": \"N/Y\",\n    \"18-1\": \"N/Y\",\n    \"19-2\": \"Can be either ``fixed`` or ``percentage``. Note that having this field enabled is an account level setting.\",\n    \"20-0\": \"``vehicle_id``\",\n    \"20-1\": \"Y*/Y\",\n    \"20-2\": \"Id of the associated vehicle. Either this field or ``vehicle_name`` must be present.\",\n    \"21-0\": \"``vehicle_name``\",\n    \"21-1\": \"Y*/Y\",\n    \"21-2\": \"Name of the associated vehicle. Either this field or ``vehicle_id`` must be present.\",\n    \"22-0\": \"``vendor_id``\",\n    \"22-1\": \"N/Y\",\n    \"22-2\": \"Id of the associated vendor. Can specify either this field or ``vendor_name``.\",\n    \"23-0\": \"``vendor_name``\",\n    \"23-1\": \"N/Y\",\n    \"23-2\": \"Name of the associated vendor. Can specify either this field or ``vendor_id``.\",\n    \"24-0\": \"``work_order_status_id``\",\n    \"24-1\": \"Y*/Y\",\n    \"24-2\": \"Id of the associated status. Must specify either this field or ``work_order_status_name``.\",\n    \"25-0\": \"``work_order_status_name``\",\n    \"25-1\": \"Y*/Y\",\n    \"25-2\": \"Name of the associated status. Must specify either this field or ``work_order_status_id``.\",\n    \"26-0\": \"``meter_entry_attributes``\",\n    \"26-1\": \"Y*/Y\",\n    \"26-2\": \"Each work requires a meter entry value and an associated meter entry. Required if status is completed. See the ``MeterEntry`` documentation for more info.\",\n    \"27-0\": \"``secondary_meter_entry_attributes``\",\n    \"27-1\": \"N/Y\",\n    \"27-2\": \"If vehicle has a secondary meter, then use this object to populate their values. See the ``MeterEntry`` documentation for more info.\",\n    \"28-0\": \"``work_order_line_item_attributes``\",\n    \"28-1\": \"N/Y\",\n    \"28-2\": \"Line item data for this work order. Note that you can either specify the line item data as a nested attribute, or hit the WorkOrderLineItem endpoint independently.\",\n    \"29-0\": \"\",\n    \"2-0\": \"``custom_fields``\",\n    \"2-1\": \"N/Y\",\n    \"2-2\": \"Custom field data/object.\"\n  },\n  \"cols\": 3,\n  \"rows\": 30\n}\n[/block]","excerpt":"","slug":"reference-1","type":"basic","title":"Reference"}
Work orders are similar to service entries in that they both allow for vehicle maintenance to be tracked, but work orders allow for a larger amount of detail to be stored. For general information regarding work orders in Fleetio, check out our [help center article](http://help.fleetio.com/article/98-work-order-overview). [block:parameters] { "data": { "h-0": "Name", "h-1": "Req?/Editable?", "h-2": "Description", "0-0": "``completed_at``", "0-1": "N*/Y", "0-2": "Date on which the work order was completed. Required if the status is a completed one.", "1-0": "``contact_id``", "1-1": "N/Y", "1-2": "Corresponds to the ``Assigned To`` field in the UI.", "3-0": "``description``", "3-1": "N/Y", "3-2": "Open text field for work order description.", "4-0": "``discount``", "4-1": "N/Y", "4-2": "The discount amount. This field should be present when ``discount_type`` is set to ``fixed``.", "5-0": "``discount_percentage``", "5-1": "N/Y", "5-2": "The discount percentage. Should be present when ``discount_type`` is set to ``percentage``.", "6-0": "``discount_type``", "6-1": "N/Y", "6-2": "Valid values are ``percentage`` and ``fixed``.", "7-0": "``invoice_number``", "7-1": "N/Y", "7-2": "Used for reporting purposes only. If you attach invoice numbers to your work orders, add it here.", "8-0": "``issued_at``", "8-1": "N/Y", "8-2": "Date on which the work order was first issued.", "9-0": "``issued_by_id``", "9-1": "N/Y", "9-2": "Contact id for which the work order is issued to.", "10-0": "``label_list``", "10-1": "N/Y", "10-2": "A comma separated list of tags/labels for the work order. The only delimiter allowed is a comma. Please remove any commas from your labels before saving the work order. Sample value: ``\"High Priority,Truck,Repair/Maintenance\"``", "11-0": "``number``", "11-1": "N*/Y", "11-2": "Work order number. Must be unique across your account. You can either generate your own or leave it blank and have Fleetio generate one for you. Fleetio will simply use the next number in the sequence based on your existing work orders. This becomes the unique identifier, even in endpoints. Id is never used.", "12-0": "``purchase_order_number``", "12-1": "N/Y", "12-2": "Similar to ``invoice number``, use this field if your use purchase order numbers in your system.", "13-0": "``started_at``", "13-1": "N*/Y", "13-2": "Date on which work order was started. Required if work order status is set to completed.", "14-0": "``tax_1``", "14-1": "N/Y", "14-2": "The amount for the Tax 1 line item. Use this if ``tax_1_type`` is set to fixed.", "15-0": "``tax_1_percentage``", "15-1": "N/Y", "15-2": "The percentage for tax 1. Use this if ``tax_1_type`` is set to percentage.", "16-0": "``tax_1_type``", "16-1": "N/Y", "16-2": "Can be either ``fixed`` or ``percentage``.", "17-0": "``tax_2``", "17-1": "N/Y", "17-2": "Amount for the Tax 2 line item. Note that having this field enabled is an account level setting.", "18-0": "``tax_2_percentage``", "18-2": "Percentage for the Tax 2 line item. Note that having this field enabled is an account level setting.", "19-0": "``tax_2_type``", "19-1": "N/Y", "18-1": "N/Y", "19-2": "Can be either ``fixed`` or ``percentage``. Note that having this field enabled is an account level setting.", "20-0": "``vehicle_id``", "20-1": "Y*/Y", "20-2": "Id of the associated vehicle. Either this field or ``vehicle_name`` must be present.", "21-0": "``vehicle_name``", "21-1": "Y*/Y", "21-2": "Name of the associated vehicle. Either this field or ``vehicle_id`` must be present.", "22-0": "``vendor_id``", "22-1": "N/Y", "22-2": "Id of the associated vendor. Can specify either this field or ``vendor_name``.", "23-0": "``vendor_name``", "23-1": "N/Y", "23-2": "Name of the associated vendor. Can specify either this field or ``vendor_id``.", "24-0": "``work_order_status_id``", "24-1": "Y*/Y", "24-2": "Id of the associated status. Must specify either this field or ``work_order_status_name``.", "25-0": "``work_order_status_name``", "25-1": "Y*/Y", "25-2": "Name of the associated status. Must specify either this field or ``work_order_status_id``.", "26-0": "``meter_entry_attributes``", "26-1": "Y*/Y", "26-2": "Each work requires a meter entry value and an associated meter entry. Required if status is completed. See the ``MeterEntry`` documentation for more info.", "27-0": "``secondary_meter_entry_attributes``", "27-1": "N/Y", "27-2": "If vehicle has a secondary meter, then use this object to populate their values. See the ``MeterEntry`` documentation for more info.", "28-0": "``work_order_line_item_attributes``", "28-1": "N/Y", "28-2": "Line item data for this work order. Note that you can either specify the line item data as a nested attribute, or hit the WorkOrderLineItem endpoint independently.", "29-0": "", "2-0": "``custom_fields``", "2-1": "N/Y", "2-2": "Custom field data/object." }, "cols": 3, "rows": 30 } [/block]