Email Text Substitutions

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}/emailtextsubstitutions

Method(s):

get

Response Formats:

JSON, XML

Description:

This resource returns key/value pairs for a Quote/Invoice/Customer/Purchase, which can be used as text replacements for tokens used in an email template. If a block of text in an email template contains matching Key enclosed within two ‘#’ sign, then that key with enclosed ‘#’ can be replaced with corresponding value.
{objecttype}{objectnumber}
QuotesQuote Number
InvoicesInvoice Number
CustomersCustomer Code
PurchasesPurchase Number

Parameters

NameTypeDescription
KeyStringThe key that can be matched in a block of text
ValueStringThe above matched key can be replaced with this value.

GET Operation

Returns list of EmailTextSubstitutions for an Entity.

URL : /quotes/10/emailtextsubstitutions

Example response for GET of EmailTextSubstitutions


[{
    "Key": "INVNUM",
    "Value": "33"
}, {
    "Key": "CUSTREF",
    "Value": ""
}, {
    "Key": "TOTAL",
    "Value": ""
}, {
    "Key": "PAYMENTTERMS",
    "Value": ""
}, {
    "Key": "NAME",
    "Value": ""
}, {
    "Key": "COMPANY",
    "Value": ""
}, {
    "Key": "CONTACT",
    "Value": ""
}, {
    "Key": "TITLE",
    "Value": ""
}, {
    "Key": "FIRSTNAME",
    "Value": ""
}, {
    "Key": "LASTNAME",
    "Value": ""
}, {
    "Key": "CUSTCODE",
    "Value": ""
}, {
    "Key": "TEL",
    "Value": ""
}, {
    "Key": "FAX",
    "Value": ""
}, {
    "Key": "MOBILE",
    "Value": ""
}, {
    "Key": "CELL",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT1",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT2",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT3",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT4",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT5",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT6",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT7",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT8",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT9",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT10",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT11",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT12",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT13",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT14",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT15",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT16",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT17",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT18",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT19",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT20",
    "Value": ""
}, {
    "Key": "Customerportal",
    "Value": ""
}, {
    "Key": "PERMALINK",
    "Value": ""
}]

URL : /invoices/10/emailtextsubstitutions


[{
    "Key": "INVNUM",
    "Value": "1111111490"
}, {
    "Key": "INVDUE",
    "Value": "07\/09\/2013"
}, {
    "Key": "DUEDATE",
    "Value": "07\/09\/2013"
}, {
    "Key": "DAYS_14",
    "Value": "16\/08\/2013"
}, {
    "Key": "TOTAL",
    "Value": "$998.99"
}, {
    "Key": "AMOUNTDUE",
    "Value": "$998.99"
}, {
    "Key": "PERMALINK",
    "Value": "http:\/\/securedwebapp.com\/RestApi\/\/documents\/invoices\/83B7201E-1613-422F-8839-A194EF7715D1"
}, {
    "Key": "PAYPAL",
    "Value": "https:\/\/www.paypal.com\/cgi-bin\/webscr?currency_code=USD&cmd=_xclick&business=aatish%40kashflow.com&item_name=Invoice%20%231111111490&amount=999.00&no_shipping=0&no_note=1&bn=Kashflow_Acct_ST&invoice=1111111490&custom=23887936&lc=GB&charset=UTF%2d8"
}, {
    "Key": "PAYONLINE",
    "Value": "https:\/\/www.paypal.com\/cgi-bin\/webscr?currency_code=USD&cmd=_xclick&business=aatish%40kashflow.com&item_name=Invoice%20%231111111490&amount=999.00&no_shipping=0&no_note=1&bn=Kashflow_Acct_ST&invoice=1111111490&custom=23887936&lc=GB&charset=UTF%2d8"
}, {
    "Key": "PAYMENTTERMS",
    "Value": ""
}, {
    "Key": "NAME",
    "Value": "021"
}, {
    "Key": "COMPANY",
    "Value": "021"
}, {
    "Key": "CONTACT",
    "Value": "AATISH"
}, {
    "Key": "TITLE",
    "Value": ""
}, {
    "Key": "FIRSTNAME",
    "Value": "Aatish"
}, {
    "Key": "LASTNAME",
    "Value": ""
}, {
    "Key": "CUSTCODE",
    "Value": "021"
}, {
    "Key": "TEL",
    "Value": "912065101091"
}, {
    "Key": "FAX",
    "Value": ""
}, {
    "Key": "MOBILE",
    "Value": "912065101091"
}, {
    "Key": "CELL",
    "Value": "912065101091"
}, {
    "Key": "CUSTOMTEXT1",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT2",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT3",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT4",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT5",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT6",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT7",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT8",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT9",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT10",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT11",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT12",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT13",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT14",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT15",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT16",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT17",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT18",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT19",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT20",
    "Value": ""
}, {
    "Key": "Customerportal",
    "Value": ""
}]

URL : /customers/cust01/emailtextsubstitutions


[{
    "Key": "PAYMENTTERMS",
    "Value": "45"
}, {
    "Key": "NAME",
    "Value": "01"
}, {
    "Key": "COMPANY",
    "Value": "01"
}, {
    "Key": "CONTACT",
    "Value": "Melyn Gates"
}, {
    "Key": "TITLE",
    "Value": "Mr"
}, {
    "Key": "FIRSTNAME",
    "Value": "Rodriques"
}, {
    "Key": "LASTNAME",
    "Value": "John"
}, {
    "Key": "CUSTCODE",
    "Value": "01"
}, {
    "Key": "TEL",
    "Value": ""
}, {
    "Key": "FAX",
    "Value": ""
}, {
    "Key": "MOBILE",
    "Value": "9568712345"
}, {
    "Key": "CELL",
    "Value": "9568712345"
}, {
    "Key": "CUSTOMTEXT1",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT2",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT3",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT4",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT5",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT6",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT7",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT8",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT9",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT10",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT11",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT12",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT13",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT14",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT15",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT16",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT17",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT18",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT19",
    "Value": ""
}, {
    "Key": "CUSTOMTEXT20",
    "Value": ""
}, {
    "Key": "Customerportal",
    "Value": ""
}]

URL : /purchases/25/emailtextsubstitutions


[{
    "Key": "PAYMENTTERMS",
    "Value": "28"
}, {
    "Key": "INVNUM",
    "Value": "25"
}, {
    "Key": "INVDUE",
    "Value": "16\/07\/2010"
}, {
    "Key": "NAME",
    "Value": "Honda Suppliers"
}, {
    "Key": "CUSTCODE",
    "Value": "08C"
}, {
    "Key": "CUSTREF",
    "Value": "Y785"
}, {
    "Key": "CONTACT",
    "Value": "Mr Tim Lee"
}, {
    "Key": "TITLE",
    "Value": "Mr"
}, {
    "Key": "FIRSTNAME",
    "Value": "Tim"
}, {
    "Key": "LASTNAME",
    "Value": "Lee"
}, {
    "Key": "TOTAL",
    "Value": "900"
}, {
    "Key": "COMPANY",
    "Value": "GovGle"
}, {
    "Key": "TEL",
    "Value": "7487897"
}, {
    "Key": "FAX",
    "Value": "7894654"
}, {
    "Key": "MOBILE",
    "Value": "95623487"
}]

See how KashFlow works with your business and your books