Work Order Object
Work Order is a transaction involved in the production cycle. A work order is comprised of the header (Work Order), Steps (Work Order Step) and Components (WorkOrderComponent). Using this end point you can create, delete and edit work orders at the header level including changing status. To add components, edit or delete components use the Fill Line Item end point. To add quantities the finished good or components use the quantity import end point.
End Point
/workorder
GET, POST, PUT, DELETE
GET and DELETE requests expect parameter docNo of type Int32.
Properties - Work Orders
| Property | Caption | Data Type | Required | Can Update with PUT |
| ItemRef | Item | EntityRef | True | False |
| DocNo | No. | Int32 | False | False |
| Date | Date | DateTime | True | False |
| PromiseDate | Promise Date | DateTime | False | True |
| StatusRef | Status | EntityRef | False | True |
| ClassRef | Class | EntityRef | False | True |
| Instructions | Instructions | String (4000) | False | True |
| Memo | Memo | String (4000) | False | True |
| Steps | Steps | Array of WorkOrderStep, Each WorkOrderStep contains an array of WorkOrderComponent | False | False |
| CustomFields | Custom Fields | Array of CustomFieldData | False | True |
Properties - Work Order Component
| Property | Caption | Data Type | Required | Read Only |
| $type | This property MUST be included to tell the API what type of item is being added. The value should be "AOLib7.WorkOrderComponent, AOLib7" | |||
| Id | Id | Int32 | False | True |
| LineNo | Line No | Int16 | False | True |
| ItemRef | Item | EntityRef | True | False |
| StepRef | UOM | EntityRef | True | False |
| Description | Description | String (4000) | False | False |
| LineInstructions | Line Instructions | String (4000) | False | False |
| UomRef | UOM | EntityRef | False | False |
| UomConversionRate | UOM Conversion Rate | Decimal | False | False |
| QuantityRequired | Required | Decimal | True | False |
| Quantity | Quantity | Decimal | False | False |
| StdCost | Std. Cost | Decimal | False | True |
| CustomFields | Custom Fields | Array of CustomFieldData | False | False |
Json Sample
{
"ItemRef": {
"Name": "A1000"
},
"QuantityOrdered": 10,
"BomRef": {
"Name": "V2"
},
"Memo": "This and that",
"Instructions": "Put the dongle next to the doohicky",
"PromiseDate": "2022-06-10",
"StatusRef": {
"Name": "In Production"
},
"CustomFields": [
{
"Name": "WOCust1",
"Value": "REf - 4",
"Caption": "REF"
}
}Notes
- A Post request will create the work order based on the Bill of Materials.
- Use a Put request to change status
- Use the Fill Line Item end point to add or remove components.
- Use the Bin and Lot or Serial No Quantity Import to allocate stock to components or add finished goods.
