ACI Documentation

Payment Methods

Executive Summary

Payment Methods lists the payment methods that come from AlayaCare and lets administrators decide how each one is treated in this system. For each method an administrator can choose the document type it maps to and whether it is included when pre-authorized payments are imported. The list is refreshed from AlayaCare, can be filtered by name, and can be exported to Excel.

Key Features

  • Refresh the list of payment methods from AlayaCare
  • Filter the list by name
  • Map each payment method to a document type
  • Choose whether a payment method is included in the import of pre-authorized payments
  • Export the displayed payment methods to Excel

Typical Workflow

  1. Click Refresh from AlayaCare to bring in any new or renamed payment methods.
  2. Optionally type part of a name in Filter Name and click Apply Filter.
  3. Click the edit icon on a row (or right-click the row and choose Edit).
  4. Choose the Document Type and tick Include In Import Payments as needed, then click Save.
  5. Click Export to save the displayed list to Excel.

Available Permissions

The following permissions are available to be assigned to AlayaCare Roles:

AttributeWhat It Controls
ViewOpen the page

Main Grid

The grid lists the payment methods (14 rows per page).

ColumnDescription
AC IDAlayaCare identifier of the payment method.
NamePayment method name.
DescriptionPayment method description from AlayaCare.
ACI Document TypeDocument type the method is mapped to.
Description (second)Description of the mapped document type.
Include In Import?Checked when the method is included in the import of pre-authorized payments.
BranchBranch the payment method belongs to.
Manage RecordsEdit icon that opens the payment method.

Main Grid Filters

FilterPurpose
Filter NameShows only payment methods whose name contains the text entered (not case sensitive).

Click Apply Filter to refresh the list. Use Clear Filter to clear the text and show all payment methods.

Actions

ButtonDescription
Refresh from AlayaCareReads the payment methods from AlayaCare and updates the list.
ExportExports the payment methods currently displayed (after filtering) to an Excel file. Shows "Nothing to export" when the list is empty.
Apply FilterApplies the name filter.
Clear FilterClears the name filter.
Edit icon on a row / right-click a row and choose EditOpens the selected payment method for editing.

Dialog Components

Payment Method

Opens when a row is edited. Name and Description are shown for reference and cannot be changed. Save stores the changes and refreshes the grid; Cancel closes without saving.

FieldPurpose
NamePayment method name (read-only).
DescriptionPayment method description (read-only).
Include In Import PaymentsWhen checked, the method is included when pre-authorized payments are imported.
Document TypeDocument type this payment method maps to.

Dependencies

The following tables must be configured for lookups on this view to work:

TableDescription
Document TypesDocument types offered in the Document Type dropdown.

Processing Overviews

This section describes what happens after you confirm a processing action.

Refresh from AlayaCare

  1. Signs in to AlayaCare if needed. If sign-in fails, nothing is refreshed.
  2. Reads all payment methods from AlayaCare.
  3. Adds any payment method that is not yet in the list, with its name, description, type and branch.
  4. For methods already in the list, updates the Name and branch when they changed in AlayaCare. The description, document type and import setting are left as they are.
  5. Reloads the grid.

Export

  1. Stops with a warning if there is nothing in the displayed list.
  2. Builds an Excel workbook with one sheet, Payment Methods, with the columns AC Id, Name, Description, Import In Preauthorized Payments (YES or blank), Document Type, Document Type Description, Branch AC ID and Branch Description.
  3. Downloads the file as paymentmethods_ followed by the current date and time, with the extension .xlsx.