The eWorkOrders Rest API allows you to query information from your database, such as meters, and add information to your database, such as meter readings.
\nAPI Endpoint
The endpoint for all calls is https://api.eworkorders.com/v1
The API uses API Key authentication to validate requests. Please contact us to obtain your Username and API Key. Multiple API Keys can be generated per account with different access rights.
\nEach requests needs to be authenticated by passing the Username and API Key in the \"Authorization\" header. It should follow this format:
\nAuthorization:Apikey {Username:API Key}
\nOther Required Headers
\ncontent-type: application/json
\ntimestamp: {current time in ISO 8601 Central Standard Time EX: 2019-01-01T09:01:00}
\n| Status Code | Descriptions |
|---|---|
2xx | Success |
4xx | Client Error |
5xx | Server Error |
| Status Code | Description |
|---|---|
200 | Success The request was successfully completed. |
201 | Created The request was a success and one or more resources have been created. |
400 | Bad Request The request cannot be performed. Usually because of malformed parameter or missing parameter. |
401 | Unauthorized Request was rejected because of either invalid API Key, or a signature mismatch. |
403 | Forbidden The user does not have enough permission to access the resource. |
404 | Not Found No records were returned from the request. |
List asset fields
\n| Parameter | \nType | \nDescription | \n
| field_desc | \nstring | \nAsset field description | \n
| field_type_num | \nint | \nUnique ID that correlates to the asset field type\nAccepted Values:\n1 (character)\n2 (date)\n3 (dropdown)\n4 (number)\n5 (datetime) | \n
| field_type | \nstring | \nDescription of the field type\nAccepted Values:\ncharacter, date, dropdown, number, datetime | \n\n
List asset field values
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","assets","fields","values","{unit_num}"],"host":["api","eworkorders","com"],"query":[],"variable":[]}},"response":[{"id":"2deccf90-883f-4b44-b9c3-131153a17d7f","name":"Get Asset Field Values","originalRequest":{"method":"GET","header":[{"key":"timestamp","value":"{{date}}"},{"key":"Authorization","value":"{{signature}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.eworkorders.com/v1/assets/fields/values/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"PHP/7.2.7"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 12 Dec 2018 14:34:30 GMT"},{"key":"Content-Length","value":"2089"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"unit_num\": \"1\",\r\n \"unit_desc\": \"Buldings- not P1 or P2\",\r\n \"field_num\": \"3\",\r\n \"field_value\": \"General\",\r\n \"print_on_work_order\": 0\r\n },\r\n {\r\n \"unit_num\": \"1\",\r\n \"unit_desc\": \"Buldings- not P1 or P2\",\r\n \"field_num\": \"1\",\r\n \"field_value\": \"Buildings & Grounds\",\r\n \"print_on_work_order\": 0\r\n },\r\n {\r\n \"unit_num\": \"1\",\r\n \"unit_desc\": \"Buldings- not P1 or P2\",\r\n \"field_num\": \"4\",\r\n \"field_value\": \"Buldings- not P1 or P2\",\r\n \"print_on_work_order\": 0\r\n },\r\n {\r\n \"unit_num\": \"1\",\r\n \"unit_desc\": \"Buldings- not P1 or P2\",\r\n \"field_num\": \"2\",\r\n \"field_value\": \"Buildings\",\r\n \"print_on_work_order\": 0\r\n }\r\n]"}],"_postman_id":"74c532b5-be08-4129-8190-0feb7990addd"},{"name":"Get Asset Field Dropdown Values","event":[{"listen":"prerequest","script":{"id":"2e6c89c5-7ec2-4496-a87d-995319dd6dd3","exec":[""],"type":"text/javascript"}}],"id":"45e6a37a-0444-414e-908f-181307de85de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"timestamp","value":"{timestamp}"},{"key":"Authorization","value":"apikey {username}:{apikey}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.eworkorders.com/v1/assets/fields/dropdowns/{field_num}","description":"List asset field values
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","assets","fields","dropdowns","{field_num}"],"host":["api","eworkorders","com"],"query":[],"variable":[]}},"response":[{"id":"6769f411-40a6-41f1-be6a-1d12bd2880f2","name":"Get Asset Field Values","originalRequest":{"method":"GET","header":[{"key":"timestamp","value":"{{date}}"},{"key":"Authorization","value":"{{signature}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.eworkorders.com/v1/assets/fields/dropdowns/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"PHP/7.2.7"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 12 Dec 2018 14:34:30 GMT"},{"key":"Content-Length","value":"2089"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"field_num\": \"1\",\r\n \"value_desc\": \"Buildings & Grounds\",\r\n \"default_value\": 1\r\n },\r\n {\r\n \"field_num\": \"1\",\r\n \"value_desc\": \"General or Site work\",\r\n \"default_value\": 0\r\n },\r\n {\r\n \"field_num\": \"1\",\r\n \"value_desc\": \"Mobile Equipment\",\r\n \"default_value\": 0\r\n },\r\n {\r\n \"field_num\": \"1\",\r\n \"value_desc\": \"Plant 1\",\r\n \"default_value\": 0\r\n },\r\n {\r\n \"field_num\": \"1\",\r\n \"value_desc\": \"Plant 2\",\r\n \"default_value\": 0\r\n },\r\n {\r\n \"field_num\": \"1\",\r\n \"value_desc\": \"Safety\",\r\n \"default_value\": 0\r\n },\r\n {\r\n \"field_num\": \"1\",\r\n \"value_desc\": \"Salt Pot Building\",\r\n \"default_value\": 0\r\n },\r\n {\r\n \"field_num\": \"1\",\r\n \"value_desc\": \"Utilities\",\r\n \"default_value\": 0\r\n }\r\n]"}],"_postman_id":"45e6a37a-0444-414e-908f-181307de85de"}],"id":"201fb325-d779-4c39-9992-e4f4b2d51698","description":"Custom Asset Fields
\n","_postman_id":"201fb325-d779-4c39-9992-e4f4b2d51698","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}}},{"name":"List Assets","event":[{"listen":"prerequest","script":{"id":"ab1cf5de-fb67-409c-9fbb-2e26a5d505b9","exec":[""],"type":"text/javascript"}}],"id":"38c646ec-e72c-4d8a-863c-ff23eb9fcc21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"timestamp","value":"{timestamp}"},{"key":"Authorization","value":"apikey {username}:{apikey}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.eworkorders.com/v1/assets","description":"List assets
\nParameter | Type | Description |
unit_desc | string | Asset description |
category | string | Asset category |
criticality | string | Asset criticality |
area | string | Area description that asset belongs to |
area_num | int | Unique area_num that asset belongs to |
cat_num | int | Unique category ID (cat_num) |
critical_num | int | Unique criticality ID (critical_num) |
active | boolean | Active Status |
manu | string | Manufacturer of the asset |
model | string | Model # of the asset |
serial | string | Serial # of the asset |
location | string | Location of asset |
location2 | string | Location2 of asset |
asset_number | string | Asset # |
user_num | int | Unique user ID \\*filters the assets based on user permissions |
super_num | int | Unique department ID |
Get a specific asset by unique unit_num
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","assets","{unit_num}"],"host":["api","eworkorders","com"],"query":[],"variable":[]}},"response":[{"id":"0f19fb79-2047-4d6c-84df-0b235c5f9f9d","name":"Get Asset","originalRequest":{"method":"GET","header":[{"key":"timestamp","value":"{{date}}"},{"key":"Authorization","value":"{{signature}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.eworkorders.com/v1/assets/1280"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"PHP/7.2.7"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 12 Dec 2018 14:49:40 GMT"},{"key":"Content-Length","value":"2023"}],"cookie":[],"responseTime":null,"body":"{\n \"super_num\": 1,\n \"unit_num\": \"1280\",\n \"unit_desc\": \"Air Handler 1\",\n \"area_num\": \"95\",\n \"area_desc\": \"Area1\",\n \"cat_num\": \"3\",\n \"cat_desc\": \"Air Handlers / Fans\",\n \"critical_num\": \"3\",\n \"critical_desc\": \"New Criticality\",\n \"unit_manu\": \"\",\n \"unit_model\": \"\",\n \"unit_seria\": \"\",\n \"unit_com\": \"\",\n \"location\": \"\",\n \"location2\": \"\",\n \"center\": \"\",\n \"asset_number\": \"0000015\",\n \"unit_note\": \"fsdf\",\n \"useful_life\": \".00\",\n \"dateinservice\": \"\",\n \"dateoutofservice\": \"\",\n \"squarefeet\": \".00\",\n \"purchaseprice\": \".00\",\n \"currentvalue\": \".00\",\n \"latitude\": \"-999.0000000000000000\",\n \"longitude\": \"-999.0000000000000000\",\n \"field1\": \"Buildings & Grounds\",\n \"print_on_work_order1\": 0,\n \"field2\": \"Buildings\",\n \"print_on_work_order2\": 0,\n \"field3\": \"(None)\",\n \"print_on_work_order3\": 0,\n \"field4\": \"\",\n \"print_on_work_order4\": 0,\n \"field5\": \"\",\n \"print_on_work_order5\": 0,\n \"field6\": \"\",\n \"print_on_work_order6\": 0,\n \"field7\": \"\",\n \"print_on_work_order7\": 0,\n \"field8\": \"\",\n \"print_on_work_order8\": 0,\n \"field9\": \"\",\n \"print_on_work_order9\": 0,\n \"field10\": \"\",\n \"print_on_work_order10\": 0,\n \"field11\": \"\",\n \"print_on_work_order11\": 0,\n \"field12\": \"\",\n \"print_on_work_order12\": null,\n \"field13\": \"No\",\n \"print_on_work_order13\": 0,\n \"field14\": \"dasd\",\n \"print_on_work_order14\": null,\n \"field15\": \"\",\n \"print_on_work_order15\": 0,\n \"active\": 1\n}"}],"_postman_id":"8146ff16-95fc-4bbf-b58e-6a00ba503626"},{"name":"Update Asset","id":"a296d25a-7851-44ba-a1ec-e62e4942fee5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"timestamp","type":"text","value":"{timestamp}"},{"key":"Authorization","type":"text","value":"apikey {username}:{apikey}"},{"key":"Content-type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"active\": 1\n}"},"url":"https://api.eworkorders.com/v1/assets/{unit_num}","description":"Update the active status of an asset.
\n| Parameter | \nType | \nDescription | \n
| active | \nboolean | \nActive Status | \n
Add a new asset.
\n| Parameter | \n\nType | \n\nDescription | \n\n
| unit_desc | \n\nstring | \n\nAsset Description (will check if input value is contained in the title) | \n\n
| area_num | \n\ninteger | \n\nUnique area ID | \n\n
| area_desc | \n\nstring | \n\nArea description | \n\n
| area_short | \n\nstring | \n\nArea short description | \n\n
| cat_num | \n\ninteger | \n\nUnique category ID | \n\n
| cat_desc | \n\nstring | \n\nCategory description | \n\n
| critical_num | \n\ninteger | \n\nUnique Criticality ID | \n\n
| critical_desc | \n\nString | \n\nCriticality description | \n\n
| location | \n\nString | \n\nLocation 1 Field | \n\n
| location2 | \n\nString | \n\nLocation 2 Field | \n\n
| unit_manu | \n\nstring | \n\nAsset Manufacaturer | \n\n
| unit_model | \n\nstring | \n\nAsset Model # | \n\n
| unit_seria | \n\nstring | \n\nAsset Serial # | \n\n
| Budget | \n\nstring | \n\nAsset Budget # | \n\n
| unit_note | \n\nstring | \n\nAsset information | \n\n
| asset_number | \n\nstring | \n\nAsset number | \n\n
Get Assets and Update Active status of Asset.
\n","event":[{"listen":"prerequest","script":{"id":"1d469dd1-5fa8-44b6-96a3-116bf522cfaf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bd128ce0-20f6-44ef-9cc0-00823f3065a3","type":"text/javascript","exec":[""]}}],"_postman_id":"382c0fc9-de0e-437c-bc56-8899bcc82a45","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}}},{"name":"Meters","item":[{"name":"List Meters","event":[{"listen":"prerequest","script":{"id":"ab1cf5de-fb67-409c-9fbb-2e26a5d505b9","exec":[""],"type":"text/javascript"}}],"id":"6e5ccea7-daef-4d18-b926-5dcde46cbd39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"timestamp","value":"{timestamp}"},{"key":"Authorization","value":"apikey {username}:{apikey}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.eworkorders.com/v1/meters","description":"Returns all meters.
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","meters"],"host":["api","eworkorders","com"],"query":[],"variable":[]}},"response":[{"id":"c05be2fe-c165-474d-b087-4b66b04ac70b","name":"List Meters","originalRequest":{"method":"GET","header":[{"key":"Date","value":"{{date}}","disabled":false},{"key":"Authorization","value":"{{signature}}","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.eworkorders.com/v1/meters/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2759","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 23 Mar 2018 14:37:52 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/8.0","name":"Server","description":"A name for the server"},{"key":"X-Powered-By","value":"PHP/5.5.11","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"rachel.eworkorders.com","path":"/","secure":false,"value":"gi2iuomsga4697iu88s0g3f8q0","key":"PHPSESSID"}],"responseTime":null,"body":"[\n {\n \"serial_num\": \"10003\",\n \"meter_desc\": \"Check A2 Extruder for leaks\",\n \"meter_desc2\": \"CHECK A2 EXTRUDER FOR LEAKS\",\n \"location\": \"\",\n \"area_num\": \"1\",\n \"rollover_num\": \"9999999\",\n \"units\": \"\",\n \"cunits\": \"\",\n \"conversion\": \"1.000\",\n \"date_in\": {\n \"date\": \"1900-01-01 00:00:00\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"date_out\": {\n \"date\": \"1900-01-01 00:00:00\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"hi_range\": \"100.000\",\n \"lo_range\": \"10.000\",\n \"barcode\": \"10003\",\n \"super_num\": 1,\n \"unit_num\": \"104\",\n \"meter_num\": \"2\",\n \"replace_num\": \"1\",\n \"type_num\": \"1\",\n \"reconcile\": 0,\n \"active\": 1,\n \"select_num\": 2\n },\n {\n \"serial_num\": \"092348023\",\n \"meter_desc\": \"Meter 5\",\n \"meter_desc2\": \"METER 5\",\n \"location\": \"1st Floor\",\n \"area_num\": \"1\",\n \"rollover_num\": \"0\",\n \"units\": \"\",\n \"cunits\": \"\",\n \"conversion\": \"1.000\",\n \"date_in\": {\n \"date\": \"1900-01-01 00:00:00\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"date_out\": {\n \"date\": \"1900-01-01 00:00:00\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"hi_range\": \".000\",\n \"lo_range\": \".000\",\n \"barcode\": \"4\",\n \"super_num\": 1,\n \"unit_num\": \"112\",\n \"meter_num\": \"4\",\n \"replace_num\": \"-1\",\n \"type_num\": \"1\",\n \"reconcile\": 0,\n \"active\": 1,\n \"select_num\": 1\n }\n]"}],"_postman_id":"6e5ccea7-daef-4d18-b926-5dcde46cbd39"},{"name":"Get Meter","event":[{"listen":"prerequest","script":{"id":"af62fd68-0542-4c74-b2e9-71906a4f3167","exec":[""],"type":"text/javascript"}}],"id":"fb12b48f-c103-4d18-a5e8-59ac83de438d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Date","value":"{timestamp}"},{"key":"Authorization","value":"apikey {username}:{apikey}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.eworkorders.com/v1/meters/1","description":"Get meter information either by meter_num or meter_desc.
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","meters","1"],"host":["api","eworkorders","com"],"query":[],"variable":[]}},"response":[{"id":"ec8750ef-4e91-464e-89d0-2e922d264608","name":"GET Specific Meter","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.eworkorders.com/v1/meters/water%20pump%20%231"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"serial_num\": \"10001\",\n \"meter_desc\": \"Plant 1 Meter\",\n \"meter_desc2\": \"PLANT 1 Meter\",\n \"location\": \"Plant1 third floor\",\n \"area_num\": \"1\",\n \"rollover_num\": \"0\",\n \"units\": \"\",\n \"cunits\": \"\",\n \"conversion\": \"1.000\",\n \"date_in\": {\n \"date\": \"1900-01-01 00:00:00\"\n },\n \"date_out\": {\n \"date\": \"1900-01-01 00:00:00\"\n },\n \"hi_range\": \".000\",\n \"lo_range\": \".000\",\n \"barcode\": \"10001\",\n \"super_num\": 1,\n \"unit_num\": \"104\",\n \"meter_num\": \"1\",\n \"replace_num\": \"-1\",\n \"type_num\": \"1\",\n \"reconcile\": 0,\n \"active\": 1,\n \"select_num\": 1\n }\n]"}],"_postman_id":"fb12b48f-c103-4d18-a5e8-59ac83de438d"},{"name":"List Meter Readings","event":[{"listen":"prerequest","script":{"id":"1a763441-346c-4775-84eb-19ec09bedb26","exec":["",""],"type":"text/javascript"}}],"id":"65f68b84-0c7a-4275-98a7-ed0a8447c74c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"timestamp","value":"{timestamp}"},{"key":"Authorization","value":"apikey {username}:{apikey}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.eworkorders.com/v1/meters/readings","description":"Returns all meter readings.
\n| Parameter | \nType | \nDescription | \n
| wo_number | \nint | \nWork Order # (optional) | \nmeter_num | \nint | \nUnique meter_num | \n\n
| batch_desc | \nstring | \nBatch Description (optional) | \n
| from | \ndate/time | \nFrom Date | \nto | \ndate/time | \nTo Date | \n\n\n
Get meter reading by batch_num
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","meters","readings","{batch_num]"],"host":["api","eworkorders","com"],"query":[],"variable":[]}},"response":[{"id":"996168d5-f561-46ec-af49-a78b553f67c3","name":"Get Meter Reading","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":false},{"key":"Date","value":"{{date}}","disabled":false},{"key":"Authorization","value":"{{signature}}","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.eworkorders.com/v1/meters/readings/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"601","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 26 Mar 2018 15:44:12 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/8.0","name":"Server","description":"A name for the server"},{"key":"X-Powered-By","value":"PHP/5.5.11","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"[{\"meter_num\":\"2\",\"meter_desc\":\"Check A2 Extruder for leaks\",\"super_num\":1,\"batch_num\":\"2\",\"reading\":\"10253.00\",\"calibration\":0,\"date_time\":{\"date\":\"2016-09-14 15:36:04\",\"timezone_type\":3,\"timezone\":\"America\\/New_York\"},\"wo_number\":\"0\",\"reading_num\":null,\"user_num\":null,\"batch_desc\":\"Batch # 1\"},{\"meter_num\":\"1\",\"meter_desc\":\"Plant 1 checck A2 Extrudr for leaks\",\"super_num\":1,\"batch_num\":\"2\",\"reading\":\"47525.00\",\"calibration\":0,\"date_time\":{\"date\":\"2016-09-14 15:36:04\",\"timezone_type\":3,\"timezone\":\"America\\/New_York\"},\"wo_number\":\"0\",\"reading_num\":null,\"user_num\":null,\"batch_desc\":\"Batch # 1\"}]"}],"_postman_id":"59286b68-3c1a-4ba9-8ee7-bd71999a1197"},{"name":"Add Meter Reading","event":[{"listen":"prerequest","script":{"id":"8773052a-c8f1-4e68-a8ec-83a438cad564","exec":[""],"type":"text/javascript"}}],"id":"c9cdbe67-dec0-48f7-9c8f-93c0246dbfc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"timestamp","value":"{timestamp}"},{"key":"Authorization","value":"apikey {username}:{apikey}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.eworkorders.com/v1/meters/readings","description":"Add a meter reading
\nParameter | Type | Description |
meter_num | int | Unique meter_num |
reading | int | Meter reading |
wo_number | int | Work Order # (optional) |
batch_desc | string | Batch Description (optional) |
Update active status of a meter.
\n| Parameter | \nType | \nDescription | \n
| active | \nboolean | \nActive Status | \n
Get Meters, Meter Readings, and Create Meter Readings
\n#Meter Object
\n","event":[{"listen":"prerequest","script":{"id":"57211eaf-0e17-45a2-a029-6d69010d07e6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0e1c8d32-1772-4444-adf4-a7888f73febd","type":"text/javascript","exec":[""]}}],"_postman_id":"324eb78a-b601-474a-9b32-ce0596578b83","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}}},{"name":"Users","item":[{"name":"List Users","event":[{"listen":"prerequest","script":{"id":"3acb57ff-9f03-40f9-aca4-6827cac5dab8","exec":[""],"type":"text/javascript"}}],"id":"2214101e-995a-4211-80bb-6795ef14f085","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"apikey {username}:{apikey}","type":"text"},{"key":"Timestamp","value":"{timestamp}","type":"text"},{"key":"Content-type","value":"application/json","type":"text"}],"url":"https://api.eworkorders.com/v1/users","description":"Get all users
\n| Parameter | \nType | \nDescription | \n
| real_name | \nstring | \nName of user, where name contains phrase (optional) | \n
| newer_than | \ndate/time | \nReturn users created after this date | \n
Get a specific user by either user_id or user_num.
\n","urlObject":{"protocol":"https","path":["v1","users","{user_id or user_num}"],"host":["api","eworkorders","com"],"query":[],"variable":[]}},"response":[{"id":"0e43ca15-4f84-4f3d-8915-38a5b7f4c5b0","name":"Get User","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"timestamp","value":"{{date}}","type":"text"},{"key":"Content-type","value":"Application/json","type":"text"}],"url":"https://api.eworkorders.com/v1/users/92"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"user_id\": \"123\",\n \"super_num\": 1,\n \"id\": \"92\",\n \"real_name\": \"123\"\n }\n]"}],"_postman_id":"da671c8c-b529-4531-a4c0-060ea3e72f89"},{"name":"Update User","id":"69546958-c746-4f44-ad5f-501200c9c461","request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"timestamp","value":"{timestamp}","type":"text"},{"key":"Authorization","value":"apikey {username}:{apikey}","type":"text"},{"key":"Content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"active\": 1\n}"},"url":"https://api.eworkorders.com/v1/users/{user_id or user_num}","description":"Update the active status of a specific user.
\nParameter | Type | Description |
active | boolean | Active Status |
Get users and update user status.
\n","_postman_id":"eafd16a1-46cc-4036-af49-96d1a3c4eaff","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}}},{"name":"Workorders","item":[{"name":"Workorder Fields","item":[{"name":"List Work Order Fields","event":[{"listen":"prerequest","script":{"id":"85b968ee-9aa5-4b79-bb92-2913507effc6","exec":[""],"type":"text/javascript"}}],"id":"256953cf-0620-4221-b618-0c03441aa331","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"timestamp","value":"{timestamp}"},{"key":"Authorization","value":"apikey {username}:{apikey}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.eworkorders.com/v1/workorders/fields/{field_num}","description":"List asset fields
\nParameter | Type | Description |
field_desc | string | Work Order field description |
field_type_num | int | Unique ID that correlates to the work order field type Accepted Values: 1 (character) 2 (date) 3 (dropdown) 4 (number) 5 (datetime) |
field_type | string | Description of the field type Accepted Values: character, date, dropdown, number, datetime |
List work order field values
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","workorders","fields","values","{workorder_num}"],"host":["api","eworkorders","com"],"query":[],"variable":[]}},"response":[{"id":"c26082ac-6e3d-4c34-a81b-548fb5c6696b","name":"Get Work Order Field Values","originalRequest":{"method":"GET","header":[{"key":"timestamp","value":"{{date}}"},{"key":"Authorization","value":"{{signature}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.eworkorders.com/v1/workorders/fields/values/9982"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"PHP/7.2.7"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 12 Dec 2018 14:34:30 GMT"},{"key":"Content-Length","value":"2089"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"11\",\r\n \"field_value\": \"\"\r\n },\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"8\",\r\n \"field_value\": \"No\"\r\n },\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"9\",\r\n \"field_value\": \"YES\"\r\n },\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"10\",\r\n \"field_value\": \"\"\r\n },\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"2\",\r\n \"field_value\": \"Yes\"\r\n },\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"6\",\r\n \"field_value\": \"5\"\r\n },\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"1\",\r\n \"field_value\": \"No\"\r\n },\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"17\",\r\n \"field_value\": \"544\"\r\n },\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"7\",\r\n \"field_value\": \"\"\r\n },\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"13\",\r\n \"field_value\": \"\"\r\n },\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"5\",\r\n \"field_value\": \"\"\r\n },\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"12\",\r\n \"field_value\": \"\"\r\n },\r\n {\r\n \"wo_number\": \"9982\",\r\n \"field_num\": \"4\",\r\n \"field_value\": \"NO\"\r\n }\r\n]"}],"_postman_id":"7ac67c4d-665e-46f7-ad85-dce3f96d34a2"},{"name":"Get Workorder Field Dropdown Values","event":[{"listen":"prerequest","script":{"id":"84cae565-61dd-4680-8587-5c9d56383fc6","exec":[""],"type":"text/javascript"}}],"id":"af766ec8-2201-4d6d-8dad-6aa84f870ac9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"timestamp","value":"{timestamp}"},{"key":"Authorization","value":"apikey {username}:{apikey}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.eworkorders.com/v1/workorders/fields/dropdowns/{field_num}","description":"List asset field values
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","workorders","fields","dropdowns","{field_num}"],"host":["api","eworkorders","com"],"query":[],"variable":[]}},"response":[{"id":"86dcd977-570f-495e-80c7-ee78d0d580f1","name":"Get Workorder Field Values","originalRequest":{"method":"GET","header":[{"key":"timestamp","value":"{{date}}"},{"key":"Authorization","value":"{{signature}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.eworkorders.com/v1/workorders/fields/dropdowns/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"PHP/7.2.7"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 12 Dec 2018 14:34:30 GMT"},{"key":"Content-Length","value":"2089"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"field_num\": \"1\",\r\n \"value_desc\": \"No\",\r\n \"default_value\": 1\r\n },\r\n {\r\n \"field_num\": \"1\",\r\n \"value_desc\": \"Yes\",\r\n \"default_value\": 0\r\n }\r\n]"}],"_postman_id":"af766ec8-2201-4d6d-8dad-6aa84f870ac9"}],"id":"e4f890e1-972f-4e4c-97a9-6524116d8ca1","description":"Custom Work order fields
\n","_postman_id":"e4f890e1-972f-4e4c-97a9-6524116d8ca1","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}}},{"name":"Work Order Assignments","item":[{"name":"Get Work Order Assignments","id":"0e885178-8c82-4ae7-8429-16deaa6c1db3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"timestamp","value":"{timestamp}","type":"text"},{"key":"Authorization","value":"apikey {username}:{apikey}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.eworkorders.com/v1/workorders/assignments","description":"List work order assignments
\nList work order labor hours.
\nList work orders
\n| Parameter | \nType | \nDescription | \n
| status_num | \nint | \nUnique status identifier | \n
| status | \nstring | \nStatus | \n
| prior_num | \nint | \nUnique priority identifier | \n
| prior_desc | \nstring | \nPriority | \n
| type_num | \nint | \nUnique type identifier | \n
| type_desc | \nstring | \nWork Type | \n
| unit_num | \nint | \nUnique asset identifier | \n
| unit_desc | \nstring | \nAsset | \n
| area_num | \nint | \nUnique asset area identifier | \n
| area_desc | \nstring | \nAsset area | \n
| report_grouping | \nstring | \nReport Grouping associated with area on work order | \n
| title | \nstring | \nTitle of work order (will check if input value is contained in the title) | \n
| contact | \nstring | \nWork Order Contact | \n
| string | \nWork Order Email | \n|
| reported_from | \ndate/time | \nWork Order reported from date | \n
| reported_to | \ndate/time | \nWork Order reported to date | \n
| closed_from | \ndate/time | \nWork Order closed from date | \n
| closed_to | \ndate/time | \nWork Order closed to date | \n
Create a new work order. The fields required to submit a work order are title, and work type.
\nParameter | Type | Description |
title | string | Required Title of work order (will check if input value is contained in the title) |
type_num | integer | \\\\\\*Required Unique work type ID |
type_desc | integer | \\\\\\*Required Work type description |
type_short | integer | \\\\\\*Required Work type short description |
area_num | integer | Unique area ID |
area_desc | integer | Area description |
area_short | integer | Area short description |
asset_num | integer | Unique asset ID |
asset_desc | integer | Asset description |
asset_short | integer | Asset short description |
prior_num | int | Unique priority identifier |
prior_desc | string | Priority |
prior_short | string | Priority short description |
type_num | int | Unique type identifier |
type_desc | string | Work Type |
contact | string | Work Order Contact |
email | string | Work Order Email |
phone | string | Work Order Phone |
location1 | string | Location 1 field |
location2 | string | Location 2 field |
budget | string | Budget code |
Procedure | string | Information about the work order |
auto_assign | int | If set to 1 labor will be automatically assigned to users set up under work types |
send_notifications | int | If set to 1, all email and text notifications will be sent out as per the settings on the work type |
Get work orders
\n","event":[{"listen":"prerequest","script":{"id":"7a9d9824-ff75-4422-be04-cd050cebeec4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b4fdd496-4f62-4556-86a0-cd5db79b7c15","type":"text/javascript","exec":[""]}}],"_postman_id":"07ddc351-f06e-4ba4-bb08-bc8bdc51eade","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}}},{"name":"Spotbuys","item":[{"name":"List Spot Buy Orders","event":[{"listen":"prerequest","script":{"id":"752d57dd-898c-44b7-a88b-b163157f474e","exec":[""],"type":"text/javascript","packages":{}}}],"id":"d95f44fa-1b17-446d-9078-92684d381978","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"apikey {username}:{apikey}","type":"text"},{"key":"Timestamp","value":"{timestamp}","type":"text"},{"key":"Content-type","value":"application/json","type":"text"}],"url":"https://api.eworkorders.com/v1/spotbuys","description":"List spot buy orders
\nParameter | Type | Description |
status_num | int | Unique status identifier (1 = Open, 4 = Completed) |
notes | string | Notes (will check if input value is contained in the notes) |
contains_item | string | Description of item on order |
wo_number | int | Work Order # |
vendor | string | Vendor |
ordered_by | string | Ordered By |
ordered_from | date/time | Spot buy order from date |
ordered_to | date/time | Spot buy order to date |
printed_from | date/time | Spot buy order printed from date |
printed_to | date/time | Spot buy order printed to date |
emailed_from | date/time | Spot buy order emailed from date |
emailed_to | date/time | Spot buy order emailed to date |
shipped_from | date/time | Spot buy order shipped from date |
shipped_to | date/time | Spot buy order shipped to date |
approved_from | date/time | Spot buy order approved from date |
approved_to | date/time | Spot buy order approved to date |
price_from | int | Spot buy order subtotal price amount from |
price_to | int | Spot buy order subtotal price amount to |
List spot buy order line items
\nParameter | Type | Description |
wo_number | int | Work Order # |
ordered_from | date/time | Spot buy order from date |
ordered_to | date/time | Spot buy order to date |
item_search | string | String contained in item number or item description |
List inventory items
\n| Parameter | \nType | \nDescription | \n
| item_desc | \nstring | \nItem Description (will check if input value is contained in the item description) | \n
| stockroom_num | \nint | \nUnique stockroom identifier | \n
| stockroom_short | \nstring | \nStockroom short description | \n
| stockroom_desc | \nstring | \nStockroom | \n
| cat_num | \nint | \nUnique item category identifier | \n
| long_cat_desc | \nstring | \nItem Category (Include all parent categories. Separate parent category from child category with \" - \".) | \n
| item_number | \nstring | \nItem Number | \n
| consignment | \nboolean | \nConsigned Item | \n
| active | \nboolean | \nActive Status | \n
| ven_num | \nint | \nUnique default vendor identifier | \n
| vendor | \nstring | \nDefault Vendor | \n
| location | \nstring | \nItem location | \n
Create a new inventory item.
\n| Parameter | \nType | \nDescription | \n
| inventory_department | \nint | \nRequired Inventory department unique identifier | \n
| item_desc | \nstring | \nRequired Unique item description | \n
| long_cat_desc | \nstring | \n*Required Item category Include all parent categories. Separate parent category from child category with \" - \". | \n
| cat_num | \nint | \n*Required Item category unique identifier | \n
| internal_unit | \nstring | \nRequired Item's internal distribution unit. (ex. each, roll) | \n
| purchase_unit | \nstring | \nItem's purchase unit. (ex. each, case) | \n
| lots | \ninteger | \nNumber of internal units in purchase unit (default is 1) | \n
| unit_charge | \nfloat | \nItem's internal chargeback price. This field will only be populated if the accounting method is Set Defined Price | \n
| stockroom_num | \nint | \nStockroom unique identifier. If this, stockroom_short and stockroom_desc are all blank, the first stockroom found will be the default. | \n
| stockroom_short | \nstring | \nStockroom short description | \n
| stockroom_desc | \nstring | \nStockroom | \n
| ven_num | \nint | \nDefault vendor unique identifier | \n
| vendor | \nstring | \nDefault vendor | \n
| con_num | \nint | \nDefault contact unique identifier | \n
| contact | \nstring | \nDefault contact | \n
| item_number | \nstring | \nItem number | \n
| ven_item_number | \nstring | \nVendor's item number | \n
| ven_po | \nstring | \nVendor's default PO number | \n
| lead_time | \nint | \nVendor's lead time | \n
| consignment | \nboolean | \nConsigned Item (0 is false, 1 is true) | \n
| manufacturer | \nstring | \nItem manufacturer | \n
| active | \nboolean | \nActive Status (0 is false, 1 is true) | \n
| notes | \nstring | \nItem notes | \n
| field# | \nstring number date | \nItem user field Examples: field1 = 'Red' field4 = 14 field9 = '12/31/2001' | \n
Update the stockroom data for an item in a specific stockroom location.
\nParameter | Type | Description |
item_desc | string | \\*Required Unique item description (\\* If an item_num is not included in the endpoint) |
stockroom_num | int | \\*Required Stockroom unique identifier. |
stockroom_desc | string | \\*Required Stockroom short description |
stockroom_short | string | \\*Required Stockroom |
location | string | The bin or shelf location in the stockroom |
min_num | int | Minimum item quantity |
max_num | int | Maximum item quantity |
start_after | date | Cycle count schedule begin date |
cycle_days | int | Number of days between cycle counts |
active | boolean | Active Status |
List inventory stockrooms
\nParameter | Type | Description |
active | int | 1=active, 0=inactive |
stockroom_short | string | Stockroom short description |
stockroom_desc | string | Stockroom |
List inventory transactions
\nParameter | Type | Description |
stockroom_num | int | Unique stockroom identifier |
stockroom_short | string | Stockroom short description |
stockroom_desc | string | Stockroom |
Inventory Deposits, Removals, Counts and Adjustments
\n","_postman_id":"2b41d9fc-5898-488c-8d77-d0584398ac21","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}}},{"name":"Purchaseorders","item":[{"name":"List Purchase Orders","event":[{"listen":"prerequest","script":{"id":"752d57dd-898c-44b7-a88b-b163157f474e","exec":[""],"type":"text/javascript"}}],"id":"79fa4dd6-fd3f-40e4-9194-a32d727d1793","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"apikey {username}:{apikey}"},{"key":"Timestamp","type":"text","value":"{timestamp}"},{"key":"Content-type","type":"text","value":"application/json"}],"url":"https://api.eworkorders.com/v1/purchaseorders","description":"List purchase orders
\n| Parameter | \nType | \nDescription | \n
| status_num | \nint | \nUnique status identifier (1 = Open, 4 = Completed) | \n
| notes | \nstring | \nNotes (will check if input value is contained in the notes) | \n
| contains_item | \nint | \nUnique item identifier (of item on PO) | \n
| approved_by | \nstring | \nApproved By | \n
| item_count | \nint | \nNumber of items on PO | \n
| vendor | \nstring | \nVendor | \n
| ordered_by | \nstring | \nOrdered By | \n
| ordered_from | \ndate/time | \nPurchase order from date | \n
| ordered_to | \ndate/time | \nPurchase order to date | \n
| printed_from | \ndate/time | \nPurchase order printed from date | \n
| printed_to | \ndate/time | \nPurchase order printed to date | \n
| emailed_from | \ndate/time | \nPurchase order emailed from date | \n
| emailed_to | \ndate/time | \nPurchase order emailed to date | \n
| shipped_from | \ndate/time | \nPurchase order shipped from date | \n
| shipped_to | \ndate/time | \nPurchase order shipped to date | \n
| approved_from | \ndate/time | \nPurchase order approved from date | \n
| approved_to | \ndate/time | \nPurchase order approved to date | \n
| price_from | \nint | \nPurchase order subtotal price amount from | \n
| price_to | \nint | \nPurchase order subtotal price amount to | \n
Create a new purchase order. (Purchase orders created via the API have a status of \"completed\".)
\n| Parameter | \nType | \nDescription | \n
| inventory_department | \nint | \nRequired Inventory department unique identifier | \n
| order_date | \ndate | \nRequired Date(time) purchase order was created. | \n
| ven_num | \nint | \nDefault vendor unique identifier If this and vendor are both blank, the first vendor found will be the default. | \n
| vendor | \nstring | \nDefault vendor | \n
| con_num | \nint | \nDefault contact unique identifier | \n
| contact | \nstring | \nDefault contact | \n
| vendor_po | \nstring | \nVendor's PO number | \n
| ordered_by | \nstring | \nName of the person creating the PO | \n
| emailed | \nboolean | \nMark the PO as emailed (0 is false, 1 is true) | \n
| printed | \nboolean | \nMark the PO as printed (0 is false, 1 is true) | \n
| print_date | \ndate | \nPrint date | \n
| approved | \nboolean | \nMark the PO as approved (0 is false, 1 is true) | \n
| approve_date | \ndate | \nApprove date | \n
| shipping | \nfloat | \nShipping cost | \n
| shipping_date | \ndate | \nShipping date | \n
| tax | \nfloat | \nTax cost | \n
| items | \narray | \nAny amount of order lines related to this PO The parameters below are required/optional fields for each order line in this array | \n
| item_num | \nint | \n*Required Item unique identifier. | \n
| item_desc | \nstring | \n*Required Item description | \n
| item_number | \nstring | \n*Required Unique item number | \n
| stockroom_num | \nint | \n*Required Stockroom unique identifier. | \n
| stockroom_desc | \nstring | \n*Required Stockroom | \n
| quantity | \nnumber | \nRequired Number of parts being ordered Quantities are in purchase units. | \n
| quantity_received | \nnumber | \nNumber of parts being received Quantities are in purchase units. If left blank it will default to the full number of parts ordered. | \n
| unit_price | \nfloat | \nCost of a single item. The total line cost will be calculated based on the unit_price and the quantity ordered | \n
| vendor_item_number | \nstring | \nVendor's item number | \n
| shelved | \ndate | \nDate(time) that items were received. If left blank it will default to the order_date above. | \n
| expected | \ndate | \nDate(time) that items were expected to be received. | \n
Create multiple new purchase orders with one request. (Purchase orders created via the API have a status of \"completed\".)
\nThe body of the request must contain an array of purchase order objects. You must include the 'bulk' parameter in the request URL.
\nParameter | Type | Description |
inventory_department | int | Required Inventory department unique identifier |
order_date | date | Required Date(time) purchase order was created. |
ven_num | int | Default vendor unique identifier If this and vendor are both blank, the first vendor found will be the default. |
vendor | string | Default vendor |
con_num | int | Default contact unique identifier |
contact | string | Default contact |
vendor_po | string | Vendor's PO number |
ordered_by | string | Name of the person creating the PO |
emailed | boolean | Mark the PO as emailed (0 is false, 1 is true) |
printed | boolean | Mark the PO as printed (0 is false, 1 is true) |
print_date | date | Print date |
approved | boolean | Mark the PO as approved (0 is false, 1 is true) |
approve_date | date | Approve date |
shipping | float | Shipping cost |
shipping_date | date | Shipping date |
tax | float | Tax cost |
items | array | Any amount of order lines related to this PO The parameters below are required/optional fields for each order line in this array |
item_num | int | \\\\\\*Required Item unique identifier. |
item_desc | string | \\\\\\*Required Item description |
item_number | string | \\\\\\*Required Unique item number |
stockroom_num | int | \\\\\\*Required Stockroom unique identifier. |
stockroom_desc | string | \\\\\\*Required Stockroom |
quantity | number | Required Number of parts being ordered Quantities are in purchase units. |
quantity_received | number | Number of parts being received Quantities are in purchase units. If left blank it will default to the full number of parts ordered. |
unit_price | float | Cost of a single item. The total line cost will be calculated based on the unit_price and the quantity ordered |
vendor_item_number | string | Vendor's item number |
shelved | date | Date(time) that items were received. If left blank it will default to the order_date above. |
expected | date | Date(time) that items were expected to be received. |
Update the active status of an asset.
\nParameter | Type | Description |
vendor_po | String | Vendor PO# |
List purchase returns
\n| Parameter | Type | Description |
| status_num | int | Unique status identifier (1 = Open, 4 = Completed) |
| notes | string | Notes (will check if input value is contained in the notes) |
| contains_item | int | Unique item identifier (of item on Purchase return) |
| approved_by | string | Approved By |
| item_count | int | Number of items on Purchase return |
| vendor | string | Vendor |
| returned_by | string | Returned By |
| returned_from | date/time | Purchase return from date |
| returned_to | date/time | Purchase return to date |
| printed_from | date/time | Purchase return printed from date |
| printed_to | date/time | Purchase return printed to date |
| emailed_from | date/time | Purchase return emailed from date |
| emailed_to | date/time | Purchase return emailed to date |
| approved_from | date/time | Purchase return approved from date |
| approved_to | date/time | Purchase return approved to date |
| price_from | int | Purchase return subtotal price amount from |
| price_to | int | Purchase return subtotal price amount to |
List Inventory Orders
\nParameter | Type | Description |
status_num | int | Unique status identifier (1 = Open, 4 = Completed) |
notes | string | Notes (will check if input value is contained in the notes) |
contains_item | int | Unique item identifier (of item on IO) |
printed | int | 0 = no, 1 = yes |
approved | int | 0 = no, 1= yes |
approved_by | string | Approved By |
item_count | int | Number of items on IO |
wo_number | int | Work Order Number (associated with this IO) |
ordered_by | string | Ordered By |
ordered_from | date/time | Inventory Order from date |
ordered_to | date/time | Inventory Order to date |
printed_from | date/time | Inventory Order Printed from date |
printed_to | date/time | Inventory Order Printed to date |
approved_from | date/time | Inventory Order Approved from date |
approved_to | date/time | Inventory Order Approved to date |
price_from | int | Inventory Order subtotal price amount from |
price_to | int | Inventory Order subtotal price amount to |
unshelved_from | date/time | Inventory Order Item Unshelved from date |
unshelved_to | date/time | Inventory Order Item Unshelved to date |
Get Line Items for a specific Inventory Order.
\nParameter | Type | Description |
unshelved_from | date/time | Inventory Order Item Unshelved from date |
unshelved_to | date/time | Inventory Order Item Unshelved to date |
Create a new inventory order. (Inventory orders created via the API have a status of \"completed\".)
\nParameter | Type | Description |
inventory_department | int | Required Inventory department unique identifier |
workorder_num | integer | Required Work order for which the inventory order is being created |
order_date | date | Order date If blank will default to current date and time |
ordered_by | string | Name of the person creating the inventory order |
budget | string | Budget code |
printed | boolean | Mark the inventory order as printed (0 is false, 1 is true) |
print_date | date | Print date |
approved | boolean | Mark the inventory order as approved (0 is false, 1 is true) |
approve_date | date | Approve date |
items | array | Any amount of order lines related to this inventory order The parameters below are required/optional fields for each order line in this array |
item_num | int | \\*Required Item unique identifier. |
item_desc | string | \\*Required Item description |
item_number | string | \\*Required Unique item number |
stockroom_num | int | \\*Required Stockroom unique identifier. |
stockroom_desc | string | \\*Required Stockroom |
quantity | number | Required Number of parts being ordered Quantities are in internal units. |
unit_price | float | Cost of a single item. This field will only be used if the accounting method is Set Defined Price. The total line cost will be calculated based on the unit_price and the quantity ordered |
unshelved | date | Date(time) that items were removed from inventory. If left blank it will default to the order_date above. |
List Inventory Returns
\n| Parameter | Type | Description |
| status_num | int | Unique status identifier (1 = Open, 4 = Completed) |
| notes | string | Notes (will check if input value is contained in the notes) |
| contains_item | int | Unique item identifier (of item on IR) |
| printed | int | 0 = no, 1 = yes |
| approved | int | 0 = no, 1= yes |
| approved_by | string | Approved By |
| item_count | int | Number of items on IR |
| wo_number | int | Work Order Number (associated with this IR) |
| returned_by | string | Returned By |
| returned_from | date/time | Inventory Return from date |
| returned_to | date/time | Inventory Return to date |
| printed_from | date/time | Inventory Order Printed from date |
| printed_to | date/time | Inventory Order Printed to date |
| approved_from | date/time | Inventory Order Approved from date |
| approved_to | date/time | Inventory Order Approved to date |
| price_from | int | Inventory Order subtotal price amount from |
| price_to | int | Inventory Order subtotal price amount to |
Create a new inventory return. (Inventory returns created via the API have a status of \"completed\".)
\n| Parameter | \nType | \nDescription | \n
| inventory_department | \nint | \nRequired Inventory department unique identifier | \n
| workorder_num | \ninteger | \nRequired Work order for which the inventory return is being created | \n
| return_date | \ndate | \nReturn date If blank will default to current date and time | \n
| returned_by | \nstring | \nName of the person creating the inventory return | \n
| budget | \nstring | \nBudget code | \n
| printed | \nboolean | \nMark the inventory retrun as printed (0 is false, 1 is true) | \n
| print_date | \ndate | \nPrint date | \n
| approved | \nboolean | \nMark the inventory return as approved (0 is false, 1 is true) | \n
| approve_date | \ndate | \nApprove date | \n
| items | \narray | \nAny amount of order lines related to this inventory return The parameters below are required/optional fields for each order line in this array | \n
| item_num | \nint | \n*Required Item unique identifier. | \n
| item_desc | \nstring | \n*Required Item description | \n
| item_number | \nstring | \n*Required Unique item number | \n
| stockroom_num | \nint | \n*Required Stockroom unique identifier. | \n
| stockroom_desc | \nstring | \n*Required Stockroom | \n
| quantity | \nnumber | \nRequired Number of parts being returned Quantities are in internal units. | \n
| unit_price | \nfloat | \nCost of a single item. This field will only be used if the accounting method is Set Defined Price. The total line cost will be calculated based on the unit_price and the quantity ordered | \n
| shelved | \ndate | \nDate(time) that items were returned to inventory. If left blank it will default to the return_date above. | \n
List Transfer Orders
\n| Parameter | Type | Description |
| status_num | int | Unique status identifier (1 = Open, 4 = Completed) |
| notes | string | Notes (will check if input value is contained in the notes) |
| contains_item | int | Unique item identifier (of item on TO) |
| withdrawal_stockroom | int | Unique stockroom identifier (that the items were withdrawn from) |
| receival_stockroom | int | Unique stockroom identifier (that the items were transfered to) |
| item_count | int | Number of items on TO |
| received_by | string | Received By |
| withdrawn_by | string | Withdrawn By |
| ordered_from | date/time | Transfer Order from date |
| ordered_to | date/time | Transfer Order to date |
List Counting Orders
\n| Parameter | Type | Description |
| status_num | int | Unique status identifier (1 = Open, 4 = Completed) |
| notes | string | Notes (will check if input value is contained in the notes) |
| contains_item | int | Unique item identifier (of item on CO) |
| item_count | int | Number of items on CO |
| counters_name | string | Name of the person counting |
| ordered_from | date/time | Counting Order from date |
| ordered_to | date/time | Counting Order to date |
| Parameter | \nType | \nDescription | \n
| start_date | \ndate | \nRequired Date labor or materials were entered - greater than or equal to this date | \n
| end_date | \ndate | \nRequired Date labor or materials were entered - lesser than or equal to this date | \n
| workorder_num | \nint | \nUnique work order identifier | \n
| workorder_prior_num | \nint | \nUnique work order priority identifier | \n
| workorder_area_num | \nint | \nUnique asset area identifier on the work order | \n
| workorder_asset_num | \nint | \nUnique asset identifier on the work order | \n
| workorder_cat_num | \nint | \nUnique asset category identifier on the work order | \n
| workorder_critical_num | \nint | \nUnique asset criticality identifier on the work order | \n
| asset_user_field# | \nstring \n number \n date \n datetime | \nValue of an asset user field \n Examples: \n workorder_user_field7 = 'Yellow' \n workorder_user_field9 = 20 \nworkorder_user_field21 = '12/31/2021'\n | \n
| asset_user_field#_from | \nnumber \n date\ndatetime\n | \nValue of an asset user field \n Examples: \n workorder_user_field7_from = '1/1/2021'\nworkorder_user_field9_from = 20\n | \n
| asset_user_field#_to | \nnumber \n date \n datetime\n | \nValue of an asset user field \n Examples: \n workorder_user_field7_from = '12/31/2021'\nworkorder_user_field9_from = 20\n | \n
Get all customers.
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","customers"],"host":["api","eworkorders","com"],"query":[],"variable":[]}},"response":[{"id":"2fc1a1b9-daee-47ca-bf02-c243df791c0b","name":"List Customers","originalRequest":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"apikey {username}:{apikey}","type":"text"},{"key":"Timestamp","value":"{timestamp}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.eworkorders.com/v1/customers"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"super_num\": 1,\r\n \"customer_num\": \"3\",\r\n \"first_name\": \"Richard\",\r\n \"middle_name\": \"J\",\r\n \"last_name\": \"Doe\",\r\n \"location1\": \"1 First Street\",\r\n \"city\": \"Trenton\",\r\n \"state\": \"New Jersey\",\r\n \"zip\": \"08601\",\r\n \"country\": \"United States\",\r\n \"company\": \"The Lighting Group\",\r\n \"field1\": \"7572\",\r\n \"field2\": \"436343346\"\r\n },\r\n {\r\n \"super_num\": 1,\r\n \"customer_num\": \"4\",\r\n \"first_name\": \"John\",\r\n \"middle_name\": \"K\",\r\n \"last_name\": \"Kaplan\",\r\n \"location1\": \"123 Avenue B\",\r\n \"city\": \"Newark\",\r\n \"state\": \"New Jersey\",\r\n \"zip\": \"07101\",\r\n \"country\": \"United States\",\r\n \"company\": \"Google\",\r\n \"field1\": \"463\",\r\n \"field2\": \"909222135\"\r\n }\r\n]"}],"_postman_id":"77841534-07c4-4c4e-b58b-7d1a7c84273a"},{"name":"Get Customer","id":"8fefb136-0228-4cd4-a174-b59f48e824f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"apikey {username}:{apikey}","type":"text"},{"key":"Timestamp","value":"{timestamp}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.eworkorders.com/v1/customers/{customer_num}","description":"Get a specific customer by customer_num.
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fc60234f-35bd-4719-ac63-539218160abe","id":"fc60234f-35bd-4719-ac63-539218160abe","name":"eWorkorders API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","customers","{customer_num}"],"host":["api","eworkorders","com"],"query":[],"variable":[]}},"response":[{"id":"634466ca-114a-4b2e-827f-e282e1c92de0","name":"Get Customer","originalRequest":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"apikey {username}:{apikey}","type":"text"},{"key":"Timestamp","value":"{timestamp}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.eworkorders.com/v1/customers/4"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"super_num\": 1,\r\n \"customer_num\": \"4\",\r\n \"first_name\": \"John\",\r\n \"middle_name\": \"K\",\r\n \"last_name\": \"Kaplan\",\r\n \"location1\": \"123 Avenue B\",\r\n \"city\": \"Newark\",\r\n \"state\": \"New Jersey\",\r\n \"zip\": \"07101\",\r\n \"country\": \"United States\",\r\n \"company\": \"Google\",\r\n \"field1\": \"463\",\r\n \"field2\": \"909222135\"\r\n }\r\n]"}],"_postman_id":"8fefb136-0228-4cd4-a174-b59f48e824f0"},{"name":"Update Customer","id":"2722d748-f0db-471a-a720-1de223169fca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"apikey {username}:{apikey}","type":"text"},{"key":"Timestamp","value":"{timestamp}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"active\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.eworkorders.com/v1/customers/{customer_num}","description":"Update the active status of a specific customer.
\nParameter | Type | Description |
active | boolean | Active Status |
Add a vendor.
\nParameter | Type | Description |
vendor | string | **Required Vendor name |
ven_number | string | Vendor ID number |
default_ven_po | string | Default Vendor PO# |
phone | string | Phone # |
purpose | string | Purpose |
fax | string | Fax |
addr1 | string | Address 1 |
addr2 | string | Address 2 |
addr3 | string | Address 3 |
city | string | City |
state | string | State |
zip | string | Zipcode |
country | string | Country |
email | string | Email |
notes | string | Notes |
coi_date | date | General Liability Date |
workers_compensation_date | date | Workman's Compensation Date |
automobile_date | date | Auto Ins Date |
active | boolean | Active? 1 for yes, 0 for no |
supplies_workers | boolean | Supplies workers? 1 for yes, 0 for no |