BalanceSheetSummary
Returns a Balance Sheet Summary.
Date Released: Nov 2020 Date Updated: Dec 2022
| URL | Supports |
| /{cf_uri}/Report/BalanceSheetSummary
|
GET |
PUT |
POST |
DELETE
|
The following query is required for the above URL:
?AsOfDate={AsOfDate}&YearEndAdjust={YearEndAdjust}&ReportingBasis={ReportingBasis}
The {AsOfDate} is the date of the end of the period.The {YearEndAdjust} states if you are includeding Year end Adjustments. This is a true or false value.The {reporting_basis} will either be Cash or Accrual. (This filter is optional) |
Please note: While accessibility via the API is available to both AccountRight and new Essentials files. Not all features will be displayed in Product for new Essentials
The elements list below details information for BalanceSheetSummary. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.
Items shown with are required when posting or puting data
Items shown with are read-only elements
Attribute Details
- AsOfDateDateTime
- Date of the period, format YYYY-MM-DD HH:MM:SS
- YearEndAdjustBoolean
- Shows if the Year end Addjustments are included. This will either be True or False.
- AccountsBreakdown []
- The breakdown of the Accounts for the speaific date
- AccountTotalDecimal
- Total Amount for the Account for the given date range
- Account
- The following set of information pulls through details for an Account
- UIDGuid (36)
- Foreign Key: Unique identifier for the account in the form of a guid.
- NameString (30)
- Account name belonging to the account record.
- DisplayIDString (6)
- Account code format includes separator ie 1-1100{ 'DisplayID': '4-1100' }
- URIString
- Uniform resource identifier associated with the account object.
- URIString
- Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
Example json GET response
- {
- "AsOfDate" : "2020-10-31T00:00:00",
- "YearEndAdjust" : false,
- AccountsBreakdown" : [
- {
- "AccountTotal" : 3458.55,
- "Account" : {
- "UID" : "89d68030-1373-492e-ab54-490963ed823f",
- "Name" : "Bank Account",
- "DisplayID" : "1-1100",
- "URI" : "{cf_uri}/GeneralLedger/Account/89d68030-1373-492e-ab54-490963ed823f"
- }
- },
- {
- "AccountTotal" : 505.31,
- "Account" : {
- "UID" : "730d3678-7ecf-4d5b-b28d-3677b780b2be",
- "Name" : "Trade Debtors",
- "DisplayID" : "1-1200",
- "URI" : "{cf_uri}/GeneralLedger/Account/730d3678-7ecf-4d5b-b28d-3677b780b2be"
- }
- ],
- "URI" : "{cf_uri}/Report/BalanceSheetSummary?AsOfDate=2020-10-31&yearendadjust=false"
- }
