NZGSTReport
Returns a GST report for New Zealand files
Date Released: Nov 2018 Date Updated: Jan 2021
| URL | Supports |
| /{cf_uri}/ Report/GST/NZGSTReport
|
GET |
PUT |
POST |
DELETE
|
The following query is required for the above URL:
?ReportingPeriod={reporting_period}&EndDate={end_date}&ReportingBasis={reporting_basis}&YearEndAdjust={year_end_adjust}
The {reporting_period} is the timeframe that you report your GST to the IRD.The values are either 1m, 2m or 6m.The {end_date} is the date of the end of the period.The {reporting_basis} will either be Cash, Invoice or Hybrid.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 NZGSTReport. 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
- CompanyNameString
- The name of the Business
- IrdNumberString(11)
- The IRD number of the Company, format xxx-xxx-xxx
- AddressString (255)
- The Address of the Company.
- PhoneNumberString (20)
- The Phone number for the Company
- ReportingBasisString
- Reporting basis for the report. This will be Cash, Invoice or Hybrid.
- 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' }
- ReportingPeriodString
- Reporting Period for the report. This will either be 1m, 2m or 6m.
- TotalSalesDecimal
- Total Amount of Sales for the given date range
- ZeroRatedSuppliesDecimal
- Total Zero Rated Suppies for the given date range
- NetGSTSalesDecimal
- The Net GST Sales aomunt for the given date range
- TotalGSTCollectedOnSalesDecimal
- Total GST Collected on Sales for the given date range
- DebitAdjustmentsDecimal
- The Debit Adjustments amount for the given date range
- TotalGSTCollectedDecimal
- Total GST Collected for the given date range
- TotalPurchasesDecimal
- Total Amount of Purchases for the given date range
- TotalGSTCollectedOnPurchasesDecimal
- Total GST Collected on Purchases for the given date range
- CreditAdjustmentsDecimal
- The Credit Adjustments amount for the given date range
- TotalGSTCreditDecimal
- Total GST Credit for the given date range
- PaymentAmountDecimal
- Total Payment Amount for the given date range
- 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
- {
- "CompanyName" : "API Sandbox Demo NZ 1",
- "IrdNumber" : "12-345-678",
- "Address" : "25 Spring Street\r\nWellington\r\n\r\n\r\nA/C XX-YYYY-MMMMMMM-123",
- "PhoneNumber" : "04-123-4567",
- "ReportingBasis" : "Cash",
- "StartDate" : "2018-06-01T00:00:00",
- "EndDate" : "2018-11-30T00:00:00",
- "ReportingPeriod" : "6m",
- "TotalSales" : 119.98,
- "ZeroRatedSupplies" : 0,
- "NetGSTSales" : 119.98,
- "TotalGSTCollectedOnSales" : 15.65,
- "DebitAdjustments" : 0,
- "TotalGSTCollected" : 15.65,
- "TotalPurchases" : 1799.98,
- "TotalGSTCollectedOnPurchases" : 234.78,
- "CreditAdjustments" : 0,
- "TotalGSTCredit" : 234.78,
- "PaymentAmount" : 219.13,
- "URI" : "{cf_uri}/Report/GST/NZGSTReport?ReportingPeriod=6m&EndDate=2018-11-30&ReportingBasis=Cash&YearEndAdjust=true"
- }
