JiwaAPI

<back to all web services

SalesOrderHistoryFreightItemsPATCHRequest

Requires Authentication
The following routes are available for this service:
PATCH/SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/Carrier/FreightItems/{FreightItemID}Updates a freight item for a sales order history
SalesOrderHistoryFreightItemsPATCHRequest Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDpathstringNo
InvoiceHistoryIDpathstringNo
FreightItemIDpathstringNo
SalesOrderFreightItem Parameters:
NameParameterData TypeRequiredDescription
FreightItemIDformstringNo
NumberItemsformint?No
ItemWeightformdecimal?No
ItemCubicformdecimal?No
ItemLengthformdecimal?No
ItemWidthformdecimal?No
ItemHeightformdecimal?No
ReferenceformstringNo
FreightDescriptionformSalesOrderCarrierFreightDescriptionNo
ConsignmentNoteformSalesOrderConsignmentNoteNo
SalesOrderCarrierFreightDescription Parameters:
NameParameterData TypeRequiredDescription
CarrierFreightDescriptionIDformstringNo
DescriptionformstringNo
SalesOrderConsignmentNote Parameters:
NameParameterData TypeRequiredDescription
ConsignmentNoteIDformstringNo
ConsignmentNoteDateformDateTime?No
ExGSTAmountformdecimal?No
GSTAmountformdecimal?No
ConsignmentNoteNoformstringNo
SalesOrderFreightItem Parameters:
NameParameterData TypeRequiredDescription
FreightItemIDformstringNo
NumberItemsformint?No
ItemWeightformdecimal?No
ItemCubicformdecimal?No
ItemLengthformdecimal?No
ItemWidthformdecimal?No
ItemHeightformdecimal?No
ReferenceformstringNo
FreightDescriptionformSalesOrderCarrierFreightDescriptionNo
ConsignmentNoteformSalesOrderConsignmentNoteNo

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.

PATCH /SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/Carrier/FreightItems/{FreightItemID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SalesOrderHistoryFreightItemsPATCHRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel">
  <_x003C_ConsignmentNote_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">
    <_x003C_ConsignmentNoteDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ConsignmentNoteDate_x003E_k__BackingField>
    <_x003C_ConsignmentNoteID_x003E_k__BackingField>String</_x003C_ConsignmentNoteID_x003E_k__BackingField>
    <_x003C_ConsignmentNoteNo_x003E_k__BackingField>String</_x003C_ConsignmentNoteNo_x003E_k__BackingField>
    <_x003C_ExGSTAmount_x003E_k__BackingField>0</_x003C_ExGSTAmount_x003E_k__BackingField>
    <_x003C_GSTAmount_x003E_k__BackingField>0</_x003C_GSTAmount_x003E_k__BackingField>
  </_x003C_ConsignmentNote_x003E_k__BackingField>
  <_x003C_FreightDescription_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">
    <_x003C_CarrierFreightDescriptionID_x003E_k__BackingField>String</_x003C_CarrierFreightDescriptionID_x003E_k__BackingField>
    <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
  </_x003C_FreightDescription_x003E_k__BackingField>
  <_x003C_FreightItemID_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders" />
  <_x003C_ItemCubic_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0</_x003C_ItemCubic_x003E_k__BackingField>
  <_x003C_ItemHeight_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0</_x003C_ItemHeight_x003E_k__BackingField>
  <_x003C_ItemLength_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0</_x003C_ItemLength_x003E_k__BackingField>
  <_x003C_ItemWeight_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0</_x003C_ItemWeight_x003E_k__BackingField>
  <_x003C_ItemWidth_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0</_x003C_ItemWidth_x003E_k__BackingField>
  <_x003C_NumberItems_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0</_x003C_NumberItems_x003E_k__BackingField>
  <_x003C_Reference_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">String</_x003C_Reference_x003E_k__BackingField>
  <_x003C_FreightItemID_x003E_k__BackingField>String</_x003C_FreightItemID_x003E_k__BackingField>
  <_x003C_InvoiceHistoryID_x003E_k__BackingField>String</_x003C_InvoiceHistoryID_x003E_k__BackingField>
  <_x003C_InvoiceID_x003E_k__BackingField>String</_x003C_InvoiceID_x003E_k__BackingField>
</SalesOrderHistoryFreightItemsPATCHRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SalesOrderFreightItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">
  <_x003C_ConsignmentNote_x003E_k__BackingField>
    <_x003C_ConsignmentNoteDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ConsignmentNoteDate_x003E_k__BackingField>
    <_x003C_ConsignmentNoteID_x003E_k__BackingField>String</_x003C_ConsignmentNoteID_x003E_k__BackingField>
    <_x003C_ConsignmentNoteNo_x003E_k__BackingField>String</_x003C_ConsignmentNoteNo_x003E_k__BackingField>
    <_x003C_ExGSTAmount_x003E_k__BackingField>0</_x003C_ExGSTAmount_x003E_k__BackingField>
    <_x003C_GSTAmount_x003E_k__BackingField>0</_x003C_GSTAmount_x003E_k__BackingField>
  </_x003C_ConsignmentNote_x003E_k__BackingField>
  <_x003C_FreightDescription_x003E_k__BackingField>
    <_x003C_CarrierFreightDescriptionID_x003E_k__BackingField>String</_x003C_CarrierFreightDescriptionID_x003E_k__BackingField>
    <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
  </_x003C_FreightDescription_x003E_k__BackingField>
  <_x003C_FreightItemID_x003E_k__BackingField>String</_x003C_FreightItemID_x003E_k__BackingField>
  <_x003C_ItemCubic_x003E_k__BackingField>0</_x003C_ItemCubic_x003E_k__BackingField>
  <_x003C_ItemHeight_x003E_k__BackingField>0</_x003C_ItemHeight_x003E_k__BackingField>
  <_x003C_ItemLength_x003E_k__BackingField>0</_x003C_ItemLength_x003E_k__BackingField>
  <_x003C_ItemWeight_x003E_k__BackingField>0</_x003C_ItemWeight_x003E_k__BackingField>
  <_x003C_ItemWidth_x003E_k__BackingField>0</_x003C_ItemWidth_x003E_k__BackingField>
  <_x003C_NumberItems_x003E_k__BackingField>0</_x003C_NumberItems_x003E_k__BackingField>
  <_x003C_Reference_x003E_k__BackingField>String</_x003C_Reference_x003E_k__BackingField>
</SalesOrderFreightItem>