mirror of
https://github.com/odoo/documentation.git
synced 2025-12-12 07:29:27 +07:00
de2e691f0e
closes odoo/documentation#13874
X-original-commit: 35f3f29054
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
77 lines
3.5 KiB
ReStructuredText
77 lines
3.5 KiB
ReStructuredText
=======================
|
|
Employment Hero Payroll
|
|
=======================
|
|
|
|
The `Employment Hero <https://employmenthero.com/>`_ module synchronises payslip accounting entries
|
|
(e.g., expenses, social charges, liabilities, taxes) automatically from Employment Hero to Odoo.
|
|
Payroll administration is still done in Employment Hero, but the **journal entries** are done in
|
|
Odoo.
|
|
|
|
.. important::
|
|
KeyPay was rebranded as **Employment Hero** in March 2023.
|
|
|
|
.. _employment_hero/configuration:
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
#. :ref:`Activate <general/install>` the :guilabel:`Employment Hero Payroll` module
|
|
(`l10n_employment_hero`).
|
|
#. Configure the **Employment Hero API** by going to :menuselection:`Accounting --> Configuration
|
|
--> Settings`. More fields become visible after clicking on :guilabel:`Enable Employment Hero
|
|
Integration`.
|
|
|
|
.. image:: employment_hero/employment-hero-integration.png
|
|
:alt: Enabling Employment Hero Integration in Odoo Accounting displays new fields in the
|
|
settings
|
|
|
|
- The API Key can be found in the :guilabel:`My Account` section of the Employment Hero platform.
|
|
|
|
.. image:: employment_hero/employment-hero-myaccount.png
|
|
:alt: "Account Details" section on the Employment Hero dashboard
|
|
|
|
- The **Payroll URL** is left empty by default to avoid any confusion. Please fill it according
|
|
to the documentation specific to the localization.
|
|
|
|
.. note::
|
|
Employment hero is available for :ref:`Australia <payroll/l10n_au/employment-hero>`,
|
|
:ref:`Malaysia <malaysia/employment-hero>`,
|
|
:ref:`New Zealand <new-zealand/employment-hero>`,
|
|
:ref:`Singapore <singapore/employment-hero>`,
|
|
and the :ref:`United Kingdom <localization/united-kingdom/employment-hero>`.
|
|
|
|
- The **Business ID** can be found in the Employment Hero URL. (i.e., `189241`)
|
|
|
|
.. image:: employment_hero/employment-hero-business-id.png
|
|
:alt: The Employment Hero Business ID number is in the URL
|
|
|
|
- Choose any Odoo journal to post the payslip entries.
|
|
#. Configure the tax by going to :menuselection:`Accounting --> Configuration --> Taxes`. Create the
|
|
necessary taxes for the Employment Hero payslip entries. Fill in the tax code from
|
|
**Employment Hero** in the :guilabel:`Matching Employment Hero Tax` field.
|
|
|
|
How does the API work?
|
|
----------------------
|
|
|
|
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:: employment_hero/employment-hero-journal-entry.png
|
|
:alt: Example of a Employment Hero Journal Entry in Odoo Accounting (Australia)
|
|
|
|
By default, the synchronisation happens once per week. The records can be fetched manually by going
|
|
to :menuselection:`Accounting --> Configuration --> Settings` and, in the :guilabel:`Enable
|
|
Employment Hero Integration` option, click on :guilabel:`Fetch Payruns Manually`.
|
|
|
|
Employment Hero payslip entries also work based on double-entry bookkeeping.
|
|
|
|
The accounts used by Employment Hero are defined in the section :guilabel:`Payroll settings`.
|
|
|
|
.. image:: employment_hero/employment-hero-chart-of-accounts.png
|
|
:alt: Chart of Accounts menu in Employment Hero
|
|
|
|
For the API to work, create the same accounts as the default accounts of the Employment Hero
|
|
business (**same name and same code**) in Odoo. The correct account types must be chosen in Odoo to
|
|
generate accurate financial reports.
|