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!
Response elements
Name | Type | Description |
---|
Display | Comprises of the display settings which govern the KashFlow ‘Overview’ UI |
Display object fields: |
ShowChangeLog | Boolean | Whether change log is to be displayed on UI. If this field is true, the recent changes made in the account are displayed on the ‘Overview’ UI |
ShowDoYouKnowSection | Boolean | Whether ‘Do You Know’ section is to be displayed on UI. This section displays the new promotional offers from KashFlow |
ShowFinancialGraph | Boolean | Whether financial graphs are to be displayed on UI |
ShowFinancialOverview | Boolean | Whether financial overview section is to be displayed on UI |
ShowGettingStartedSection | Boolean | Whether ‘Getting Started’ section is to be displayed on UI |
ShowMessages | Boolean | Whether KashFlow notifications are to be displayed on UI |
ShowQuickLinks | Boolean | Whether ‘Quick links’ section is to be displayed on UI. These links guide a new user in the application |
ShowReferral | Boolean | Whether ‘Referrals’ section is to be displayed on UI. This section shows information about affiliated users. |
SuppressVATWarning | Boolean | Whether VAT warnings need to be hidden on UI |
ShowVATLiability | Boolean | Whether VAT liabilities need to be displayed on UI |
ShowQuotesSummary | Boolean | Whether Quotes Summary needs to be displayed on UI |
ShowAnnouncement | Boolean | Whether announcement set by partner is to be displayed on UI |
DataImports | Comprises of the list of PayPal and Ekm import profiles and their properties. Each DataImport object represents an import profile. |
DataImport object fields: |
LastCheckedDate | Date | Date when the data import profile was checked for updates |
LastStatus | String | Status of the last import. The values can be ‘OK’, ‘SETUP’, ‘Que’, ‘ERROR’, ‘WAIT’, etc. |
LastStatusMessage | String | Status message of the last import |
ProfileId | Numeric | The unique identifier of the import profile |
ProfileName | String | The name of the import profile |
Source | String | The source of the import profile. Valid sources are ‘PayPal’ and ‘EKM’ |
TransactionCount | Numeric | The number of transactions of the profile pending for conversion to KashFlow entities |
FinancialSummaryComprises of the summary of financial data of the accountFinancial object fields:
AgedCreditorsBalance | Numeric | The total amount owed to the user which includes the amount of unpaid receipts minus the receipt part payments and supplier advance payments |
AgedDebtorsBalance | Numeric | The total amount to be paid by the user which includes the amount of unpaid invoices minus the invoice part payments and customer advance payments |
BankAccounts | List of bank account objects | Each bank account object has information about account id, account name, account balance and the monthly balance overview for the last 6 months |
OverdueInvoicesBalance | Numeric | The total value of overdue invoices |
OverduePurchasesBalance | Numeric | The total value of overdue receipts |
VATLiability | Object | Contains information about VAT amount, VAT period start and end date |
VATWarning | String | VATWarning message |
ReportType | String | Type of report graph to be displayed in summary. Valid types are: SalesGrowth, ProfitAndLoss and IncomeBySource |
ReportsData | Object | Data required for generating graphs. 3 types of graph data are supported, i.e., sales growth graph, profit & loss graph and income by source graph. For sales growth graph, data comprises of monthly turnover values for the last 12 months. Profit & loss graph data contains monthly gross, net and turnover data for the last 6 months. Income by source graph data fetched monthly source-wise incomes for the last 6 months. Among these 3, data for only one of them is fetched in a request depending upon the ‘ReportType’ setting |
Messages | Comprises of the KashFlow notifications applicable for the account |
Message object fields: |
Id | Numeric | Unique identifier of the message |
Text | String | Message contents |
Title | String | Message title |
|
ReferralDetails | Information about the user’s referrals |
Affiliated User object fields: |
AffiliateId | Numeric | Each user who can refer other users to KashFlow is assigned an unique affiliate id. |
AmountEarned | Numeric | Amount earned through the user references |
AmountOwed | Numeric | Amount owed to the affiliated user by KashFlow for referring users |
HomeLink | String | The link to the affiliate user’s home page from where referred users can register |
PayingUsers | Numeric | Number of paying users referred by the affiliate |
PromotionalCode | String | Code used by affiliate to refer users |
RegistrationLink | String | The link which can be used by referred users to register |
TrailingUsers | Numeric | Number of trialing users referred by the affiliate |
VATWarningMessage | String | VATWarningMessage |
OnBoarderDetails | Comprises of user’s onboarder details such as display name and CSS to be applied. |
OnBoarderDetails object fields: |
Id | Numeric | Unique identifier assigned to onboarder |
DisplayName | String | Display name |
CssName | String | Contains class name which will be applied to onboarder details section on overview page. |
Quotes Summary | Comprises of user’s Quotes details. |
Quotes Summary object fields: |
CategoryIcon | String | The icon for this quote category |
CategoryName | String | The name of the quote category |
CategoryNumber | Numeric | The category number |
QuotesCount | Numeric | Contains the count of quotes in this category. |
Total | Numeric | The sum of the value of the quotes in this category. |
Announcement | Comprises of Announcement set be the users partner. |
Announcement object fields: |
Head | String | The heading of the message |
Message | Numeric | The message |
GET Operation
Returns the account summary for user:URL : /accountsummary
Example response for GET of account summary
{
"Announcement": {
"Head": "Header",
"Message": "Message!"
},
"DataImports": [{
"LastCheckedDate": "2013-07-16 12:00:00",
"LastStatus": "OK",
"LastStatusMessage": "",
"ProfileId": 5153,
"ProfileName": "[email protected]",
"Source": "PayPal",
"TransactionCount": 7273
}, {
"LastCheckedDate": "1900-01-01 12:00:00",
"LastStatus": "SETUP",
"LastStatusMessage": "Email authorized. Set up in progress",
"ProfileId": 8583,
"ProfileName": "[email protected]",
"Source": "PayPal",
"TransactionCount": 0
}, {
"LastCheckedDate": "1900-01-01 12:00:00",
"LastStatus": "SETUP",
"LastStatusMessage": "Awaiting confirmation of email address",
"ProfileId": 8584,
"ProfileName": "[email protected]",
"Source": "PayPal",
"TransactionCount": 0
}, {
"LastCheckedDate": "2013-10-15 12:00:00",
"LastStatus": "OK",
"LastStatusMessage": "Import process is in progress",
"ProfileId": 6557,
"ProfileName": "My EKM Account([email protected])",
"Source": "EKM",
"TransactionCount": 189
}, {
"LastCheckedDate": "2013-10-15 12:00:00",
"LastStatus": "OK",
"LastStatusMessage": "Import process is in progress",
"ProfileId": 2990,
"ProfileName": "My EKM Account 43534([email protected])",
"Source": "EKM",
"TransactionCount": 1065
}],
"Display": {
"ShowAnnouncement": true,
"ShowChangeLog": true,
"ShowDoYouKnowSection": true,
"ShowFinancialGraph": false,
"ShowFinancialSummary": true,
"ShowGettingStartedSection": true,
"ShowMessages": true,
"ShowQuickLinks": true,
"ShowQuotesSummary": true,
"ShowReferral": true,
"ShowVATLiability": true,
"SuppressVATWarning": false
},
"Financial": {
"AgedCreditorsBalance": -233476.4600,
"AgedDebtorsBalance": 6091012.7600,
"BankAccounts": [{
"Balance": 443697.7600,
"BalanceOverviewByMonth": [{
"Amount": 5478.7900,
"Month": "August"
}, {
"Amount": 5180.3500,
"Month": "September"
}, {
"Amount": 439059.3300,
"Month": "October"
}, {
"Amount": 440885.0600,
"Month": "November"
}, {
"Amount": 443773.5600,
"Month": "December"
}, {
"Amount": 443697.7600,
"Month": "January"
}],
"IconPath": "boa.png",
"Id": 62711,
"Name": "Current Account"
}, {
"Balance": 2015.7700,
"BalanceOverviewByMonth": [{
"Amount": 2056.7700,
"Month": "August"
}, {
"Amount": 1943.7700,
"Month": "September"
}, {
"Amount": 1943.7700,
"Month": "October"
}, {
"Amount": 1943.7700,
"Month": "November"
}, {
"Amount": 1943.7700,
"Month": "December"
}, {
"Amount": 2015.7700,
"Month": "January"
}],
"IconPath": "boa.png",
"Id": 131593,
"Name": "Bank of America"
}, {
"Balance": 2204.0400,
"BalanceOverviewByMonth": [{
"Amount": 700.0000,
"Month": "August"
}, {
"Amount": 1604.0400,
"Month": "September"
}, {
"Amount": 2204.0400,
"Month": "October"
}, {
"Amount": 2204.0400,
"Month": "November"
}, {
"Amount": 2204.0400,
"Month": "December"
}, {
"Amount": 2204.0400,
"Month": "January"
}],
"IconPath": "barclays.png",
"Id": 129620,
"Name": "Barclays"
}, {
"Balance": 14345.6000,
"BalanceOverviewByMonth": [{
"Amount": 14195.6000,
"Month": "August"
}, {
"Amount": 14195.6000,
"Month": "September"
}, {
"Amount": 14195.6000,
"Month": "October"
}, {
"Amount": 14345.6000,
"Month": "November"
}, {
"Amount": 14345.6000,
"Month": "December"
}, {
"Amount": 14345.6000,
"Month": "January"
}],
"IconPath": "hsbc.png",
"Id": 125884,
"Name": "HSBC"
}],
"OverdueInvoicesBalance": 6090048.7900,
"OverduePurchasesBalance": 8892.4000,
"ReportType": "IncomeBySource",
"ReportsData": {
"IncomeBySource": [{
"IncomeByMonth": [{
"Amount": 324.1000,
"Month": "August"
}, {
"Amount": 3479.6700,
"Month": "September"
}, {
"Amount": 4544.5000,
"Month": "October"
}, {
"Amount": 367.6800,
"Month": "November"
}, {
"Amount": 2023.0000,
"Month": "November"
}, {
"Amount": 6166.1600,
"Month": "November"
}],
"SourceName": "Advertisement"
}, {
"IncomeByMonth": [{
"Amount": 120.0000,
"Month": "August"
}, {
"Amount": 1201.4100,
"Month": "September"
}, {
"Amount": 567.0000,
"Month": "October"
}, {
"Amount": 120.0000,
"Month": "November"
}, {
"Amount": 23450.0000,
"Month": "November"
}, {
"Amount": 455.0000,
"Month": "November"
}],
"SourceName": "Magzines"
}],
"ProfitAndLoss": null,
"SalesGrowth": null
},
"VATLiability": {
"Amount": 2322.4400,
"PeriodStartDate": "2014-01-01 12:00:00",
"PeriodEndtDate": "2014-01-31 12:00:00"
},
"VATWarning": ""
},
"Messages": [{
"Id": 32,
"Text": "HMRC are currently updating their IT systems and aren't accepting online filing of VAT Returns. VAT Returns submitted will be queued and remain as pending until the update is completed at 6am on Saturday 6th April.",
"Title": "Online Filing of VAT"
}, {
"Id": 33,
"Text": "This application will be offline for routine maintenance between 02:30 am and 04:30 am BST on 6th October. We apologize for any inconvenience but expect the exercise to be completed within two hours.",
"Title": "Scheduled Maintenance"
}],
"OnBoarderDetails": {
"CssName": "shveta",
"DisplayName": "[email protected]",
"Id": 2
},
"QuotesSummary": [{
"CategoryIcon": "greenflag1.gif",
"CategoryName": "Green",
"CategoryNumber": 2,
"QuotesCount": 1,
"Total": 0.0000
}, {
"CategoryIcon": "redflag1.gif",
"CategoryName": "Red",
"CategoryNumber": 1,
"QuotesCount": 1,
"Total": 0.0000
}, {
"CategoryIcon": "yellowflag1.gif",
"CategoryName": "Yellow",
"CategoryNumber": 3,
"QuotesCount": 1,
"Total": 0.0000
}],
"ReferralDetails": {
"AffiliateId": 5552,
"AmountEarned": 20.0000,
"AmountOwed": 10.0000,
"HomeLink": "http:\/\/kf.cm\/1bB9dGF\u000a",
"PayingUsers": 0,
"PromotionalCode": "AFF2105552",
"RegistrationLink": "http:\/\/kf.cm\/1bB9cT8\u000a",
"TrailingUsers": 0
},
"VATWarningMessage": null
}