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/quotecategories |
Method(s): | get,post,put,delete |
Response Formats: | JSON or XML |
Description: | This method allows you to retrieve, create, update or delete quote category. Quote category number is the unique identifier for each quote category. |
Parameters
| Name | Type | Description |
|---|---|---|
| Number | Numeric | Unique number of quote category |
| IconId | Numeric | Unique id of quote category |
| Name | String | Name of the quote category |
| IconType | String | Type of the category. It can take the any of the following 4 values : [“flag”, “marker”, “tick”, “cross”] |
| IconColor | String | Color of the the quote category flag/marker/cross/tick. It can take the any of the following 6 values : [“red”, “green”, “purple”, “yellow”, “blue”, “grey”] |
Following is the list of valid IconId and their respective IconType and IconColor:
| IconId | IconType | IconColor |
|---|---|---|
| 1 | flag | red |
| 2 | flag | purple |
| 3 | flag | green |
| 4 | flag | yellow |
| 5 | flag | blue |
| 6 | marker | red |
| 7 | marker | purple |
| 8 | marker | green |
| 9 | marker | yellow |
| 10 | marker | blue |
| 11 | tick | grey |
| 12 | cross | grey |
GET Operation
To return a list containing details of all quote categories –URL : /quotecategories
Example response for GET of quote categories
[
{
"Number":1,
"IconType":"flag",
"IconId":4,
"IconColor": "yellow"
"Name":"Category 1"
},
{
"Number":2,
"IconType":"flag",
"IconId":2,
"IconColor": "purple"
"Name":"purple category"
}
]
POST Operation
To create new quote category –URL : /quotecategories
Flag icon and category name are mandatory fields and the combination of category name and category icon should be unique.
Example request for POST of quote category
{
"IconId":4,
"Name":"Rest Api Category"
}
PUT Operation
To update quote category details for the specified quote category number –URL : /quotecategories/{number}
To update a quote category you need to send request body similar to the GET quote category response and only update the required elements.
Example request for PUT of quote category
{
"Number":5,
"IconId":4,
"Name":"5th updated"
}
DELETE Operation
To delete the specified quote category –URL : /quotecategories/{number}