JiwaAPI

<back to all web services

BillNotePOSTRequest

Requires Authentication
The following routes are available for this service:
POST/Bills/{BillID}/NotesAppends a note to a bill record.
BillNotePOSTRequest Parameters:
NameParameterData TypeRequiredDescription
BillIDpathstringNo
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 .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 /Bills/{BillID}/Notes HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BillNotePOSTRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel">
  <_x003C_LastModifiedByStaffFirstName_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Notes">String</_x003C_LastModifiedByStaffFirstName_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffID_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Notes">String</_x003C_LastModifiedByStaffID_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffSurname_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Notes">String</_x003C_LastModifiedByStaffSurname_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffTitle_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Notes">String</_x003C_LastModifiedByStaffTitle_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffUsername_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Notes">String</_x003C_LastModifiedByStaffUsername_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Notes" />
  <_x003C_LineNo_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Notes">0</_x003C_LineNo_x003E_k__BackingField>
  <_x003C_NoteID_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Notes" />
  <_x003C_NoteText_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Notes">String</_x003C_NoteText_x003E_k__BackingField>
  <_x003C_NoteType_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Notes">
    <_x003C_DefaultType_x003E_k__BackingField>false</_x003C_DefaultType_x003E_k__BackingField>
    <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
    <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
    <_x003C_NoteTypeID_x003E_k__BackingField>String</_x003C_NoteTypeID_x003E_k__BackingField>
  </_x003C_NoteType_x003E_k__BackingField>
  <_x003C_BillID_x003E_k__BackingField>String</_x003C_BillID_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_NoteID_x003E_k__BackingField>String</_x003C_NoteID_x003E_k__BackingField>
</BillNotePOSTRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Note xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Notes">
  <_x003C_LastModifiedByStaffFirstName_x003E_k__BackingField>String</_x003C_LastModifiedByStaffFirstName_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffID_x003E_k__BackingField>String</_x003C_LastModifiedByStaffID_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffSurname_x003E_k__BackingField>String</_x003C_LastModifiedByStaffSurname_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffTitle_x003E_k__BackingField>String</_x003C_LastModifiedByStaffTitle_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffUsername_x003E_k__BackingField>String</_x003C_LastModifiedByStaffUsername_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_LineNo_x003E_k__BackingField>0</_x003C_LineNo_x003E_k__BackingField>
  <_x003C_NoteID_x003E_k__BackingField>String</_x003C_NoteID_x003E_k__BackingField>
  <_x003C_NoteText_x003E_k__BackingField>String</_x003C_NoteText_x003E_k__BackingField>
  <_x003C_NoteType_x003E_k__BackingField>
    <_x003C_DefaultType_x003E_k__BackingField>false</_x003C_DefaultType_x003E_k__BackingField>
    <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
    <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
    <_x003C_NoteTypeID_x003E_k__BackingField>String</_x003C_NoteTypeID_x003E_k__BackingField>
  </_x003C_NoteType_x003E_k__BackingField>
</Note>