Quote Settings

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/settings/quote

Method(s):

get

Response Formats:

JSON, XML

Description:

This method allows you to retrieve all settings for quotes.

Parameters

NameTypeDescription
PrevNextOptionEnabledBooleanPrevious and next buttons to be displayed in view of quote or not
PrevNextTypeNumericPrevious and next buttons to be looped through all quotes or all quotes for current selected customer
QuoteAdditionalTextNumericAdditonal text to appear at the bottom of quote pdf
QuoteConvertedCategoryNumericAfter quote is converted to invoice we can automatically change the category of quote
QuoteCopyReferenceNumericTo copy reference of quote to invoice after quote is converted or not
QuoteDeleteBooleanQuotes to be deleted after they are converted to invoice or not
QuoteDueDateStringDays in which quote will be due after it is created
QuoteDueDateCaptionStringLabel for quote’s due date
QuoteHeadingStringQuote’s heading
QuoteNameStringQuote name
QuoteReferenceStringQuote’s reference
QuoteShowTotalInListBooleanQuote’s total to be be displayed at bottom of list in view of quote or not
QuoteShowTotalInPdfBooleanQuote’s total to be be displayed at bottom of list in pdf of quote or not

GET Operation

Returns quote settings for user.

To GET quote settings –

URL : /settings/quote

Example response for GET of quote settings


{
    "PrevNextOptionEnabled":true,
    "PrevNextType":"0",
    "QuoteAdditionalText":"",
    "QuoteConvertedCategory":"0",
    "QuoteCopyReference":"0",
    "QuoteDelete":true,
    "QuoteDueDate":"30 Days",
    "QuoteDueDateCaption":"Valid For",
    "QuoteHeading":"Quotation",
    "QuoteName":"Quotes",
    "QuoteReference":"Quote Ref",
    "QuoteShowTotalInList":false,
    "QuoteShowTotalInPdf":false
}

See how IRIS KashFlow works with your business and your books