[IMP] localization: AU rebrands Keypay to Employment Hero

task-3250954

closes odoo/documentation#4997

X-original-commit: 35fc637ed4
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
This commit is contained in:
tong-odoo 2023-06-26 06:49:07 +00:00 committed by Jonathan Castillo (jcs)
parent 9e55729686
commit 236b76b131
11 changed files with 36 additions and 47 deletions

View File

@ -2,75 +2,64 @@
Australia
=========
.. _australia/keypay:
.. _australia/employment-hero:
KeyPay Australian Payroll
=========================
The KeyPay Module synchronizes payslip accounting entries (e.g., expenses, social charges,
liabilities, taxes) from KeyPay to Odoo automatically. Payroll administration is still done in
KeyPay. We only record the journal entries in Odoo.
liabilities, taxes) from Employment Hero to Odoo automatically. Payroll administration is still done
in Employment Hero. We only record the journal entries in Odoo.
Configuration Steps
-------------------
.. important::
KeyPay was rebranded as **Employment Hero** in March 2023.
#. Create a company located in Australia.
#. Check that the Australian localization module (Australia - Accounting) is installed.
#. Configure the *KeyPay API*.
Configuration
-------------
.. image:: australia/australia-keypay-api.png
:align: center
:alt: Odoo Accounting settings includes a section for the Australian Loclization
#. :ref:`Activate <general/install>` the :guilabel:`Keypay Australian Payroll` module (technical
name: `l10n_au_keypay`).
#. Configure the **KeyPay API** by going to :menuselection:`Accounting --> Configuration -->
Settings`. More fields become visible after clicking on :guilabel:`Enable KeyPay Integration`.
#. More fields become visible after clicking on *Enable KeyPay Integration*.
.. image:: australia/australia-keypay-integration.png
:align: center
.. image:: australia/keypay-integration.png
:alt: Enabling KeyPay Integration in Odoo Accounting displays new fields in the settings
#. You can find the API Key in the *My Account* section of the KeyPay platform.
- You can find the API Key in the :guilabel:`My Account` section of the Employment Hero platform.
.. image:: australia/australia-keypay-myaccount.png
:align: center
:alt: "Account Details" section on the KeyPay dashboard
.. image:: australia/employment-hero-myaccount.png
:alt: "Account Details" section on the Employment Hero dashboard
#. The **Payroll URL** is pre-filled with ``https://keypay.yourpayroll.com.au``. *Please do not
change it.*
#. You can find the **Business ID** in the KeyPay URL. (i.e., ``189241``)
- The **Payroll URL** is pre-filled with `https://keypay.yourpayroll.com.au`. *Please do not
change it.*
- You can find the **Business ID** in the KeyPay URL. (i.e., `189241`)
.. image:: australia/australia-keypay-business-id.png
:align: center
:alt: The KeyPay "Business ID" number is in the URL
.. image:: australia/employment-hero-business-id.png
:alt: The Employment Hero "Business ID" number is in the URL
#. You can choose any Odoo journal to post the payslip entries.
- You can choose any Odoo journal to post the payslip entries.
How does the API work?
----------------------
The API syncs the journal entries from KeyPay to Odoo and leaves them in draft mode. The reference
includes the KeyPay payslip entry ID in brackets for the user to easily retrieve the same record in
KeyPay and Odoo.
The API syncs the journal entries from Employment Hero to Odoo and leaves them in draft mode. The
reference includes the Employment Hero payslip entry ID in brackets for the user to easily retrieve
the same record in Employment Hero and Odoo.
.. image:: australia/australia-keypay-journal-entry.png
:align: center
:alt: Example of a KeyPay Journal Entry in Odoo Accounting (Australia)
.. image:: australia/employment-hero-journal-entry.png
:alt: Example of a Employment Hero Journal Entry in Odoo Accounting (Australia)
.. note::
The API sync is triggered by scheduled actions.
By default, the synchronization happens once per week. You can fetch the records manually by going
to :menuselection:`Accounting --> Configuration --> Settings` and, in the :guilabel:`Enable KeyPay
Integration` option, click on :guilabel:`Fetch Payruns Manually`.
.. image:: australia/australia-keypay-scheduled-actions.png
:align: center
:alt: Scheduled Actions settings for KeyPay Payroll in Odoo (debug mode)
Employment Hero payslip entries also work based on double-entry bookkeeping.
KeyPay payslip entries also work based on double-entry bookkeeping. Debit must equal credit (like in
Odoo).
The accounts used by Employment Hero are defined in the section :guilabel:`Payroll settings`.
The accounts used by KeyPay are defined in the section **Payroll settings**.
.. image:: australia/employment-hero-chart-of-accounts.png
:alt: Chart of Accounts menu in Employment Hero
.. image:: australia/australia-keypay-chart-of-accounts.png
:align: center
:alt: Chart of Accounts menu in KeyPay
For the API to work, you need to create the same accounts as the default accounts of your KeyPay
business (**same name and same code**) in Odoo. You also need to choose the correct account types in
Odoo to generate accurate financial reports.
For the API to work, you need to create the same accounts as the default accounts of your Employment
Hero business (**same name and same code**) in Odoo. You also need to choose the correct account
types in Odoo to generate accurate financial reports.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB