fbpx

Account Summary

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/accountsummary

Method(s):

get

Response Formats:

JSON, XML

Description:

This method allows you to retrieve the account summary details of the user.

Response elements

NameTypeDescription
DisplayComprises of the display settings which govern the KashFlow ‘Overview’ UI
Display object fields:
ShowChangeLogBooleanWhether 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
ShowDoYouKnowSectionBooleanWhether ‘Do You Know’ section is to be displayed on UI. This section displays the new promotional offers from KashFlow
ShowFinancialGraphBooleanWhether financial graphs are to be displayed on UI
ShowFinancialOverviewBooleanWhether financial overview section is to be displayed on UI
ShowGettingStartedSectionBooleanWhether ‘Getting Started’ section is to be displayed on UI
ShowMessagesBooleanWhether KashFlow notifications are to be displayed on UI
ShowQuickLinksBooleanWhether ‘Quick links’ section is to be displayed on UI. These links guide a new user in the application
ShowReferralBooleanWhether ‘Referrals’ section is to be displayed on UI. This section shows information about affiliated users.
SuppressVATWarningBooleanWhether VAT warnings need to be hidden on UI
ShowVATLiabilityBooleanWhether VAT liabilities need to be displayed on UI
ShowQuotesSummaryBooleanWhether Quotes Summary needs to be displayed on UI
ShowAnnouncementBooleanWhether announcement set by partner is to be displayed on UI
DataImportsComprises of the list of PayPal and Ekm import profiles and their properties. Each DataImport object represents an import profile.
DataImport object fields:
LastCheckedDateDateDate when the data import profile was checked for updates
LastStatusStringStatus of the last import. The values can be ‘OK’, ‘SETUP’, ‘Que’, ‘ERROR’, ‘WAIT’, etc.
LastStatusMessageStringStatus message of the last import
ProfileIdNumericThe unique identifier of the import profile
ProfileNameStringThe name of the import profile
SourceStringThe source of the import profile. Valid sources are ‘PayPal’ and ‘EKM’
TransactionCountNumericThe number of transactions of the profile pending for conversion to KashFlow entities

FinancialSummaryComprises of the summary of financial data of the accountFinancial object fields:

AgedCreditorsBalanceNumericThe total amount owed to the user which includes the amount of unpaid receipts minus the receipt part payments and supplier advance payments
AgedDebtorsBalanceNumericThe total amount to be paid by the user which includes the amount of unpaid invoices minus the invoice part payments and customer advance payments
BankAccountsList of bank account objectsEach bank account object has information about account id, account name, account balance and the monthly balance overview for the last 6 months
OverdueInvoicesBalanceNumericThe total value of overdue invoices
OverduePurchasesBalanceNumericThe total value of overdue receipts
VATLiabilityObjectContains information about VAT amount, VAT period start and end date
VATWarningStringVATWarning message
ReportTypeStringType of report graph to be displayed in summary. Valid types are: SalesGrowth, ProfitAndLoss and IncomeBySource
ReportsDataObjectData 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
MessagesComprises of the KashFlow notifications applicable for the account
Message object fields:
IdNumericUnique identifier of the message
TextStringMessage contents
TitleStringMessage title
ReferralDetailsInformation about the user’s referrals
Affiliated User object fields:
AffiliateIdNumericEach user who can refer other users to KashFlow is assigned an unique affiliate id.
AmountEarnedNumericAmount earned through the user references
AmountOwedNumericAmount owed to the affiliated user by KashFlow for referring users
HomeLinkStringThe link to the affiliate user’s home page from where referred users can register
PayingUsersNumericNumber of paying users referred by the affiliate
PromotionalCodeStringCode used by affiliate to refer users
RegistrationLinkStringThe link which can be used by referred users to register
TrailingUsersNumericNumber of trialing users referred by the affiliate
VATWarningMessageStringVATWarningMessage
OnBoarderDetailsComprises of user’s onboarder details such as display name and CSS to be applied.
OnBoarderDetails object fields:
IdNumericUnique identifier assigned to onboarder
DisplayNameStringDisplay name
CssNameStringContains class name which will be applied to onboarder details section on overview page.
Quotes SummaryComprises of user’s Quotes details.
Quotes Summary object fields:
CategoryIconStringThe icon for this quote category
CategoryNameStringThe name of the quote category
CategoryNumberNumericThe category number
QuotesCountNumericContains the count of quotes in this category.
TotalNumericThe sum of the value of the quotes in this category.
AnnouncementComprises of Announcement set be the users partner.
Announcement object fields:
HeadStringThe heading of the message
MessageNumericThe 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": "test@kashflow.com",
    "Source": "PayPal",
    "TransactionCount": 7273
  }, {
    "LastCheckedDate": "1900-01-01 12:00:00",
    "LastStatus": "SETUP",
    "LastStatusMessage": "Email authorized. Set up in progress",
    "ProfileId": 8583,
    "ProfileName": "test@kashflow.com",
    "Source": "PayPal",
    "TransactionCount": 0
  }, {
    "LastCheckedDate": "1900-01-01 12:00:00",
    "LastStatus": "SETUP",
    "LastStatusMessage": "Awaiting confirmation of email address",
    "ProfileId": 8584,
    "ProfileName": "test@kashflow.com",
    "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(test@kashflow.com)",
    "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(test@kashflow.com)",
    "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": "shveta@kashflow.com",
    "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
}

See how KashFlow works with your business and your books