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!

Response elements

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

GET Operation

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
}