diff --git a/content/applications/finance/fiscal_localizations.rst b/content/applications/finance/fiscal_localizations.rst index aee9de575..84eb3b9c0 100644 --- a/content/applications/finance/fiscal_localizations.rst +++ b/content/applications/finance/fiscal_localizations.rst @@ -93,11 +93,12 @@ available on Odoo. - :doc:`Kenya - Accounting ` - Lithuania - Accounting - :doc:`Luxembourg - Accounting ` +- :doc:`Malaysia - Accounting ` - Maroc - Accounting - :doc:`Mexico - Accounting ` - Mongolia - Accounting - :doc:`Netherlands - Accounting ` -- New Zealand - Accounting +- :doc:`New Zealand - Accounting ` - Norway - Accounting - OHADA - Accounting - Pakistan - Accounting @@ -146,8 +147,10 @@ available on Odoo. fiscal_localizations/italy fiscal_localizations/kenya fiscal_localizations/luxembourg + fiscal_localizations/malaysia fiscal_localizations/mexico fiscal_localizations/netherlands + fiscal_localizations/new_zealand fiscal_localizations/romania fiscal_localizations/peru fiscal_localizations/philippines @@ -159,3 +162,4 @@ available on Odoo. fiscal_localizations/vietnam fiscal_localizations/united_arab_emirates fiscal_localizations/united_kingdom + fiscal_localizations/employment_hero diff --git a/content/applications/finance/fiscal_localizations/australia.rst b/content/applications/finance/fiscal_localizations/australia.rst index ddd507e48..09ce28bd2 100644 --- a/content/applications/finance/fiscal_localizations/australia.rst +++ b/content/applications/finance/fiscal_localizations/australia.rst @@ -35,9 +35,6 @@ Configuration - `l10n_account_customer_statements` - Allows the management and sending of monthly customer statements from the partner ledger and the contact form. Also used in New Zealand. - * - :guilabel:`Employment Hero Australian Payroll` - - `l10n_au_keypay` - - Synchronises all pay runs from Employment Hero with Odoo’s journal entries. .. _australia/coa: @@ -861,70 +858,12 @@ from the batch. .. _australia/employment-hero: -Employment Hero Australian Payroll -================================== +Employment Hero payroll +======================= -If your business is already up and running with `Employment Hero `_, -you can use our connector as an alternative payroll solution. - -The Employment Hero 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. We only record the **journal entries** in Odoo. +If your business is already up and running with :doc:`Employment Hero `, you can +use our connector as an alternative payroll solution. .. important:: - KeyPay was rebranded as **Employment Hero** in March 2023. - -Configuration -------------- - -#. :ref:`Activate ` the :guilabel:`Employment Hero Australian Payroll` module - (`l10n_au_keypay`). -#. 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:: australia/employment-hero-integration.png - :alt: Enabling Employment Hero Integration in Odoo Accounting displays new fields in the - settings - - - You can find the API Key in the :guilabel:`My Account` section of the Employment Hero platform. - - .. 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`. - - .. warning:: - Do not change the **pre-filled Payroll URL** - - - You can find the **Business ID** in the Employment Hero URL. (i.e., `189241`) - - .. 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. - -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:: australia/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. You can fetch the records 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:: australia/employment-hero-chart-of-accounts.png - :alt: Chart of Accounts menu in Employment Hero - -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. + To :ref:`configure the Employment Hero API ` for **Australia**, + use the following value as :guilabel:`Payroll URL`: `https://api.yourpayroll.com.au/`. diff --git a/content/applications/finance/fiscal_localizations/australia/employment-hero-integration.png b/content/applications/finance/fiscal_localizations/australia/employment-hero-integration.png deleted file mode 100644 index 403a8a39d..000000000 Binary files a/content/applications/finance/fiscal_localizations/australia/employment-hero-integration.png and /dev/null differ diff --git a/content/applications/finance/fiscal_localizations/employment_hero.rst b/content/applications/finance/fiscal_localizations/employment_hero.rst new file mode 100644 index 000000000..7566d8882 --- /dev/null +++ b/content/applications/finance/fiscal_localizations/employment_hero.rst @@ -0,0 +1,73 @@ +======================= +Employment Hero Payroll +======================= + +The `Employment Hero `_ 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. We only record the **journal entries** in +Odoo. + +.. important:: + KeyPay was rebranded as **Employment Hero** in March 2023. + +.. _employment_hero/configuration: + +Configuration +------------- + +#. :ref:`Activate ` 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 + + - You can find the API Key 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 your localization. + + .. note:: + Employment hero is available for :ref:`Australia `, + :ref:`Malaysia `, + :ref:`New Zealand `, + :ref:`Singapore `, + and the :ref:`United Kingdom `. + + - You can find the **Business ID** 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 + + - You can choose any Odoo journal to post the payslip entries. + +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. You can fetch the records 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, 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. diff --git a/content/applications/finance/fiscal_localizations/australia/employment-hero-business-id.png b/content/applications/finance/fiscal_localizations/employment_hero/employment-hero-business-id.png similarity index 100% rename from content/applications/finance/fiscal_localizations/australia/employment-hero-business-id.png rename to content/applications/finance/fiscal_localizations/employment_hero/employment-hero-business-id.png diff --git a/content/applications/finance/fiscal_localizations/australia/employment-hero-chart-of-accounts.png b/content/applications/finance/fiscal_localizations/employment_hero/employment-hero-chart-of-accounts.png similarity index 100% rename from content/applications/finance/fiscal_localizations/australia/employment-hero-chart-of-accounts.png rename to content/applications/finance/fiscal_localizations/employment_hero/employment-hero-chart-of-accounts.png diff --git a/content/applications/finance/fiscal_localizations/employment_hero/employment-hero-integration.png b/content/applications/finance/fiscal_localizations/employment_hero/employment-hero-integration.png new file mode 100644 index 000000000..91e94131e Binary files /dev/null and b/content/applications/finance/fiscal_localizations/employment_hero/employment-hero-integration.png differ diff --git a/content/applications/finance/fiscal_localizations/australia/employment-hero-journal-entry.png b/content/applications/finance/fiscal_localizations/employment_hero/employment-hero-journal-entry.png similarity index 100% rename from content/applications/finance/fiscal_localizations/australia/employment-hero-journal-entry.png rename to content/applications/finance/fiscal_localizations/employment_hero/employment-hero-journal-entry.png diff --git a/content/applications/finance/fiscal_localizations/australia/employment-hero-myaccount.png b/content/applications/finance/fiscal_localizations/employment_hero/employment-hero-myaccount.png similarity index 100% rename from content/applications/finance/fiscal_localizations/australia/employment-hero-myaccount.png rename to content/applications/finance/fiscal_localizations/employment_hero/employment-hero-myaccount.png diff --git a/content/applications/finance/fiscal_localizations/malaysia.rst b/content/applications/finance/fiscal_localizations/malaysia.rst new file mode 100644 index 000000000..6facefc00 --- /dev/null +++ b/content/applications/finance/fiscal_localizations/malaysia.rst @@ -0,0 +1,15 @@ +======== +Malaysia +======== + +.. _malaysia/employment-hero: + +Employment Hero payroll +======================= + +If your business is already up and running with :doc:`Employment Hero `, you can +use our connector as an alternative payroll solution. + +.. important:: + To :ref:`configure the Employment Hero API ` for **Malaysia**, use + the following value as :guilabel:`Payroll URL`: `https://apimy.yourpayroll.io/`. diff --git a/content/applications/finance/fiscal_localizations/new_zealand.rst b/content/applications/finance/fiscal_localizations/new_zealand.rst new file mode 100644 index 000000000..b8485748f --- /dev/null +++ b/content/applications/finance/fiscal_localizations/new_zealand.rst @@ -0,0 +1,15 @@ +=========== +New Zealand +=========== + +.. _new-zealand/employment-hero: + +Employment Hero payroll +======================= + +If your business is already up and running with :doc:`Employment Hero `, you can +use our connector as an alternative payroll solution. + +.. important:: + To :ref:`configure the Employment Hero API ` for **New Zealand**, + use the following value as :guilabel:`Payroll URL`: `https://api.nzpayroll.co.nz/`. diff --git a/content/applications/finance/fiscal_localizations/singapore.rst b/content/applications/finance/fiscal_localizations/singapore.rst index 674293e5b..6569f6d5e 100644 --- a/content/applications/finance/fiscal_localizations/singapore.rst +++ b/content/applications/finance/fiscal_localizations/singapore.rst @@ -52,3 +52,16 @@ QR-code` option to *EMV Merchant-Presented QR-code*. Ensure that the :guilabel:`Recipient Bank` is the one you configured, as Odoo uses this field to generate the PayNow QR code. + +.. _singapore/employment-hero: + +Employment Hero payroll +======================= + +If your business is already up and running with :doc:`Employment Hero `, you can +use our connector as an alternative payroll solution. + +.. important:: + To :ref:`configure the Employment Hero API ` for **Singapore**, + use the following value as :guilabel:`Payroll URL`: `https://apisg.yourpayroll.io/`. + diff --git a/content/applications/finance/fiscal_localizations/united_kingdom.rst b/content/applications/finance/fiscal_localizations/united_kingdom.rst index f47a734c7..9b392a6e1 100644 --- a/content/applications/finance/fiscal_localizations/united_kingdom.rst +++ b/content/applications/finance/fiscal_localizations/united_kingdom.rst @@ -118,3 +118,15 @@ each submission: .. note:: During this process, the :guilabel:`Connect to HMRC` button no longer appears for other UK-based companies. + +.. _united-kingdom/employment-hero: + +Employment Hero payroll +======================= + +If your business is already up and running with :doc:`Employment Hero `, you can +use our connector as an alternative payroll solution. + +.. important:: + To :ref:`configure the Employment Hero API ` for **United + Kingdom**, use the following value as :guilabel:`Payroll URL`: `https://api.yourpayroll.co.uk/`.