JiwaAPI

<back to all web services

BillPATCHRequest

Requires Authentication
The following routes are available for this service:
PATCH/Bills/{BillID}Updates a bill record.
BillPATCHRequest Parameters:
NameParameterData TypeRequiredDescription
BillIDpathstringNo
Bill Parameters:
NameParameterData TypeRequiredDescription
BillIDformstringNo
BillNoformstringNo
DescriptionformstringNo
IsEnabledformbool?No
MaximumProductionCapabilityformdecimal?No
LastSavedDateTimeformDateTime?No
RowHashformbyte[]No
StagesformList<BillStage>No
OutputsformList<BillOutput>No
DocumentsformList<Document>No
CustomFieldValuesformList<CustomFieldValue>No
NotesformList<Note>No
ProductionLineformProductionLineNo
BillParentsformList<BillParent>No
BillStage Parameters:
NameParameterData TypeRequiredDescription
StageIDformstringNo
ItemNoformint?No
NameformstringNo
RequiredCapacityformdecimal?No
ProductionLineWorkCentreformProductionLineWorkCentreNo
InputsformList<BillInput>No
InstructionsformList<BillInstruction>No
CustomFieldValuesformList<CustomFieldValue>No
ProductionLineWorkCentre Parameters:
NameParameterData TypeRequiredDescription
ProductionLineWorkCentreIDformstringNo
WorkCentreformWorkCentreNo
WorkCentre Parameters:
NameParameterData TypeRequiredDescription
WorkCentreIDformstringNo
NameformstringNo
DescriptionformstringNo
Capacityformdecimal?No
IsEnabledformbool?No
BillInput Parameters:
NameParameterData TypeRequiredDescription
InputIDformstringNo
ItemNoformint?No
InventoryIDformstringNo
PartNoformstringNo
DescriptionformstringNo
IsRatioformbool?No
Quantityformdecimal?No
NoteformstringNo
IsBoMItemformbool?No
SubAssemblyBillIDformstringNo
SubAssemblyExplodePolicyformSubAssemblyExplodePolicyOptions?No
CustomFieldValuesformList<CustomFieldValue>No
TotalLineCostformdecimal?No
LastCostformdecimal?No
UnitMeasureformstringNo
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo
BillInstruction Parameters:
NameParameterData TypeRequiredDescription
InstructionIDformstringNo
ItemNoformint?No
InstructionTextformstringNo
CustomFieldValuesformList<CustomFieldValue>No
BillOutput Parameters:
NameParameterData TypeRequiredDescription
OutputIDformstringNo
ItemNoformint?No
InventoryIDformstringNo
PartNoformstringNo
DescriptionformstringNo
IsRatioformbool?No
Quantityformdecimal?No
NoteformstringNo
IsPrimaryformbool?No
CostPercentageformdecimal?No
Costformdecimal?No
LastCostformdecimal?No
CustomFieldValuesformList<CustomFieldValue>No
Document Parameters:
NameParameterData TypeRequiredDescription
DocumentIDformstringNo
DocumentTypeformDocumentTypeNo
FileIDformstringNo
PhysicalFileNameformstringNo
FullPhysicalFileNameformstringNo
DescriptionformstringNo
LastSavedDateTimeformDateTime?No
LastModifiedByStaffIDformstringNo
LastModifiedByStaffUsernameformstringNo
LastModifiedByStaffTitleformstringNo
LastModifiedByStaffFirstNameformstringNo
LastModifiedByStaffSurnameformstringNo
FileBinaryformbyte[]No
DocumentType Parameters:
NameParameterData TypeRequiredDescription
DocumentTypeIDformstringNo
DescriptionformstringNo
DefaultTypeformbool?No
ItemNoformint?No
Note Parameters:
NameParameterData TypeRequiredDescription
NoteIDformstringNo
NoteTypeformNoteTypeNo
LineNoformint?No
LastSavedDateTimeformDateTime?No
LastModifiedByStaffIDformstringNo
LastModifiedByStaffUsernameformstringNo
LastModifiedByStaffTitleformstringNo
LastModifiedByStaffFirstNameformstringNo
LastModifiedByStaffSurnameformstringNo
NoteTextformstringNo
NoteType Parameters:
NameParameterData TypeRequiredDescription
NoteTypeIDformstringNo
DescriptionformstringNo
DefaultTypeformbool?No
ItemNoformint?No
ProductionLine Parameters:
NameParameterData TypeRequiredDescription
ProductionLineIDformstringNo
NameformstringNo
DescriptionformstringNo
IsEnabledformbool?No
ProductionAreaformProductionAreaNo
ProductionArea Parameters:
NameParameterData TypeRequiredDescription
ProductionAreaIDformstringNo
ProductionAreaNoformstringNo
NameformstringNo
DescriptionformstringNo
IsEnabledformbool?No
BillParent Parameters:
NameParameterData TypeRequiredDescription
BillIDformstringNo
BillNoformstringNo
DescriptionformstringNo
Bill Parameters:
NameParameterData TypeRequiredDescription
BillIDformstringNo
BillNoformstringNo
DescriptionformstringNo
IsEnabledformbool?No
MaximumProductionCapabilityformdecimal?No
LastSavedDateTimeformDateTime?No
RowHashformbyte[]No
StagesformList<BillStage>No
OutputsformList<BillOutput>No
DocumentsformList<Document>No
CustomFieldValuesformList<CustomFieldValue>No
NotesformList<Note>No
ProductionLineformProductionLineNo
BillParentsformList<BillParent>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /Bills/{BillID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"BillID":"String","BillNo":"String","Description":"String","IsEnabled":false,"MaximumProductionCapability":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","RowHash":"AA==","Stages":[{"StageID":"String","ItemNo":0,"Name":"String","RequiredCapacity":0,"ProductionLineWorkCentre":{"ProductionLineWorkCentreID":"String","WorkCentre":{"WorkCentreID":"String","Name":"String","Description":"String","Capacity":0,"IsEnabled":false}},"Inputs":[{"InputID":"String","ItemNo":0,"InventoryID":"String","PartNo":"String","Description":"String","IsRatio":false,"Quantity":0,"Note":"String","IsBoMItem":false,"SubAssemblyBillID":"String","SubAssemblyExplodePolicy":"AlwaysExplode","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"TotalLineCost":0,"LastCost":0,"UnitMeasure":"String"}],"Instructions":[{"InstructionID":"String","ItemNo":0,"InstructionText":"String","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}],"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}],"Outputs":[{"OutputID":"String","ItemNo":0,"InventoryID":"String","PartNo":"String","Description":"String","IsRatio":false,"Quantity":0,"Note":"String","IsPrimary":false,"CostPercentage":0,"Cost":0,"LastCost":0,"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}],"Documents":[{"DocumentID":"String","DocumentType":{"DocumentTypeID":"String","Description":"String","DefaultType":false,"ItemNo":0},"FileID":"String","PhysicalFileName":"String","FullPhysicalFileName":"String","Description":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastModifiedByStaffID":"String","LastModifiedByStaffUsername":"String","LastModifiedByStaffTitle":"String","LastModifiedByStaffFirstName":"String","LastModifiedByStaffSurname":"String","FileBinary":"AA=="}],"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"Notes":[{"NoteID":"String","NoteType":{"NoteTypeID":"String","Description":"String","DefaultType":false,"ItemNo":0},"LineNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastModifiedByStaffID":"String","LastModifiedByStaffUsername":"String","LastModifiedByStaffTitle":"String","LastModifiedByStaffFirstName":"String","LastModifiedByStaffSurname":"String","NoteText":"String"}],"ProductionLine":{"ProductionLineID":"String","Name":"String","Description":"String","IsEnabled":false,"ProductionArea":{"ProductionAreaID":"String","ProductionAreaNo":"String","Name":"String","Description":"String","IsEnabled":false}},"BillParents":[{"BillID":"String","BillNo":"String","Description":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"BillID":"String","BillNo":"String","Description":"String","IsEnabled":false,"MaximumProductionCapability":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","RowHash":"AA==","Stages":[{"StageID":"String","ItemNo":0,"Name":"String","RequiredCapacity":0,"ProductionLineWorkCentre":{"ProductionLineWorkCentreID":"String","WorkCentre":{"WorkCentreID":"String","Name":"String","Description":"String","Capacity":0,"IsEnabled":false}},"Inputs":[{"InputID":"String","ItemNo":0,"InventoryID":"String","PartNo":"String","Description":"String","IsRatio":false,"Quantity":0,"Note":"String","IsBoMItem":false,"SubAssemblyBillID":"String","SubAssemblyExplodePolicy":"AlwaysExplode","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"TotalLineCost":0,"LastCost":0,"UnitMeasure":"String"}],"Instructions":[{"InstructionID":"String","ItemNo":0,"InstructionText":"String","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}],"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}],"Outputs":[{"OutputID":"String","ItemNo":0,"InventoryID":"String","PartNo":"String","Description":"String","IsRatio":false,"Quantity":0,"Note":"String","IsPrimary":false,"CostPercentage":0,"Cost":0,"LastCost":0,"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}],"Documents":[{"DocumentID":"String","DocumentType":{"DocumentTypeID":"String","Description":"String","DefaultType":false,"ItemNo":0},"FileID":"String","PhysicalFileName":"String","FullPhysicalFileName":"String","Description":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastModifiedByStaffID":"String","LastModifiedByStaffUsername":"String","LastModifiedByStaffTitle":"String","LastModifiedByStaffFirstName":"String","LastModifiedByStaffSurname":"String","FileBinary":"AA=="}],"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"Notes":[{"NoteID":"String","NoteType":{"NoteTypeID":"String","Description":"String","DefaultType":false,"ItemNo":0},"LineNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastModifiedByStaffID":"String","LastModifiedByStaffUsername":"String","LastModifiedByStaffTitle":"String","LastModifiedByStaffFirstName":"String","LastModifiedByStaffSurname":"String","NoteText":"String"}],"ProductionLine":{"ProductionLineID":"String","Name":"String","Description":"String","IsEnabled":false,"ProductionArea":{"ProductionAreaID":"String","ProductionAreaNo":"String","Name":"String","Description":"String","IsEnabled":false}},"BillParents":[{"BillID":"String","BillNo":"String","Description":"String"}]}