This s a documentation page for our shiny new REST API - you weren't meant to find it. This API isn't ready for public use yet. We're chopping and changing it a LOT as we grow it. So if you build something that uses it then it's very likely to break in a future update. Don't say you weren't warned!
URL: | https://api.kashflow.com/v2/{objecttype}/{objectnumber}/notes |
Method(s): | get,post,put,delete |
Response Formats: | JSON, XML |
Description: | These methods allow you to retrieve, create, update and delete notes. {objecttype} in the URL can be substituted by one of the below entities to which the notes belong. {objectnumber} in the URL is the identifier (mentioned below) of the entity to which notes belongs. |
| {objecttype} | {objectnumber} |
|---|---|
| Quotes | Quote Number |
| Invoices | Invoice Number |
| Customers | Customer Code |
| Purchases | Purchase Number |
| Suppliers | Supplier Code |
So, the GET of URL /invoice/100/notes would return the notes belonging to invoice number 100.
Each individual note resource is identified by a note number. Note number is unique with respect to the entity to which it belongs. Hence, a PUT to the URL /invoice/100/note/1 would update note number 1 of invoice number 100.
Parameters
| Name | Type | Description |
|---|---|---|
| Number | Numeric | Unique number given to the note |
| Date | Date | Note date provided by user. For e.g. [JSONDATE] |
| LastModifiedBy | String | Name of the user who created/last modified the note |
| Text | String | Contents of the note |
GET Operation
GET of notes returns all the notes belonging to a particular entity object for the authenticated user.URL : /{objecttype}/{objectnumber}/notes
Example response for GET of note list
[
{
"Date": "2012-09-13 12:00:00",
"LastModifiedBy": "Von Pea",
"Text": "Note 1",
"Number": 1
},
{
"Date": "2012-09-13 12:00:00",
"LastModifiedBy": "Von Pea",
"Text": "Note 1",
"Number": 2
}
]
To get details of particular note with the specified number –
URL : {objecttype}/{objectnumber}/notes/{number}
{number} in the URL should be replaced with the number of the note to be retrieved.
Example response for GET of note
{
"Date": "2012-07-31 12:00:00",
"LastModifiedBy": "Kashflow",
"Text": "new -updated",
"Number": 1
}
POST Operation
POST of notes creates a new note for the given entity object (type and identifier specified in URL).URL : /{objecttype}/{objectnumber}/notes
Conditions to be mindful of while creating note:
1. Cannot specify number while creating note. It is auto-generated by the system.
2. The content of notes cannot be empty.
3. Valid entity type and number should be provided in the URL.
Example request for POST of note
{
"Text": "New Note Created",
"Date": "2012-09-13 12:00:00"
}
PUT Operation
PUT of notes updates a note with a particular note number for the given entity object (type and identifier specified in URL).URL : /{objecttype}/{objectNumber}/notes/{notenumber}
{notenumber} is the unique number of note to be modified.
Conditions to be mindful of while updating note:
1. Note number is mandatory.
2. The content of notes cannot be empty.
3. Valid entity type and number should be provided in the URL.
Example request for PUT of note
{
"Text": "Note Updated",
"Date": "2012-09-13 12:00:00",
"Number": 1
}
DELETE Operation
Deletes note with the specified note number for the given entity object (type and identifier specified in URL).URL : /{objectType}/{objectNumber}/notes/{notenumber}
{notenumber} is the unique number of note to be modified.