8000 [IMP] l10n_nz: Improve New Zealand localization module documentation · odoo/documentation@e4fe435 · GitHub
[go: up one dir, main page]
Skip to content

Commit e4fe435

Browse files
XIDO-odooxpl-odoo
XIDO-odoo
authored and
xpl-odoo
committed
[IMP] l10n_nz: Improve New Zealand localization module documentation
task-2858250 closes #13322 X-original-commit: 0d6acab Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
1 parent 9dadd58 commit e4fe435

File tree

5 files changed

+355
-4
lines changed

5 files changed

+355
-4
lines changed

‎content/applications/finance/fiscal_localizations/new_zealand.rst

Lines changed: 355 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,364 @@
22
New Zealand
33
===========
44

5+
.. _localizations/new_zealand/modules:
6+
7+
Modules
8+
=======
9+
10+
The following modules related to the New Zealand localization are available:
11+
12+
.. list-table::
13+
:widths: 25 25 50
14+
:header-rows: 1
15+
16+
* - Name
17+
- Technical name
18+
- Description
19+
* - :guilabel:`New Zealand - Accounting`
20+
- `l10n_nz`
21+
- Installed by default when the accounting fiscal localization package is set to New Zealand.
22+
This module also installs the remittance advice report module.
23+
* - :guilabel:`Employment Hero NZ Payroll`
24+
- `l10n_employment_hero`
25+
- This module synchronizes all pay runs from Employment Hero with Odoo's journal entries.
26+
* - :guilabel:`EFT Batch Payment`
27+
- `l10n_nz_eft`
28+
- This module allows businesses to streamline bulk payments like payroll and vendor payments.
29+
Each bank has its specific format for these transactions.
30+
31+
.. note::
32+
The localization’s core modules are installed automatically with the localization. The rest can
33+
be manually :doc:`installed </applications/general/apps_modules>`.
34+
35+
.. _localizations/new_zealand/loc-specifics:
36+
37+
Localization overview
38+
=====================
39+
40+
- :doc:`../accounting/get_started/chart_of_accounts`: a predefined structure tailored to New
41+
Zealand accounting standards
42+
- :doc:`../accounting/taxes/fiscal_positions`: automated tax adjustments based on customer or
43+
supplier registration status
44+
- :ref:`localizations/new_zealand/taxes-gst`
45+
- :ref:`localizations/new_zealand/reporting`
46+
47+
.. _localizations/new_zealand/taxes-gst:
48+
49+
Taxes and GST
50+
-------------
51+
52+
The default taxes impact the
53+
:doc:`GST report<../../../applications/finance/accounting/reporting/tax_returns>`, which can be
54+
accessed through :menuselection:`Accounting --> Reporting --> Tax Return`
55+
56+
The standard **Goods and Service Tax** (GST) rate is 15%, but different rates and exemptions exist
57+
for specific categories of goods and services.
58+
59+
.. seealso::
60+
:doc:`GST report<../../../applications/finance/accounting/reporting/tax_returns>`
61+
62+
.. _localizations/new_zealand/tax-mapping:
63+
64+
Tax mapping
65+
~~~~~~~~~~~
66+
67+
Within the New Zealand localization package, tax names encompass the tax rate as an integral part
68+
of their naming convention.
69+
70+
.. seealso::
71+
:doc:`Taxes documentation <../../../applications/finance/accounting/taxes>`
72+
73+
These are the taxes in Odoo.
74+
75+
.. list-table::
76+
:widths: 25 25 25 25
77+
:header-rows: 1
78+
79+
* - GST name
80+
- Description
81+
- Label on invoices
82+
- GST Type
83+
* - 15%
84+
- Sale (15%)
85+
- GST Sales (15%)
86+
- Sales
87+
* - 15%
88+
- Purch (15%)
89+
- GST Purchases (15%)
90+
- Purchases
91+
* - 0% EX
92+
- Zero/Export (0%) Sale
93+
- Zero Rated (Export) Sales
94+
- Sales
95+
* - 0% F
96+
- Zero/Import (0%) Purch
97+
- GST Free Purchases
98+
- Purchases
99+
* - 0% TPS
100+
- Purch (Imports Taxable)
101+
- Purchase (Taxable Imports) - Tax Paid Separately
102+
- Purchases
103+
* - 100% ONLY
104+
- GST Only - Imports
105+
- GST Only on Imports
106+
- Purchases
107+
108+
.. _localizations/new_zealand/reporting:
109+
110+
Reporting
111+
---------
112+
113+
.. _localizations/new_zealand/gst-report:
114+
115+
GST report
116+
~~~~~~~~~~
117+
118+
The **Goods and Services Tax (GST) report** is a critical tax reporting requirement for businesses
119+
registered for GST. The GST return is used to report and remit GST to the **Inland Revenue
120+
Department (IRD)**.
121+
122+
.. image:: new_zealand/GST_report.png
123+
:alt: GST Report.
124+
125+
The base and tax amounts are collected from the **GST**, which is pre-configured in Odoo to align
126+
with GST Return requirements (Boxes 1-15). The **GST** can also be manually configured for special
127+
use cases, such as specific GST treatments (e.g., zero-rating for exported agricultural goods).
128+
Once the **GST** setup for each account is complete, Odoo automatically categorizes journal items
129+
into the appropriate boxes. This ensures the **GST** return is accurate and fully reflects the
130+
business's financial activities.
131+
132+
.. seealso::
133+
:doc:`Taxes documentation <../../../applications/finance/accounting/taxes>`
134+
135+
.. _localizations/new_zealand/gst-closing:
136+
137+
Closing the GST report
138+
**********************
139+
140+
The :ref:`tax return periodicity <tax-returns/periodicity>` must be set up before submitting the
141+
:ref:`tax return <tax-returns/report>` (**GST report**) to the **IRD**.
142+
143+
.. seealso::
144+
:doc:`Year-end closing documentation
145+
<../../../applications/finance/accounting/reporting/year_end>`
146+
147+
Before closing the entry for the first time, enable the :doc:`developer mode
148+
<../../../applications/general/developer_mode>` and go to :menuselection:`Accounting -->
149+
Configuration --> Tax Groups` to set the default **GST payable account** and **GST receivable
150+
account**.
151+
152+
Once the **GST payable** and **GST receivable** accounts are set up, the **Tax Return** report
153+
generates an accurate journal closing entry automatically, balancing the GST balance with the GST
154+
clearing account.
155+
156+
The balance between **GST receivable** and **payable** is set against the tax clearing account
157+
defined on the tax group. The amount to be paid to or received from **IRD** can then be reconciled
158+
with a bank transaction.
159+
160+
.. important::
161+
The **GST** report is not submitted directly to the **IRD**. Instead, Odoo
162+
automatically calculates the required values for each section, providing options to audit
163+
and review the data for a clearer understanding of its history. Businesses can then
164+
submit these values to the `IRD portal <https://myir.ird.govt.nz/_/>`_.
165+
166+
.. _localizations/new_zealand/remittance-advice:
167+
168+
Remittance advice
169+
~~~~~~~~~~~~~~~~~
170+
171+
A remittance advice is a document used as proof of payment to a business. To access it, go to
172+
:menuselection:`Accounting --> Vendors --> Payments` and select the payment(s). Then click
173+
:icon:`fa-print` :guilabel:`Print` and select :guilabel:`Payment Receipt`.
174+
175+
.. image:: new_zealand/remitance_advice_new.png
176+
:alt: Remittance Advice.
177+
178+
.. _localizations/new_zealand/accounting:
179+
180+
Accounting
181+
==========
182+
183+
.. _localizations/new_zealand/e-invoicing:
184+
185+
E-invoicing
186+
-----------
187+
188+
Odoo allows :ref:`electronic invoicing <e-invoicing/configuration>` settings to be configured per
189+
contact.
190+
191+
.. image:: new_zealand/peppol_contact_new.png
192+
:alt: Peppol Contact.
193+
194+
.. important::
195+
Validating an invoice or credit note for a contact on the PEPPOL network will download a
196+
compliant XML file that can be manually uploaded to the PEPPOL network. Odoo is currently in the
197+
process of becoming an access point for the ANZ region.
198+
199+
.. seealso::
200+
`PEPPOL requirements <https://peppol.org/learn-more/country-profiles/new-zealand/>`_
201+
202+
.. _localizations/new_zealand/eft-batch-payments:
203+
204+
EFT batch payments
205+
------------------
206+
207+
An :abbr:`EFT (electronic funds transfer)` batch file is a digital format used to facilitate bulk
208+
payment processing for businesses. It allows companies to consolidate multiple inbound and outbound
209+
payments into a single electronic file. This process is commonly used by businesses handling
210+
multiple payments at once, such as payroll or payments to multiple suppliers.
211+
212+
.. _localizations/new_zealand/eft-configuration:
213+
214+
Configuration
215+
~~~~~~~~~~~~~
216+
217+
.. _localizations/new_zealand/eft-settings:
218+
219+
#. :ref:`Install <general/install>` the :guilabel:`EFT Batch Payment` module (`l10n_nz_eft`).
220+
#. Go to :menuselection:`Accounting --> Configuration --> Settings`. In the
221+
:guilabel:`Customer Payments` section, enable :guilabel:`Batch Payments`.
222+
223+
.. seealso::
224+
:doc:`../../../applications/finance/accounting/payments/batch`
225+
226+
.. _localizations/new_zealand/eft-bank-journal:
227+
228+
Bank journal
229+
************
230+
231+
Go to :menuselection:`Accounting --> Configuration --> Journals` to configure the bank **journal**.
232+
In the :guilabel:`Journal Entries` tab, enter the :guilabel:`Account Number` and click
233+
:guilabel:`Create and edit...`. In the :guilabel:`Create Account Number` window, fill in the
234+
:guilabel:`Bank` and enable :guilabel:`Send Money` to set the bank account as trusted. The
235+
:guilabel:`Currency` field is optional.
236+
237+
.. _localizations/new_zealand/eft-contacts:
238+
239+
Contacts' bank accounts
240+
***********************
241+
242+
To add banking information for a contact, navigate to
243+
:menuselection:`Accounting --> Customers --> Customers`,
244+
:menuselection:`Accounting --> Vendors --> Vendors`, or access the contact directly through the
245+
**Contacts** app. Select the relevant contact, then open the :guilabel:`Accounting` tab. Under the
246+
:guilabel:`Bank Accounts` section, click :guilabel:`Add a line` to enter the required details.
247+
248+
- :guilabel:`Account Number`
249+
- :guilabel:`Bank`
250+
- :guilabel:`Account Holder` (it will automatically be selected for that contact)
251+
- :guilabel:`Send Money` must be **enabled**.
252+
253+
.. _localizations/new_zealand/eft-generate:
254+
255+
Generate an EFT file
256+
~~~~~~~~~~~~~~~~~~~~
257+
258+
Go to :menuselection:`Accounting --> Customers --> Invoices`
259+
or :menuselection:`Accounting --> Vendors --> Bills`. Select the invoices/bills to be paid from the
260+
list and click :guilabel:`Pay`. In the :guilabel:`Payment Method` field, select
261+
:guilabel:`New Zealand EFT` and click :guilabel:`Create Payment`.
262+
263+
.. note::
264+
The :guilabel:`Group Payment` checkbox is optional. This option appears only if there are
265+
multiple invoices or bills from the same contact.
266+
267+
In the payments window, the required EFT information for each payment, such as
268+
:guilabel:`Particulars` and :guilabel:`Analysis Code`, can be entered as needed.
269+
270+
.. note::
271+
The same payment information can be found under :menuselection:`Accounting --> Customers -->
272+
Payments` or :menuselection:`Accounting --> Vendors --> Payments`.
273+
274+
Then, return to the **payments** list view, select the payments needing to be batched, and click
275+
:guilabel:`Create Batch`.
276+
277+
In the **batch payment** window, fill in the following fields:
278+
279+
- :guilabel:`EFT file format`
280+
- :guilabel:`Payment Reference`
281+
- :guilabel:`Payment Particulars`
282+
283+
.. image:: new_zealand/batch_payment_view.png
284+
:alt: Batch Payement.
285+
286+
Then, click :guilabel:`Validate`. Odoo will generate the EFT file in the chatter. Click on the file
287+
to preview or download it.
288+
289+
.. important::
290+
Each bank has its specific format requirements for EFT batch payments. Make sure to choose the
291+
correct EFT file format. Some banks may also require the completion of additional fields, such
292+
as :guilabel:`Direct Debit Information` and :guilabel:`Dishonour Account`.
293+
294+
.. seealso::
295+
:doc:`Batch paments by bank deposit documentation
296+
<../../../applications/finance/accounting/payments/batch>`
297+
298+
.. _localizations/new_zealand/XXXXXX:
299+
300+
Industry-specific features
301+
==========================
302+
303+
.. _localizations/new_zealand/starshipit:
304+
305+
Starshipit shipping
306+
-------------------
307+
308+
`Starshipit <https://starshipit.com/>`_ is a shipping service operator that facilitates the
309+
integration of Australasian shipping couriers with Odoo.
310+
311+
.. seealso::
312+
- `Starshipit webinar recording <https://www.youtube.com/watch?v=TcDWnoYLXWg>`_
313+
- :doc:`Starshipit shipping <../../../applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/starshipit_shipping>`
314+
315+
.. _localizations/new_zealand/buynow-paylater:
316+
317+
Buy Now, Pay Later solutions
318+
----------------------------
319+
320+
**Buy Now, Pay Later** solutions are popular payment methods for e-shops. Some of these solutions
321+
are available via the `Stripe <https://stripe.com/au/payments/payment-methods>`_ and
322+
`AsiaPay payment <https://www.asiapay.com.au/payment.html#option>`_ providers.
323+
324+
.. seealso::
325+
- :doc:`AsiaPay Payment Provider documentation <../../../applications/finance/payment_providers/asiapay>`
326+
- :doc:`Stripe Payment Provider documentation <../../../applications/finance/payment_providers/stripe>`
327+
328+
.. _localizations/new_zealand/pos-terminals:
329+
330+
Point of Sale terminals
331+
-----------------------
332+
333+
To have a direct connection between Odoo and a PoS terminal, a :doc:`Stripe terminal
334+
<../../../applications/sales/point_of_sale/payment_methods/terminals/stripe>` is needed. Odoo
335+
supports the **EFTPOS** payment solution.
336+
337+
.. note::
338+
A Stripe payment terminal is not needed to use Odoo as the main POS system. The only drawback
339+
of not using Stripe is that cashiers must manually enter the final payment amount on the
340+
terminal.
341+
342+
.. seealso::
343+
- :doc:`Stripe Payment Provider documentation <../../../applications/finance/payment_providers/stripe>`
344+
- `Stripe.com Dashboard <https://dashboard.stripe.com/login?redirect=%2Fdashboard>`_
345+
- `Stripe.com Docs: Terminal <https://docs.stripe.com/terminal>`_
346+
347+
.. _new-zealand/payroll:
348+
349+
Payroll
350+
=======
351+
5352
.. _new-zealand/employment-hero:
6353

7-
Employment Hero payroll
8-
=======================
354+
Employment Hero integration
355+
---------------------------
356+
357+
If your business is already up and running with `Employment Hero <https://employmenthero.com/>`_,
358+
the connector can be used as an alternative payroll solution.
9359

10-
If your business is already up and running with :doc:`Employment Hero <employment_hero>`, you can
11-
use our connector as an alternative payroll solution.
360+
The Employment Hero module automatically synchronises payslip accounting entries (e.g., expenses,
361+
social charges, liabilities, taxes) from **Employment Hero** to Odoo. Payroll administration is
362+
still done in **Employment Hero**; only the **journal entries** are recorded in Odoo.
12363

13364
.. important::
14365
To :ref:`configure the Employment Hero API <employment_hero/configuration>` for **New Zealand**,

‎content/applications/finance/fiscal_localizations/new_zealand/GST_report.png

25.7 KB
Loading

‎content/applications/finance/fiscal_localizations/new_zealand/batch_payment_view.png

3.2 KB
Loading

‎content/applications/finance/fiscal_localizations/new_zealand/peppol_contact_new.png

3.82 KB
Loading

‎content/applications/finance/fiscal_localizations/new_zealand/remitance_advice_new.png

12.6 KB
Loading

0 commit comments

Comments
 (0)
0