NZ GST Report endpoint

In this article we are going to take a closer look at the Report/GST/NZGSTReport endpoint. Please note, this report generates an NZ GST report specific for files setup for NZ.

To generate the report, we can use the HTTP method GET from the endpoint Report/GST/NZGSTReport. Please note, we must also pass the following parameters;

1. ReportingPeriod is the timeframe that we report our GST to the IRD. The values are in months, either 1m, 2m or 6m.
2. EndDate is the date of the end of the period.
3. ReportingBasis will either be Cash, Invoice or Hybrid.
4. YearEndAdjust stats if we are including Year end Adjustments. This is a true or false value.

Example request:

{cf_uri}/Report/GST/NZGSTReport?ReportingPeriod=6m&EndDate=2018-11-30&ReportingBasis=Cash&YearEndAdjust=true

Example 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"
}

Example error:

The report runs of the financial year set for the company file. We might receive below error, if the financial year is set to end on 2018/10/30. We can check this in AccountRight UI by going to the Setup menu > Company Information. For more information, please review articles under End of financial year tasks.

{
"Errors": [
{
"Name": "LastMonthInReportingPeriodOutOfRange",
"Message": "Last month in reporting period is out of range",
"AdditionalDetails": "",
"ErrorCode": 60006,
"Severity": "Error",
"LearnMore": null
}
],
"Information": "Warning, error messages have not been finalised in this release and may change"
}

To learn more about the the AccountRight UI refer to Reports

If you have any questions, feel free to log a ticket with the Customisation & Integration Team.