JiwaAPI

<back to all web services

BillStageGETRequest

Requires Authentication
The following routes are available for this service:
GET/Bills/{BillID}/Stages/{StageID}Retrieves a bill stage.
BillStageGETRequest Parameters:
NameParameterData TypeRequiredDescription
BillIDpathstringNo
StageIDpathstringNo
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

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

HTTP + XML

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

GET /Bills/{BillID}/Stages/{StageID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BillStage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Bills">
  <_x003C_CustomFieldValues_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields">
    <d2p1:CustomFieldValue>
      <d2p1:_x003C_Contents_x003E_k__BackingField>String</d2p1:_x003C_Contents_x003E_k__BackingField>
      <d2p1:_x003C_PluginID_x003E_k__BackingField>String</d2p1:_x003C_PluginID_x003E_k__BackingField>
      <d2p1:_x003C_PluginName_x003E_k__BackingField>String</d2p1:_x003C_PluginName_x003E_k__BackingField>
      <d2p1:_x003C_SettingID_x003E_k__BackingField>String</d2p1:_x003C_SettingID_x003E_k__BackingField>
      <d2p1:_x003C_SettingName_x003E_k__BackingField>String</d2p1:_x003C_SettingName_x003E_k__BackingField>
    </d2p1:CustomFieldValue>
  </_x003C_CustomFieldValues_x003E_k__BackingField>
  <_x003C_Inputs_x003E_k__BackingField>
    <BillInput>
      <_x003C_CustomFieldValues_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields">
        <d4p1:CustomFieldValue>
          <d4p1:_x003C_Contents_x003E_k__BackingField>String</d4p1:_x003C_Contents_x003E_k__BackingField>
          <d4p1:_x003C_PluginID_x003E_k__BackingField>String</d4p1:_x003C_PluginID_x003E_k__BackingField>
          <d4p1:_x003C_PluginName_x003E_k__BackingField>String</d4p1:_x003C_PluginName_x003E_k__BackingField>
          <d4p1:_x003C_SettingID_x003E_k__BackingField>String</d4p1:_x003C_SettingID_x003E_k__BackingField>
          <d4p1:_x003C_SettingName_x003E_k__BackingField>String</d4p1:_x003C_SettingName_x003E_k__BackingField>
        </d4p1:CustomFieldValue>
      </_x003C_CustomFieldValues_x003E_k__BackingField>
      <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
      <_x003C_InputID_x003E_k__BackingField>String</_x003C_InputID_x003E_k__BackingField>
      <_x003C_InventoryID_x003E_k__BackingField>String</_x003C_InventoryID_x003E_k__BackingField>
      <_x003C_IsBoMItem_x003E_k__BackingField>false</_x003C_IsBoMItem_x003E_k__BackingField>
      <_x003C_IsRatio_x003E_k__BackingField>false</_x003C_IsRatio_x003E_k__BackingField>
      <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
      <_x003C_LastCost_x003E_k__BackingField>0</_x003C_LastCost_x003E_k__BackingField>
      <_x003C_Note_x003E_k__BackingField>String</_x003C_Note_x003E_k__BackingField>
      <_x003C_PartNo_x003E_k__BackingField>String</_x003C_PartNo_x003E_k__BackingField>
      <_x003C_Quantity_x003E_k__BackingField>0</_x003C_Quantity_x003E_k__BackingField>
      <_x003C_SubAssemblyBillID_x003E_k__BackingField>String</_x003C_SubAssemblyBillID_x003E_k__BackingField>
      <_x003C_SubAssemblyExplodePolicy_x003E_k__BackingField>AlwaysExplode</_x003C_SubAssemblyExplodePolicy_x003E_k__BackingField>
      <_x003C_TotalLineCost_x003E_k__BackingField>0</_x003C_TotalLineCost_x003E_k__BackingField>
      <_x003C_UnitMeasure_x003E_k__BackingField>String</_x003C_UnitMeasure_x003E_k__BackingField>
    </BillInput>
  </_x003C_Inputs_x003E_k__BackingField>
  <_x003C_Instructions_x003E_k__BackingField>
    <BillInstruction>
      <_x003C_CustomFieldValues_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields">
        <d4p1:CustomFieldValue>
          <d4p1:_x003C_Contents_x003E_k__BackingField>String</d4p1:_x003C_Contents_x003E_k__BackingField>
          <d4p1:_x003C_PluginID_x003E_k__BackingField>String</d4p1:_x003C_PluginID_x003E_k__BackingField>
          <d4p1:_x003C_PluginName_x003E_k__BackingField>String</d4p1:_x003C_PluginName_x003E_k__BackingField>
          <d4p1:_x003C_SettingID_x003E_k__BackingField>String</d4p1:_x003C_SettingID_x003E_k__BackingField>
          <d4p1:_x003C_SettingName_x003E_k__BackingField>String</d4p1:_x003C_SettingName_x003E_k__BackingField>
        </d4p1:CustomFieldValue>
      </_x003C_CustomFieldValues_x003E_k__BackingField>
      <_x003C_InstructionID_x003E_k__BackingField>String</_x003C_InstructionID_x003E_k__BackingField>
      <_x003C_InstructionText_x003E_k__BackingField>String</_x003C_InstructionText_x003E_k__BackingField>
      <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
    </BillInstruction>
  </_x003C_Instructions_x003E_k__BackingField>
  <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
  <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
  <_x003C_ProductionLineWorkCentre_x003E_k__BackingField>
    <_x003C_ProductionLineWorkCentreID_x003E_k__BackingField>String</_x003C_ProductionLineWorkCentreID_x003E_k__BackingField>
    <_x003C_WorkCentre_x003E_k__BackingField>
      <_x003C_Capacity_x003E_k__BackingField>0</_x003C_Capacity_x003E_k__BackingField>
      <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
      <_x003C_IsEnabled_x003E_k__BackingField>false</_x003C_IsEnabled_x003E_k__BackingField>
      <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
      <_x003C_WorkCentreID_x003E_k__BackingField>String</_x003C_WorkCentreID_x003E_k__BackingField>
    </_x003C_WorkCentre_x003E_k__BackingField>
  </_x003C_ProductionLineWorkCentre_x003E_k__BackingField>
  <_x003C_RequiredCapacity_x003E_k__BackingField>0</_x003C_RequiredCapacity_x003E_k__BackingField>
  <_x003C_StageID_x003E_k__BackingField>String</_x003C_StageID_x003E_k__BackingField>
</BillStage>