JiwaAPI

<back to all web services

SalesOrderHistoryConsignmentNotesPOSTRequest

Requires Authentication
The following routes are available for this service:
POST/SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/Carrier/ConsignmentNotesAdds a consignment note to a sales order history
SalesOrderHistoryConsignmentNotesPOSTRequest Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDpathstringNo
InvoiceHistoryIDpathstringNo
SalesOrderConsignmentNote Parameters:
NameParameterData TypeRequiredDescription
ConsignmentNoteIDformstringNo
ConsignmentNoteDateformDateTime?No
ExGSTAmountformdecimal?No
GSTAmountformdecimal?No
ConsignmentNoteNoformstringNo
SalesOrderConsignmentNote Parameters:
NameParameterData TypeRequiredDescription
ConsignmentNoteIDformstringNo
ConsignmentNoteDateformDateTime?No
ExGSTAmountformdecimal?No
GSTAmountformdecimal?No
ConsignmentNoteNoformstringNo

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.

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

<SalesOrderHistoryConsignmentNotesPOSTRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel">
  <_x003C_ConsignmentNoteDate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0001-01-01T00:00:00</_x003C_ConsignmentNoteDate_x003E_k__BackingField>
  <_x003C_ConsignmentNoteID_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders" />
  <_x003C_ConsignmentNoteNo_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">String</_x003C_ConsignmentNoteNo_x003E_k__BackingField>
  <_x003C_ExGSTAmount_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0</_x003C_ExGSTAmount_x003E_k__BackingField>
  <_x003C_GSTAmount_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0</_x003C_GSTAmount_x003E_k__BackingField>
  <_x003C_ConsignmentNoteID_x003E_k__BackingField>String</_x003C_ConsignmentNoteID_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>
</SalesOrderHistoryConsignmentNotesPOSTRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SalesOrderConsignmentNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 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>
</SalesOrderConsignmentNote>