Description | Kadmos plugin to process secure payments |
Latest Version | 2024.10.2.151 |
Release Date | 28 Oct |
Download Path | |
Type | APM Plugin |
| Note |
|---|
Compatible with version 2024.20.11 Patch 11 and higher |
| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
Introduction
Kadmos is an end-to-end salary payments platform that powers secure payments to employees across the globe. The platform is a reliable and efficient payment platform that can handle various payment methods.
The Kadmos plug-in collects transactions and transfers them to the Kadmos interface. Based on the collected transactions, Kadmos compensates the amounts to crew members' eWallets.
This guide will walk you through the procedure on how to select the required payment type (Net Payment, Advance Payment, Additional Payment) as well as transferring the transactions to the Kadmos interface.
Functionality
The section will teach you how to operate the plugin.
To get started, first, open the plugin. For this, switch to the Tools ribbon tab and click the Export button. From the drop-down list, select Kadmos:
...
The Kadmos main screen then appears:
...
The Kadmos plugin includes 4 tabs:
Candidates
Waiting for eWallet
Active Members
Payment
Kadmos Enrollment
The Candidates tab shows a list of employed crew members based on the current crew list view as well crew members' personal details:
...
To enroll crew member(s) to Kadmos, follow the steps below:
On the Candidates tab, select crew member(s) to be enrolled to Kadmos.
Click Enroll to Kadmos.
As a result, a crew member is successfully enrolled:
...
| Info |
|---|
For successful enrollment, make sure all mandatory fields are filled in. For more information on mandatory fields, see Field Mapping. |
...
Once successfully enrolled in Kadmos, crew members get invitation emails. By following the directions in invitation emails, crew members must activate their accounts. Employees with pending activations are displayed on the Waiting for eWallet tab:
...
Besides, you can resend the invitation to an employee. For this, select a crew member and click the Resend Invitation button.
...
On activating accounts, affected crew members are moved to the Active Members tab:
...
On enrollment, the Payroll balance action may be either automatically set to Kadmos or manually set to any other balance action. It depends on the preset setup. For more information, see General Settings.
Payment
There are three payment types that may be processed:
Net Payment stands for the amounts registered as Entry Code 994 Net wages (default value).
Advance Payment is meant for the amounts registered in Entry Codes with the Advance Entry Code option.
Additional Payment stands for the amounts registered in Entry Codes with the Additional Payment option.
| Info |
|---|
For more information on payment types, see Entry Codes. |
The section will walk you through the detailed instructions on how to process each type of payment.
Net Payment
To process the net payment, access the Payment tab and proceed with the steps below:
...
Click the Add Payment button. This opens the Add New Payment dialog:
...
...
On the dialog, select Net Payment. This invokes the Net Payment dialog where you can see a list of payment records ready for transfer.
Only members with active eWallets are validated to receive a Payout.
...
Please note that employees are filtered out based on the assigned entry code and Kadmos balance action.
...
Select the record(s) to be transferred and click Create New Payment:
...
On the Payment Details dialog, fill out the payment details to be processed:
...
Payment Name. Enter the payment name. The field is grayscaled, and, thus, locked for editing, in case the default payment name is defined in Setup (see General Settings).
...
Description. Enter the payment description.
...
Currency. Select the currency for payment processing. In case the default currency is defined in Setup (see General Settings), it appears in the field, however, you can still change it based on your preferences.
...
Package (available only in case predefined in General Settings). From the drop-down list, select the
Payment Date. In the calendar picker, select the date for payment processing. Please note the selected payment date will be displayed in Payroll after locking transactions marked as PAID.
...
As a result, a new package appears in the Payment grid:
...
| Info |
|---|
All the transferred 994 entry codes are automatically locked. This means that the amounts of the transactions will not be modified after calculation even if any of the parameters such as Payscale rate, Activity dates, etc. are changed. The entry code will be marked as PAID proceeding with the Payment Date defined on the Payment Details dialog. The transactions can be unlocked (Payroll > Set > Unlock Payroll Transactions) provided that a user has corresponding access rights. |
Advance Payment
To process the net payment, access the Payment tab and proceed with the steps below:
...
Click the Add Payment button. This opens the Add New Payment dialog:
...
On the dialog, select Advance Payment. This invokes the Advance Payment dialog where you can see a list of payment records ready for transfer:
...
Select the record(s) to be transferred and click Create New Payment.
...
On the Payment Details dialog, fill out the payment details to be processed and click OK to proceed:
Payment Name. Enter the payment name. The field is grayscaled, and, thus, locked for editing, in case the default payment name is defined in Setup (see General Settings).
Description. Enter the payment description.
Currency. Select the currency for payment processing. In case the default currency is defined in Setup (see General Settings), it appears in the field, however, you can still change it based on your preferences.
Package (available only in case predefined in General Settings). From the drop-down list, select the
Payment Date. In the calendar picker, select the date for payment processing. Please note the selected payment date will be displayed in Payroll after locking transactions marked as PAID.
Once completed, click OK to proceed.
As a result, a new payment is successfully created in Kadmos and new package appears in the grid:
...
| Info |
|---|
All the transferred advance entry codes are automatically locked. This means that the amounts of the transactions will not be modified after calculation even if any of the parameters such as Payscale rate, Activity dates, etc get changed. The entry code will be marked as PAID proceeding with the date when the transaction was processed:  The transactions can be unlocked (Payroll > Set > Unlock Payroll Transactions) provided that a user has corresponding access rights. |
Additional Payment
To process the net payment, access the Payment tab and proceed with the steps below:
...
Click the Add Payment button. This opens the Add New Payment dialog:
...
On the dialog, select Additional Payment. This invokes the Additional Payment dialog where you can see a list of payment records ready for transfer:
...
Select the record(s) to be transferred and click Create New Payment.
...
On the Payment Details dialog, fill out the payment details to be processed and click OK to proceed:
Payment Name. Enter the payment name. The field is grayscaled, and, thus, locked for editing, in case the default payment name is defined in Setup (see General Settings).
Description. Enter the payment description.
Currency. Select the currency for payment processing. In case the default currency is defined in Setup (see General Settings), it appears in the field, however, you can still change it based on your preferences.
Package (available only in case predefined in General Settings). From the drop-down list, select the
Payment Date. In the calendar picker, select the date for payment processing. Please note the selected payment date will be displayed in Payroll after locking transactions marked as PAID.
Once completed, click OK to proceed.
As a result, a new payment is successfully created in Kadmos and new package appears in the grid:
...
| Info |
|---|
All the transferred additional entry codes are automatically locked. This means that the amounts of the transactions will not be modified after calculation even if any of the parameters such as Payscale rate, Activity dates, etc. get changed. The entry code will be marked as PAID proceeding with the date when the transaction was processed:  The transactions can be unlocked (Payroll > Set > Unlock Payroll Transactions) provided that a user has corresponding access rights. |
Housekeeping
This section describes a one-time setup you need to perform to make the plug-in fully functional.
Installation
To install the plug-in, navigate to Install APM Plugin and follow the step-by-step instructions carefully.
The latest plug-in version is available here: http://download.adonis.no/files/upgrade/PersonnelManager/Plugins/Kadmos/
Connection and Authentication
For data transfer, you need to configure the Kadmos connection and authentication settings. To do this, follow the steps below:
On the Kadmos plugin main screen, click the Setup button. This invokes the Setup dialog.
On the Setup dialog, navigate to the Authentication tab:
Fill in the fields in the Authentication tab.
| Info |
|---|
Сonnection and authentication details are provided by Kadmos. |
On entering the connection and authentication details, click Save.
Additionally, you can define the path to the folder where log files will be stored. Simply, select Is Debug and select a folder.
...
You can define general settings related to package usage, default payment names and default currency. For this, on the Kadmos plugin main screen, navigate to Setup > the General tab:
...
In the Package section, define whether packages are to be used as part of payment details:
Use Packages. Select the option if you want to include a package to the payment details.
Apply package only to first salary of the crew member (available only if Use Packages is enabled). Select the option to make a package predefined for all subsequent payments.
| Expand | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
In case packages are enabled in Setup, they are available on the Payment Details dialog: 
|
Introduction
Kadmos is an end-to-end salary payments platform that powers secure payments to employees across the globe. The platform is a reliable and efficient payment platform that can handle various payment methods.
The Kadmos plug-in collects transactions and transfers them to the Kadmos interface. Based on the collected transactions, Kadmos compensates the amounts to crew members' eWallets.
This guide will walk you through the procedure on how to select the required payment type (Net Payment, Advance Payment, Additional Payment) as well as transferring the transactions to the Kadmos interface.
Functionality
The section will teach you how to operate the plugin.
To get started, first, open the plugin. For this, switch to the Tools ribbon tab and click the Export button. From the drop-down list, select Kadmos:
...
The Kadmos main screen then appears:
...
The Kadmos plugin includes 4 tabs:
Candidates
Waiting for eWallet
Active Members
Payment
Kadmos Enrollment
The Candidates tab shows a list of employed crew members based on the current crew list view as well crew members' personal details:
...
To enroll crew member(s) in Kadmos, follow the steps below:
On the Candidates tab, select crew member(s) to be enrolled in Kadmos.
Click Enroll to Kadmos.
As a result, a crew member is successfully enrolled:
...
| Info |
|---|
For successful enrollment, make sure all mandatory fields are filled in. For more information on mandatory fields, see Field Mapping. |
As part of crew enrollment, the plugin checks whether crew members already have active accounts in Kadmos by comparing their Worker Reference numbers in Kadmos with the PIN numbers in APM. Other option is to add a prefix before the PIN where a Worker Reference should contain the same prefix. Active crew members are then fetched directly to theActive Members tab, while inactive crew members are then listed on the Waiting for eWallet tab.
| Anchor | ||||
|---|---|---|---|---|
|
Once successfully enrolled in Kadmos, crew members get invitation emails. By following the directions in invitation emails, crew members must activate their accounts. Employees with pending activations are displayed on the Waiting for eWallet tab:
...
Besides, you can resend the invitation to an employee. For this, select a crew member and click the Resend Invitation button.
There can be different Wallet Statuses displayed. Below 2 are specific ones:
REJECTED - means that the crewmember has failed the identity verification process and needs to redo it. Once they pass identity verification, they will be moved to Active.
UNAVAILABLE - crew were rejected to have an account in Kadmos due to some limitaions/rules. E.g. if crew are from some countries, which Kadmos doesn’t cover.
| Info |
|---|
A crew member will soon move to the next tab once the Wallet Status and User Status are both active. |
| Anchor | ||||
|---|---|---|---|---|
|
On activating accounts, affected crew members are moved to the Active Members tab:
...
On enrollment, the Payroll balance action may be either automatically set to Kadmos or manually set to any other balance action. It depends on the preset setup. For more information, see General Settings.
Payment
There are three payment types that may be processed:
Net Payment stands for the amounts registered as Entry Code 994 Net wages (default value).
Advance Payment is meant for the amounts registered in Entry Codes with the Advance Entry Code option.
Additional Payment stands for the amounts registered in Entry Codes with the Additional Payment option.
| Info |
|---|
For more information on payment types, see Entry Codes. |
The section will walk you through the detailed instructions on how to process each type of payment.
Net Payment
To process the net payment, access the Payment tab and proceed with the steps below:
Click the Add Payment button. This opens the Add New Payment dialog:
On the dialog, select Net Payment. This invokes the Net Payment dialog where you can see a list of payment records ready for transfer.
Only members with active eWallets are validated to receive a Payout.
Please note that employees are filtered out based on the assigned entry code and Kadmos balance action.The Default Package can be applied at once to the selected rows. In the Settings, it can be defined as well if the package should only be applied to the first salary of the period.
Select the record(s) to be transferred and click Create New Payment:
On the Payment Details dialog, fill out the payment details to be processed:
Payment Name. Enter the payment name. The field is grayscaled, and, thus, locked for editing, in case the default payment name is defined in Setup (see General Settings).
Description. Enter the payment description.
Currency. Select the currency for payment processing. In case the default currency is defined in Setup (see General Settings), it appears in the field, however, you can still change it based on your preferences.
Payment Date. In the calendar picker, select the date for payment processing. Please note the selected payment date will be displayed in Payroll after locking transactions marked as PAID.
Once completed, click OK to proceed.
As a result, a new package appears in the Payment grid:
...
| Info |
|---|
All the transferred 994 entry codes are automatically locked. This means that the amounts of the transactions will not be modified after calculation even if any of the parameters such as Payscale rate, Activity dates, etc. are changed. The entry code will be marked as PAID proceeding with the Payment Date defined on the Payment Details dialog. The transactions can be unlocked (Payroll > Set > Unlock Payroll Transactions) provided that a user has corresponding access rights. |
Advance Payment
To process the net payment, access the Payment tab and proceed with the steps below:
Click the Add Payment button. This opens the Add New Payment dialog:
On the dialog, select Advance Payment. This invokes the Advance Payment dialog where you can see a list of payment records ready for transfer:
Please note that employees are filtered out based on the assigned entry code and Kadmos balance action.The Default Package can be applied at once to the selected rows. In the Settings, it can be defined as well if the package should only be applied to the first salary of the period.
Select the record(s) to be transferred and click Create New Payment.
On the Payment Details dialog, fill out the payment details to be processed and click OK to proceed:
Payment Name. Enter the payment name. The field is grayscaled, and, thus, locked for editing, in case the default payment name is defined in Setup (see General Settings).
Description. Enter the payment description.
Currency. Select the currency for payment processing. In case the default currency is defined in Setup (see General Settings), it appears in the field, however, you can still change it based on your preferences.
Payment Date. In the calendar picker, select the date for payment processing. Please note the selected payment date will be displayed in Payroll after locking transactions marked as PAID.
Once completed, click OK to proceed.
As a result, a new payment is successfully created in Kadmos and new package appears in the grid:
...
| Info |
|---|
All the transferred advance entry codes are automatically locked. This means that the amounts of the transactions will not be modified after calculation even if any of the parameters such as Payscale rate, Activity dates, etc get changed. The entry code will be marked as PAID proceeding with the date when the transaction was processed: The transactions can be unlocked (Payroll > Set > Unlock Payroll Transactions) provided that a user has corresponding access rights. |
Additional Payment
To process the net payment, access the Payment tab and proceed with the steps below:
Click the Add Payment button. This opens the Add New Payment dialog:
On the dialog, select Additional Payment. This invokes the Additional Payment dialog where you can see a list of payment records ready for transfer:
Please note that employees are filtered out based on the assigned entry code and Kadmos balance action.The Default Package can be applied at once to the selected rows. In the Settings, it can be defined as well if the package should only be applied to the first salary of the period.
Select the record(s) to be transferred and click Create New Payment.
On the Payment Details dialog, fill out the payment details to be processed and click OK to proceed:
Payment Name. Enter the payment name. The field is grayscaled, and, thus, locked for editing, in case the default payment name is defined in Setup (see General Settings).
Description. Enter the payment description.
Currency. Select the currency for payment processing. In case the default currency is defined in Setup (see General Settings), it appears in the field, however, you can still change it based on your preferences.
Package (available only in case predefined in General Settings). From the drop-down list, select the
Payment Date. In the calendar picker, select the date for payment processing. Please note the selected payment date will be displayed in Payroll after locking transactions marked as PAID.
Once completed, click OK to proceed.
As a result, a new payment is successfully created in Kadmos and new package appears in the grid:
...
| Info |
|---|
All the transferred additional entry codes are automatically locked. This means that the amounts of the transactions will not be modified after calculation even if any of the parameters such as Payscale rate, Activity dates, etc. get changed. The entry code will be marked as PAID proceeding with the date when the transaction was processed: The transactions can be unlocked (Payroll > Set > Unlock Payroll Transactions) provided that a user has corresponding access rights. |
Housekeeping
This section describes a one-time setup you need to perform to make the plug-in fully functional.
| Info |
|---|
The plugin setup is restricted to Administrators only (99-level users in Adonis Control Center). |
Installation
To install the plug-in, navigate to Install APM Plugin and follow the step-by-step instructions carefully.
The latest plug-in version is available here: http://download.adonis.no/files/upgrade/PersonnelManager/Plugins/Kadmos/
Connection and Authentication
For data transfer, you need to configure the Kadmos connection and authentication settings. To do this, follow the steps below:
On the Kadmos plugin main screen, click the Setup button. This invokes the Setup dialog.
On the Setup dialog, navigate to the Authentication tab:
Fill in the fields in the Authentication tab.
| Info |
|---|
Сonnection and authentication details are provided by Kadmos. |
On entering the connection and authentication details, click Save.
Additionally, you can define the path to the folder where log files will be stored. Simply, select Is Debug and select a folder.
| Anchor | ||||
|---|---|---|---|---|
|
You can define general settings related to package usage, default payment names and default currency. For this, on the Kadmos plugin main screen, navigate to Setup > the General tab:
...
The Reference Prefix will add a prefix to the crew member’s PIN and it will be mapped to the Worker Reference in Kadmos.
In the Payment section, define payment-related parameters:
...
| Expand | ||
|---|---|---|
| ||
In case the Use Kadmos as Primary Payment Method checkbox is selected in Setup, the balance action of enrolled crew members changes to Kadmos:  In case the Use Kadmos as Primary Payment Method checkbox is unchecked, after crew enrollment, the balance action is not set to Kadmos and other balance actions can be used. Please note it is also possible to use the Common Payment Receiver with the Kadmos balance action. In this case, the Kadmos balance action is automatically set while adding a required entry. set to Kadmos and other balance actions can be used. Please note it is also possible to use the Common Payment Receiver with the Kadmos balance action. In this case, the Kadmos balance action is automatically set while adding a required entry. |
In the Payout section, define whether packages are to be used as part of payment details:
Apply package only to first salary of the period. Select the option to make the package applied only to the crew members who receives their first payment of the period.
| Anchor | ||||
|---|---|---|---|---|
|
...
Net Payment stands for the amounts registered as Entry Code 994 Net wages (default value).
Advance Payment is meant for the amounts registered in Entry Codes with the Advance Entry Code option.
| Expand | ||
|---|---|---|
| ||
  |
Additional Payment stands for the amounts registered in Entry Codes with the Additional Payment option.
| Expand | ||
|---|---|---|
| ||
  |
Make sure to select the entry codes to be considered in each payment type: Net Payment, Advance Payment, and Additional Payment.
...
Kadmos Field | Adonis Mapping | Sample Value | Mandatory | Description/Comments | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
| ||||||||||||||||
| FIRSTNAME | Mercy |
|
| ||||||||||||||
| LASTNAME | Benz |
|
| ||||||||||||||
| ADDRESS_COUNTRY | IN |
| The residence country code in two-letter ISO 3166-1 ALPHA-2 format. |
| MOBILE | +46 42552223 | |||||||||||
|
|
| NATIONALITY | DE |
| The nationality of the user in two-letter ISO 3166-1 ALPHA-2 format. | ||||||||||||
| CURRENCYFORPAYMENT | EUR |
|
| ||||||||||||||
| ADDRESS | Yellowrose |
|
| ||||||||||||||
| ADDRESS1 | 11 |
|
| ||||||||||||||
| POSTCODE | 1234G |
|
| ||||||||||||||
| POSTPLACE | Mumbai |
|
| ||||||||||||||
| ADDRESS_COUNTRY | IN |
| The country code in two-letter ISO 3166-1 ALPHA-2 format. |