Work Order

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

PropertyCaptionData TypeRequiredCan Update with PUT
ItemRefItemEntityRefTrueFalse
DocNoNo.Int32FalseFalse
DateDateDateTimeTrueFalse
PromiseDatePromise DateDateTimeFalseTrue
StatusRefStatusEntityRefFalseTrue
ClassRefClassEntityRefFalseTrue
InstructionsInstructionsString (4000)FalseTrue
MemoMemoString (4000)FalseTrue
StepsStepsArray of WorkOrderStep,  
Each WorkOrderStep
contains an array of
WorkOrderComponent 
FalseFalse
CustomFieldsCustom FieldsArray of CustomFieldDataFalseTrue

Properties - Work Order Component

PropertyCaptionData TypeRequiredRead Only
$typeThis property MUST be included to tell the API what type of item is being added.
The value should be "AOLib7.WorkOrderComponent, AOLib7"
IdIdInt32FalseTrue
LineNoLine NoInt16FalseTrue
ItemRefItemEntityRefTrueFalse
StepRefUOMEntityRefTrueFalse
DescriptionDescriptionString (4000)FalseFalse
LineInstructionsLine InstructionsString (4000)FalseFalse
UomRefUOMEntityRefFalseFalse
UomConversionRateUOM Conversion RateDecimalFalseFalse
QuantityRequiredRequiredDecimalTrueFalse
QuantityQuantityDecimalFalseFalse
StdCostStd. CostDecimalFalseTrue
CustomFieldsCustom FieldsArray of CustomFieldDataFalseFalse

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"
     }
}

Top

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.