Quote Categories

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

NameTypeDescription
NumberNumericUnique number of quote category
IconIdNumericUnique id of quote category
NameStringName of the quote category
IconTypeStringType of the category. It can take the any of the following 4 values : [“flag”, “marker”, “tick”, “cross”]
IconColorStringColor 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:

IconIdIconTypeIconColor
1flagred
2flagpurple
3flaggreen
4flagyellow
5flagblue
6markerred
7markerpurple
8markergreen
9markeryellow
10markerblue
11tickgrey
12crossgrey

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}

See how KashFlow works with your business and your books