TaxCodeSummary
Returns a Tax Code Summary Report
Date Released: Nov 2018 Date Updated: Jan 2021
| URL | Supports |
| /{cf_uri}/Report/TaxCodeSummary
|
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 Accural.The {year_end_adjust} stats if you are includeding 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 TaxCodeSummary. 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 Accural.
- YearEndAdjustBoolean
- Shows if the Year end Addjustments are included. This will either be True or False.
- TaxCodeBreakdown []
- The breakdown of tax codes for the speaific date range
- SalesTotalDecimal
- Total Sales amount for a Tax Code
- PurchasesTotalDecimal
- Total Purchases amount for a Tax Code
- TaxCollectedDecimal
- Total Tax Collected amount for a Tax Code
- TaxPaidDecimal
- Total Tax Paid amount for a Tax Code
- TaxRateDecimal
- Tax Rate for the Tax Code
- TaxCode
- The following set of information pulls through the details for Tax Codes
- UID GUID (36)
- Foreign Key: Unique tax code identifier in the form of a guid
- Code String (3)
- 3 digit code assigned to the tax code.
- URI String
- Uniform resource identifier associated with the tax code 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" : [
- {
- "SalesTotal" : 12516.64,
- "PurchasesTotal" : 28599.4,
- "TaxCollected" : 1137.88,
- "TaxPaid" : 2599.95,
- "TaxRate" : 10,
- "TaxCode" : {
- "UID" : "2ab1cf79-bce8-4da0-986c-a3bbdd1d02bc",
- "Code" : "GST",
- "URI" : "{cf_uri}/GeneralLedger/TaxCode/2ab1cf79-bce8-4da0-986c-a3bbdd1d02bc"
- }
- }
- ],
- "URI" : "{cf_uri}/Report/TaxCodeSummary?StartDate=2018-07-01&EndDate=2018-09-30&ReportingBasis=Cash&YearEndAdjust=true"
- }
