JiwaAPI

<back to all web services

SalesOrderHistoryConsignmentNotesPATCHRequest

Requires Authentication
The following routes are available for this service:
PATCH/SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/Carrier/ConsignmentNotes/{ConsignmentNoteID}Updates a consignment note for a sales order history
SalesOrderHistoryConsignmentNotesPATCHRequest Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDpathstringNo
InvoiceHistoryIDpathstringNo
ConsignmentNoteIDpathstringNo
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 .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 /SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/Carrier/ConsignmentNotes/{ConsignmentNoteID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"InvoiceID":"String","InvoiceHistoryID":"String","ConsignmentNoteID":"String","ConsignmentNoteDate":"0001-01-01T00:00:00.0000000","ExGSTAmount":0,"GSTAmount":0,"ConsignmentNoteNo":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ConsignmentNoteID":"String","ConsignmentNoteDate":"0001-01-01T00:00:00.0000000","ExGSTAmount":0,"GSTAmount":0,"ConsignmentNoteNo":"String"}