ProfitAndLossSummary
Returns a Profit and Loss Summary.
Date Released: Nov 2018 Date Updated: Jan 2021
| URL | Supports |
| /{cf_uri}/Report/ProfitAndLossSummary
|
GET |
PUT |
POST |
DELETE
|
The following query is required for the above URL:
?StartDate={start_date}&EndDate={end_date}&ReportingBasis={reporting_basis}&YearEndAdjust={year_end_adjust}
The {start_date} is the date that you would like to start at.The {end_date} is the date of the end of the period.The {reporting_basis} will either be Cash or Accrual.The {year_end_adjust} stats if you are including Year end Adjustments. This is a true or false value. |
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 ProfitAndLossSummary. 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
- StartDateDateTime
- Starting date of the period, format YYYY-MM-DD HH:MM:SS { 'StartDate': '2018-07-01 00:00:00' }
- EndDateDateTime
- Ending date of the period, format YYYY-MM-DD HH:MM:SS { 'EndDate': '2018-09-30 00:00:00' }
- ReportingBasisString
- Reporting basis for the report. This will either be Cash or Accrual.
- YearEndAdjustBoolean
- Shows if the Year end Addjustments are included. This will either be True or False.
- AccountsBreakdown []
- The breakdown of the Accounts for the specific date range
- 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.
Paging: default page size is set to 400 with a maximum of 1000 results.
Example json GET response
- {
- "StartDate" : "2018-07-01T00:00:00",
- "EndDate" : "2018-09-30T23:59:59",
- "ReportingBasis" : "Cash",
- "YearEndAdjust" : true,
- TaxCodeBreakdown" : [
- {
- "AccountTotal" : 762.72,
- "Account" : {
- "UID" : "59fc77d9-fadc-47c3-a4bf-be9d1ff491bc",
- "Name" : "Sales - Spring Water",
- "DisplayID" : "4-1100",
- "URI" : "{cf_uri}/GeneralLedger/Account/59fc77d9-fadc-47c3-a4bf-be9d1ff491bc"
- }
- },
- {
- "AccountTotal" : 505.31,
- "Account" : {
- "UID" : "730d3678-7ecf-4d5b-b28d-3677b780b2be",
- "Name" : "Sales - Carbonated Water",
- "DisplayID" : "4-1200",
- "URI" : "{cf_uri}/GeneralLedger/Account/730d3678-7ecf-4d5b-b28d-3677b780b2be"
- }
- ],
- "URI" : "{cf_uri}/Report/ProfitAndLossSummary?StartDate=2017-07-01&EndDate=2017-09-30&ReportingBasis=Cash&YearEndAdjust=true"
- }
