MYOB Endpoint: NZGSTReport
Jump to navigation
Jump to search
Overview
The MYOB NZGSTReport endpoint provides various totals for GST for New Zealand MYOB data files between a start date and an end date.
It is a function that accepts a series of parameters.
Parameters
The NZGSTReport endpoint is a function that accepts the following parameters.
- ReportingPeriod
- A text field that indicates the length of the reporting period.
- Possible values are:
- 1m: Indicates that values are for a single month.
- 2m: Indicates that values are for two months.
- 6m: Indicates that values are for six months.
- If omitted, it will use 1m.
- EndDate
- A date field that determines the end date for which to produce values.
- If omitted, it will use the last date of the last calendar month.
- ReportingBasis
- A text field that determines the way the values will be calculated.
- Possible values are:
- Cash: Indicates values should be on a cash basis (based on payment dates).
- Invoice: Indicates values should be on an accrual basis (based on invoice dates).
- Hybrid: Indicates values should be on a hybrid basis.
- YearEndAdjust
- A true/false field that determines if year end adjustment should be included or excluded.
Fields
The following fields are available for the NZGSTReport endpoint.
- CompanyName
- A text field that provides the name of the company.
- IrdNumber
- A text field that provides the IRD number for the company.
- Address
- A text field that provides the address of the company.
- PhoneNumber
- A text field that provides the phone number of the company.
- ReportingBasis
- A text field that indicates the way the values will be calculated.
- This will match the ReportingBasis entered as parameter.
- StartDate
- A date field that indicates the start date for which to produce values.
- This will be based on the ReportingPeriod and EndDate entered as parameter.
- EndDate
- A date field that indicates the end date for which to produce values.
- This will match the EndDate entered as parameter.
- ReportingPeriod
- A text field that indicates the reporting period used to produce values.
- This will match the ReportingPeriod entered as parameter.
- TotalSales
- A decimal field that provides the total sales amount.
- ZeroRatedSupplies
- A decimal field that provides the total zero rated supplies amount.
- NetGSTSales
- A decimal field that provides the total gst sales amount.
- TotalGSTCollectedOnSales
- A decimal field that provides the total GST amount collected on sales.
- DebitAdjustments
- A decimal field that provides the total debits applied amount.
- TotalGSTCollected
- A decimal field that provides the total GST amount collected.
- TotalPurchases
- A decimal field that provides the total purchases amount.
- TotalGSTCollectedOnPurchases
- A decimal field that provides the total GST amount paid on purchases.
- CreditAdjustments
- A decimal field that provides the total credits applied amount.
- TotalGSTCredit
- A decimal field that provides the total GST amount paid.
- PaymentAmount
- A decimal field that provides the payment amount for the period.
MYOB API
For a detailed run through of the endpoint, you can see the MYOB API.
Related Fields
- None
Related Endpoints
- None