JiwaAPI

<back to all web services

SalesOrderNotePATCHRequest

Requires Authentication
The following routes are available for this service:
PATCH/SalesOrders/{InvoiceID}/Notes/{NoteID}Updates a sales order note.
SalesOrderNotePATCHRequest Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDpathstringNo
NoteIDpathstringNo
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
Note Parameters:
NameParameterData TypeRequiredDescription
NoteIDformstringNo
NoteTypeformNoteTypeNo
LineNoformint?No
LastSavedDateTimeformDateTime?No
LastModifiedByStaffIDformstringNo
LastModifiedByStaffUsernameformstringNo
LastModifiedByStaffTitleformstringNo
LastModifiedByStaffFirstNameformstringNo
LastModifiedByStaffSurnameformstringNo
NoteTextformstringNo

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}/Notes/{NoteID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"InvoiceID":"String","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"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"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"}