diff --git a/accounting/fiscal_localizations/localizations.rst b/accounting/fiscal_localizations/localizations.rst index 2fa5c8810..10725dae2 100644 --- a/accounting/fiscal_localizations/localizations.rst +++ b/accounting/fiscal_localizations/localizations.rst @@ -6,6 +6,7 @@ Localizations :titlesonly: localizations/argentina + localizations/australia localizations/chile localizations/colombia localizations/colombia_ES diff --git a/accounting/fiscal_localizations/localizations/australia.rst b/accounting/fiscal_localizations/localizations/australia.rst new file mode 100644 index 000000000..144e07b0c --- /dev/null +++ b/accounting/fiscal_localizations/localizations/australia.rst @@ -0,0 +1,79 @@ +========= +Australia +========= + +.. _australia/keypay: + +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. + +.. note:: + The KeyPay Module is installed by default with the Australian localization module. + +Configuration Steps +------------------- + +#. Create a company located in Australia. +#. Check that the Australian localization module (Australia - Accounting) is installed. +#. Configure the *KeyPay API*. + + .. image:: media/australia-keypay-api.png + :align: center + :alt: Odoo Accounting settings includes a section for the Australian Loclization + +#. More fields become visible after clicking on *Enable KeyPay Integration*. + + .. image:: media/australia-keypay-integration.png + :align: center + :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. + + .. image:: media/australia-keypay-myaccount.png + :align: center + :alt: "Account Details" section on the KeyPay 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``) + + .. image:: media/australia-keypay-business-id.png + :align: center + :alt: The KeyPay "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 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. + +.. image:: media/australia-keypay-journal-entry.png + :align: center + :alt: Example of a KeyPay Journal Entry in Odoo Accounting (Australia) + +.. note:: + The API sync is triggered by scheduled actions. + + .. image:: media/australia-keypay-scheduled-actions.png + :align: center + :alt: Scheduled Actions settings for KeyPay Payroll in Odoo (debug mode) + +KeyPay payslip entries also work based on double-entry bookkeeping. Debit must equal credit (like in +Odoo). + +The accounts used by KeyPay are defined in the section **Payroll settings**. + +.. image:: media/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. \ No newline at end of file diff --git a/accounting/fiscal_localizations/localizations/media/australia-keypay-api.png b/accounting/fiscal_localizations/localizations/media/australia-keypay-api.png new file mode 100644 index 000000000..568afa51e Binary files /dev/null and b/accounting/fiscal_localizations/localizations/media/australia-keypay-api.png differ diff --git a/accounting/fiscal_localizations/localizations/media/australia-keypay-business-id.png b/accounting/fiscal_localizations/localizations/media/australia-keypay-business-id.png new file mode 100644 index 000000000..da6c83363 Binary files /dev/null and b/accounting/fiscal_localizations/localizations/media/australia-keypay-business-id.png differ diff --git a/accounting/fiscal_localizations/localizations/media/australia-keypay-chart-of-accounts.png b/accounting/fiscal_localizations/localizations/media/australia-keypay-chart-of-accounts.png new file mode 100644 index 000000000..7c5d89215 Binary files /dev/null and b/accounting/fiscal_localizations/localizations/media/australia-keypay-chart-of-accounts.png differ diff --git a/accounting/fiscal_localizations/localizations/media/australia-keypay-integration.png b/accounting/fiscal_localizations/localizations/media/australia-keypay-integration.png new file mode 100644 index 000000000..b2bf71ab8 Binary files /dev/null and b/accounting/fiscal_localizations/localizations/media/australia-keypay-integration.png differ diff --git a/accounting/fiscal_localizations/localizations/media/australia-keypay-journal-entry.png b/accounting/fiscal_localizations/localizations/media/australia-keypay-journal-entry.png new file mode 100644 index 000000000..71a9ced75 Binary files /dev/null and b/accounting/fiscal_localizations/localizations/media/australia-keypay-journal-entry.png differ diff --git a/accounting/fiscal_localizations/localizations/media/australia-keypay-myaccount.png b/accounting/fiscal_localizations/localizations/media/australia-keypay-myaccount.png new file mode 100644 index 000000000..be5b17a67 Binary files /dev/null and b/accounting/fiscal_localizations/localizations/media/australia-keypay-myaccount.png differ diff --git a/accounting/fiscal_localizations/localizations/media/australia-keypay-scheduled-actions.png b/accounting/fiscal_localizations/localizations/media/australia-keypay-scheduled-actions.png new file mode 100644 index 000000000..14a3ee2f9 Binary files /dev/null and b/accounting/fiscal_localizations/localizations/media/australia-keypay-scheduled-actions.png differ