GET | /Debtors/{DebtorID}/Notes/{NoteID} | Retrieves a debtor note. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DebtorID | path | string | No | |
NoteID | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NoteID | form | string | No | |
NoteType | form | NoteType | No | |
LineNo | form | int? | No | |
LastSavedDateTime | form | DateTime? | No | |
LastModifiedByStaffID | form | string | No | |
LastModifiedByStaffUsername | form | string | No | |
LastModifiedByStaffTitle | form | string | No | |
LastModifiedByStaffFirstName | form | string | No | |
LastModifiedByStaffSurname | form | string | No | |
NoteText | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NoteTypeID | form | string | No | |
Description | form | string | No | |
DefaultType | form | bool? | No | |
ItemNo | form | int? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Debtors/{DebtorID}/Notes/{NoteID} HTTP/1.1 Host: api.jiwa.com.au Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv 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"}