Skip to end of banner
Go to start of banner

Kadmos plugin

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 25 Next »

Description

Kadmos plugin to process secure payments

Latest Version

2024.10.2.1

Release Date

Download Path

Download

Type

APM Plugin

Compatible with version 2024.20.11 Patch 11 and higher

 Change Log

Version

When

Release Notes

2024.10.2.1

APMPI-1379 - Тot possible to enroll people with existing accounts

From now plugin will check if there is any account on the Kadmos side with Reference field equal to APM PIN. If yes, then will link this person to the existing Kadmos account and move person to corresponding tab in the Kadmos Plugin. If no, then new account will be created.

APMPI-1380 - Тot possible to enroll people from the vessel

Kadmos plugin will fetch all employed persons under current crew list view.

APMPI-1381 - Error when opening the plugin

Fixed error that was appearing, when there are more than one PostCode with the same PostName under the same country. From now City field will be fetched directly from the P01.PostPlace.

APMPI-1382 - Тot possible to set needed payment date

Added possibility to select Payment date during creating Payments. Paid Payroll Entries will be locked using selected payment date.

image-20241028-152258.png

APMPI-1383 - Тot possible to cover payments to Kadmos and Berenberg at the same time

Added new option Use Kadmos as Primary Payment method.

  • By default option is turned on;

  • If turned on, then person`s balance action will become Kadmos during enrollment to Kadmos;

  • If turned off, then person`s balance action will not be changed during enrollment.

image-20241028-152334.png

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:

kadmos_functionality_tools_export.png

The Kadmos main screen then appears:

kadmos_functionality_initial_dialog.png

The Kadmos plugin includes 4 tabs:

  • Candidates

  • Waiting for eWallet

  • Active Members

  • Payment

Kadmos Enrollment

The Candidates Tab will display all employed persons under the current crew list view.

The Candidates tab shows a list of employed crew members based on the current crew list view as well crew members' personal details:

image-20241028-111546.png

To enroll crew member(s) to Kadmos, follow the steps below:

  1. On the Candidates tab, select crew member(s) to be enrolled to Kadmos.

  2. Click Enroll to Kadmos.

As a result, a crew member is successfully enrolled:

kadmos_functionality_enrolled_to_cadmos.png

For successful enrollment, make sure all mandatory fields are filled in. For more information on mandatory fields, see Field Mapping.

Enrolling a person with an active eWallet

The plugin will check if there is any person on the Kadmos side with the reference=PIN. If a person is found, the plugin will check the Wallet Status and User Status of the person, if both statuses are active; this person will automatically be listed in the Active Member’s Tab else this person will be listed in the Waiting for eWallet Tab.

Waiting for eWallet

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:

image-20241028-111808.png

Besides, you can resend the invitation to an employee. For this, select a crew member and click the Resend Invitation button.

Wallet Status vs User Status

Some crew members have issues with the KYC although their user account is active, the wallet status is still MISSING_DATA. These persons still can’t receive any Payout as long as the Wallet is inactive.

Active Members

On activating accounts, affected crew members are moved to the Active Members tab:

kadmos_functionality_active_members.png

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.

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:

  1. Click the Add Payment button. This opens the Add New Payment dialog:

    kadmos_functionality_add_net_payment.png

  2. 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.

    kadmos_functionality_net_payment_dialog.png

    Please note that employees are filtered out based on the assigned entry code and Kadmos balance action.

  3. Select the record(s) to be transferred and click Create New Payment:

    kadmos_functionality_net_payment_create_new_payment.png

  4. 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 date for payment processing. Please note the selected payment date will be displayed after locking transactions marked as PAID

      kadmos_functionality_added_net_payment_details.png


      Once completed, click OK to proceed.

As a result, a new package appears in the Payment grid:

kadmos_functionality_payment_package_added.png

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:

  1. Click the Add Payment button. This opens the Add New Payment dialog:

    kadmos_functionality_add_net_payment.png

  2. On the dialog, select Advance Payment. This invokes the Advance Payment dialog where you can see a list of payment records ready for transfer:

    kadmos_functionality_add_advance_payment.png

    Please note that employees are filtered out based on the assigned entry code and Kadmos balance action.

  3. Select the record(s) to be transferred and click Create New Payment:

    kadmos_functionality_advance_payment_selected.png

  4. On the Payment Details dialog, fill out the payment details to be processed and click OK to proceed:

    kadmos_functionality_advance_payment_payment_details.png

As a result, a new package appears in the grid:

kadmos_functionality_added_advance_payment.png

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:

  1. Click the Add Payment button. This opens the Add New Payment dialog:

    kadmos_functionality_additional_payment.png

  2. On the dialog, select Additional Payment. This invokes the Additional Payment dialog where you can see a list of payment records ready for transfer:

    kadmos_functionality_additional_payment_dialog.png

    Please note that employees are filtered out based on the assigned entry code and Kadmos balance action.

  3. Select the record(s) to be transferred and click Create New Payment:

    kadmos_functionality_additional_payment_dialog_selected_records.png

  4. On the Payment Details dialog, fill out the payment details to be processed and click OK to proceed:

    kadmos_functionality_additional_payment_payment_details.png

As a result, a new package appears in the grid:

kadmos_functionality_added_additional_payment.png

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:

  1. On the Kadmos plugin main screen, click the Setup button. This invokes the Setup dialog.

  2. On the Setup dialog, navigate to the Authentication tab:

    kadmos_housekeeping_setup_dialog_authentication.png

  3. Fill in the fields in the Authentication tab.

Сonnection and authentication details are provided by Kadmos.

  1. 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.

General Settings

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:

kadmos_housekeeping_setup_general_tab.png

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.

 Read More

In case packages are enabled in Setup, they are available on the Payment Details dialog:

kadmos_housekeeping_setup_payment_details_packages.png

In the Payment section, define payment-related parameters:

  • Set the default payment names for each payment type (Net, Advanced, Additional). For this, simply select the Use Default Payment Name and Payment Date option and, in the table, set the values corresponding to the payment types.

 Read More

In case the default payment names are defined in Setup, they are automatically fetched to the Payment Name field:

kadmos_housekeeping_setup_payment_details_currency.png

The default payment name always consists of: DefinedName, CurrentDate, IndexNumber.

  • Specify the default currency to be used on the Payment Details dialog.

 Read More

In case the default currency is preselected in Setup, it is automatically fetched to the Payment Details dialog:

kadmos_housekeeping_setup_payment_details_currency.png

However, you can still change the currency by selecting it from the Currency drop-down list.

  • Select the Use Kadmos as Primary Payment Method checkbox to use the Kadmos balance action by default for all payouts.

 Read More

In case the Use Kadmos as Primary Payment Method checkbox is selected in Setup, the balance action of enrolled crew members changes to Kadmos:

kadmos_functionality_kadmos_balance_action.png

In case the Use Kadmos as Primary Payment Method checkbox is unchecked, the balance action during enrollment won’t be set to Kadmos other balance actions can be used.

It is also possible to use the Common Payment receiver with Kadmos balance action, it will be automatically set while adding a needed entry.

Entry Codes

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.

 Read More
  • Additional Payment stands for the amounts registered in Entry Codes with the Additional Payment option.

 Read More

Make sure to select the entry codes to be considered in each payment type: Net Payment, Advance Payment, and Additional Payment.

kadmos_housekeeping_setup_dialog_entry_codes.png

Once done, click Save to apply the changes.

Field Mapping

Kadmos Field

Adonis Mapping

Sample Value

Mandatory

Description/Comments

email

EMAIL

name@email.com

Y

 

firstName

FIRSTNAME

Mercy

Y

 

lastName

LASTNAME

Benz

Y

 

country

ADDRESS_COUNTRY

IN

Y

The residence country code in two-letter ISO 3166-1 ALPHA-2 format.

mobilePhone

MOBILE

+46 42552223

Y

 

nationality

NATIONALITY

DE

Y

The nationality of the user in two-letter ISO 3166-1 ALPHA-2 format.

contractCurrency

CURRENCYFORPAYMENT

EUR

Y

 

street

ADDRESS

Yellowrose

Y

 

houseNumber

ADDRESS1

11

 

 

postalCode

POSTCODE

1234G

 

 

city

POSTPLACE

Mumbai

Y

 

country

ADDRESS_COUNTRY

IN

Y

The country code in two-letter ISO 3166-1 ALPHA-2 format.

  • No labels