Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties

Description

Processing transactions from Adonis Personnel Manager to ShipMoney

Latest Version

2021.4.2.7

Release Date

Download Path

Download

Type

APM Plugin

Introduction

The ShipMoney plug-in is specifically designed for processing

transactions from Adonis Personnel Manager to ShipMoney

transactions from Adonis Personnel Manager to ShipMoney.

The ShipMoney plug-in collects all the unpaid transactions and

transfer

transfers them to the ShipMoney interface. Based on the collected transactions, ShipMoney compensates the amounts to debit/credit cards.

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

transfer

transferring the transactions to the ShipMoney interface. 

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/ShipMoney/

Connection Setup

For data transfer, you need to configure the ShipMoney connection settings. To do this, follow the steps below:

On the plug-in start screen, click the Configuration button. This invokes the Configuration dialog: 
Image Removed

Fill in the fields in the Configuration dialog.

Info

All the connection data is provided by ShipMoney.

  • Check whether the connection is successfully established by clicking the Test Connection Image Removed button

    Image Removed

  • On establishing the connection, click Apply to save the connection details.
  • Balance Action Setup

    To pay out the collected transactions, you need to define Credit/Debit Card as a preferable payment method for all the Employees.
    To do this, follow the steps below:

    Open the Payroll module and navigate through the tabs: Payment > New Balance:
    Image Removed
  • In the Action drop-down list, select the Credit/Debit Card option.

  • Click Save on the toolbar to confirm the changes.
  • You can as well use Common Entry to define the balance action for a batch of the tagged crew.
    Image Removed
    Table of Contents
    minLevel1
    maxLevel7
    excludeContents

    Functionality

    The section will teach you how to operate the plug-in.

    To get started, first, access the plug-in. For this, navigate to the Tools > Export and select ShipMoney from the drop-down list.

    Image Removed
    Image Added

    This invokes the ShipMoney start page:

    Image Modified

    There are three payment types that may be processed:

    • Net Payment

    stand
    • stands for the amounts registered as Entry Code 994 Net wages (default value).

    • Advance Payment is meant for

    the amounts
    • the amounts registered in Entry Codes with the Advance Entry Code option:

    Image Removed
    • Image Added

    • Additional Payment stands for

    the amounts
    • the amounts registered in Entry Codes with the Additional Payment option:

    Image Removed
    • Image Added

    The section will walk you through the detailed instructions on how to process each type of payment.

    Net Payment

    On accessing the plug-in start screen, select Net Payment as the payment type you want to process:

    Image Modified

    This invokes the Net Payment dialog where you can see a list of payment records ready for transfer:

    Image Removed


    Image Added

    In the dialog, proceed with the following steps:

    1. Select the record(s) to be transferred:

    Image Removed

    1. Image Added

    Info

    1. Note: Click Tag All to select all the records in the grid.

    2. Click the Transfer Payment button to initiate data transfer.
      When the records are successfully transferred, the message appears:

    Image Removed
    1. Image Added

    2. As a result, 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 the Payscale rate, the Activity dates, etc are changed. The entry code will be marked as PAID proceeding with the date when the transaction was processed:

      Note:


    Image Removed
    1. The transactions can be unlocked if necessary (Payroll > Set > Unlock Payroll Transactions) provided that a user has corresponding access.


      Image Added

      In case any of the transactions fails to be transferred, you are then prompted to check log for details:

      Image Modified

      Click Check Log to find out the details.

    Advance Payment

    On accessing the plug-in start screen, select Advance Payment as the payment type you want to process:

    Image Modified

    This invokes the Advance Payment dialog where you can see the list of advance entry codes:

    Image Removed
    Image Added

    In 


    the

    In the dialog, proceed with the following steps:

    1. Select the entry code(s) you want to process:

    Image Removed

    1. Image Added

    2. Click Fetch at the bottom of the dialog. This will bring you

    to 
    1. to Transfer Payments

     tab
    1.  tab listing all the Advance transactions ready for transfer:

    Image Removed

    1. Image Added

    2. Select the payments you want to transfer and click Transfer Payment.

      When the records are successfully transferred, the message appears:

    Image Removed
    1. Image Added



      In case any of the transactions fails to be transferred, you are then prompted to check log for details:

      Image Modified


      Click Check Log to find out the details.

    Additional Payment

    On accessing the plug-in start screen, select Additional Payment as the payment type you want to process:

    Image Modified

    This invokes the Additional Payment dialog where you can see the list of additional payment entry codes:

    Image Removed
    Image Added

    In the

    In the dialog, proceed with the following steps:

    1. Select the entry code(s) you want to process:

    Image Removed

    1. Image Added

    2. Click Fetch at the bottom of the dialog. This will bring you

    to 
    1. to Transfer Payments

     tab
    1.  tab listing all the additional payments transactions ready for transfer:

    Image Removed

    1. Image Added

    2. Select the payment(s) you want to transfer and click Transfer Payment.
      When the records are successfully transferred, the message appears:

      Image Modified


      In case any of the transactions fails to be transferred, you are then prompted to check log for details:

      Image Modified


      Click Check Log to find out the details

    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/ShipMoney/


    Security

    GTP Web Service API's are protected to ensure that only authorized clients/partners use them.

    There are four levels of security:

    1. Security Token ID
    • GTP will assign a security token to the registered client/partner.
    • The security token must be sent by consuming applications in the SOAP message header.

    2. Virtual Private Network (VPN)
    • Registered clients/partners must establish a VPN with GTP. Consumption of GTP web services shall occur over the VPN.
    • GTP implements IP Address restrictions to prevent access to the API's by any application that is not connecting over the VPN.

    3. API Restrictions
    • GTP and client/partner will determine which of the API’s client / partner can access. GTP will restrict usage of unauthorized API’s by client/partner.

    4. Secure Sockets Layer (SSL) data transport.
    • All GTP Web Service API’s must be consumed over HTTPS.

    Connection Setup

    For data transfer, you need to configure the ShipMoney connection settings. To do this, follow the steps below:

    1. On the plug-in start screen, click the Configuration button. This invokes the Configuration dialogue: 

      Image Added

    2. Fill in the fields in the Configuration dialog.

      Note: Сonnection data is provided by ShipMoney. ShipMoney generates the security token. Before sending it, ShipMoney checks whether the client's IP address is valid.

    3. Check whether the connection is successfully established by clicking the Test Connection Image Added button

      Image Added

    4. On establishing the connection, click Apply to save the connection details.

    Balance Action Setup

    To pay out the collected transactions, you need to define Credit/Debit Card as a preferable payment method for all the Employees.
    To do this, follow the steps below:

    1. Open the Payroll module and navigate through the tabs: Payment > New Balance:

      Image Added

    2. In the Action drop-down list, select the Credit/Debit Card option.

    3. Click Save on the toolbar to confirm the changes.

    Otherwise, you can navigate to the Tools ribbon tab > Common Entry > Balance Action to define the balance action for a batch of the selected crew.

    Image Added

    Common errors

    • There is a limit that can be set for a Shipmoney card. If the limit is exceeded, the message below appears when a user is trying to export funds to Shipmoney. The amount is not transferred:

    image-20240904-135534.pngImage Added