Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > User Documentation > Processing Payments > Surcharges > Create New Surcharge Screen

Create New Surcharge Screen

Overview

The Create New Surcharge screen allows you to create and define a new surcharge. The screen consists of three tabs:

  • General Information
    From this tab you can define basic information for the surcharge, including its name, a description of the surcharge, etc.
  • Application
    From this tab you can select the charges and/or plans to which the surcharge applies.
  • Rates
    From this tab you can enter rate tier(s) to define surcharge pricing.

General Information Tab

The images below highlight important elements of the General Information tab on the Create New Surcharge screen, followed by a description of each.

Surcharge Name Indicates the name of the surcharge.
Client Defined Identifier A unique ID for the surcharge that you can define for future reference. If you
do not enter an ID in this field, the application defaults this value as the surcharge
name with underscores.
Description Provides a description of the surcharge. This is for internal purposes and is not visible
to your customers.
External Description The description of the surcharges that your customers see on their statements.

 

Currency Provides the currency type for the surcharge.
Surcharge Type Indicates whether the surcharge fee is a fixed amount or a percentage of the invoice charges. The fee is calculated as the net line item total for the selected services.
Invoice Application Method Indicates how the surcharge is displayed on the invoice. A surcharge can be included with the original line item, or it can be added to the invoice as a separate surcharge line item.
Tax Group Defines the tax group that will be used for calculating taxes against the surcharge.
Revenue Account GL Code Indicates the revenue account general ledger code for the surcharge.
Account Receivable GL Code Indicates the account receivable general ledger code for the surcharge.
Surcharge Application or Invoice Specifies whether the surcharge should consider the invoice’s item totals before or after discounts are applied.

Application Tab

The image below highlights important elements of the Application tab on the Create New Surcharge screen, followed by a description of each:

ApplicationTab1.png

Scope

Defines the plans and charges to which the surcharge applies. By default, if a plan is not selected, the surcharge is applied to all plans and services.
Available options include:

  • All Charges
    ​Surcharge is calculated for all charges on the invoice, including all services, charges, and inventory items.

  • All Plan Charges, All Plans
    Surcharge is calculated for all plan charges on the invoice.

  • All Plan Charges, Specified Plans
    Surcharge is calculated for all charges that belong to specific plans as chosen in the surcharge definition.

  • All Plans, Specified Service Charges
    Surcharge is calculated for the services that are specified in the surcharge definition.

  • Specified Plan/Service Charges
    Surcharge is calculated for the combination of services and plans that are specified in the surcharge definition.

  • All Recurring Service Charges
    Surcharge is calculated for all the recurring services on the invoice.

  • All Usage Service Charges
    Surcharge is calculated for all usage services on the invoice.

  • All Activation Service Charges
    Surcharge is calculated for all activation services on the invoice.

  • All Item Charges
    Surcharge is calculated for all one-time item services on the invoice.

  • Specified Item Charges
    Surcharge is calculated only for the items that are specified in the surcharge configuration.

  • Payment Method
    Surcharge is available to be applied to a payment method.

Rates Tab

The image below highlights important elements of the Rates tab on the Create New Surcharge screen, followed by a description of each:

surcharge ratev3.png

Rate Schedule Name

Enter a name for the rate schedule.

Currency Enter the currency type (e.g. USD, CAD...etc.)
Minimum Surcharge to Apply Specify the minimum surcharge to apply. This amount will be charged if the rate tier calculation is lower than this amount.
Rate Tiers

Provide the information for the rate tier. If the Description field does not display, set the Use Rate Tier Descriptions parameter to True (Configuration > Client Settings > Miscellaneous Settings).

Click the Add Rate Schedule button to have multiple rate schedules.

Include zero in rate tier If Yes is selected, zero value is considered in the rate tier. If No is selected, zero value is excluded from the rate tier.
You must to post a comment.
Last modified
12:24, 23 Sep 2015

Tags

This page has no custom tags.

Classifications

This page has no classifications.