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

 

Home > Aria Crescendo Documentation > Aria Crescendo Release Notes > Release 10.0

Release 10.0

Table of contents
  1. Overview
  2. Release Date
    1. Production Release Date
  3. System Requirements
    1. Supported Browsers
    2. Java Settings
    3. Screen Resolution
  4. Application 
    1. Features
    2.  Fixes
  5. API
    1. Features
    2. Fixes
  6. Application Features
    1. GL Code Rationalization (DEV-7882)
      1. Setting a Role to Access GL Codes
    2. Legal Entities (DEV-7883)
      1. Configure Legal Entities
      2. Legal Entity Restrictions
      3. Granting Role Access to Legal Entities
      4. Create Legal Entities
      5. Assign an Account to a Legal Entity
        1. Assigning a New Account to a Legal Entity
        2. Assigning an Existing Account to a Legal Entity
    3. Future Default Rate Schedule Selections Display N/A if None Exist (DEV-7429)
    4. Product Catalog Event Notifications (DEV-7265) 
    5. XSD and DTD Files 
    6. List of Events 
    7. Ingenico Payment Gateway Support (DEV-7934)
      1. Configuration
    8. Improvement to TNS Payment Processor (DEV-8048)
    9. Updated Payment Gateway Names (DEV-6479)
    10. Add Plan Instance Identifier Columns to All Service Rates Page (DEV-7796)
    11. Additional Sorting and Filtering Capability in the Finance Section (DEV-7731)
    12. Changes to Service Credit Creation (DEV-6972)
    13. Implement Full-Formed URLs to Support Azure AD/SAML Integration (DEV-7967)
    14. Applying a Discount to an Account for Extended Durations (DEV-7912)
    15. Secondary Payment Method Type Must Match Primary Payment Method Type (DEV-4119)
      1. Accepted Combinations
    16. Enhanced Web Service API Audit Logs and Reports (DEV-7212)
      1. Web Service API Audit Logs
    17. Print Zero-Cost Invoice Line Items Parameter Now Applies to Master Plan Instance Replacement String Loops (DEV-7914)
    18. Invoicing Options for Newly Added Supplemental Plan Updated in User Interface (DEV-8026)
    19. Prorated Taxes for Service Credits Applied Based on Client Parameter (DEV-4425)
    20. Enhancement of View-Only CSR level and Page Restrictions in the Account Access Module (DEV-8019)
      1. Examples for Controlling Display of Pages and Action Links by CSR Levels
      2. Basic CSR or Higher CSR Level
      3. View-only CSR
      4. Configure Account Access
    21. Application Fixes
  7. API Features
    1. GL Code Rationalization - API (DEV-7882)
      1. set_gl_code_m
      2. remove_gl_code_m
      3. get_gl_code_info_m
    2. Legal Entities - API (DEV-7883)
      1. Prerequisites
      2. New APIs
      3. Updated APIs
    3. Bulk Collection Support (DEV-7405)
    4. Updated Returns for collect_from_account_m and manage_pending_invoice_m APIs When No Collection is Attempted (DEV-7543)
    5. Applying a Discount to an Account for Extended Durations - API (DEV-7912)
      1. Updated Field
    6. Enhancements to get_catalog_hierarchy_m API (DEV-7884)
    7. Secondary Payment Method Type Must Match Primary Payment Method Type - API (DEV-4119)
      1. Accepted Combinations
    8. Expanded Range for Adjustment Date for adjust_acct_billing_dates_m API (DEV-7146)
    9. Updated get_account_details_m to Support Search for All Contact Types (DEV-7264)
    10. Support for settle_dispute_hold_m API (DEV-7674)
    11. Updated get_acct_plan_queued_changes_m API Response to Contain Data for Anniversary Queued Plan Assignments (DEV-7666)
    12. API Fixes
  8. WSDL File Locations
    1. Object Query WSDL Files 
This article applies to:Aria Crescendo

Overview

Enhancements and fixes to Aria functionality for this release are described below.

Release Date

Production Release Date

 2/22/2017

System Requirements

Supported Browsers

  • Firefox 39
  • Chrome 44
  • Internet Explorer 9, 10, 11 

Java Settings

Java 7.0​​

Screen Resolution

1024 x 768 or higher

Application 

Features

 Fixes

API

Features

Fixes


Application Features

GL Code Rationalization (DEV-7882)

This feature allows you assign debit and credit general ledger (GL) codes to several transaction types within Aria. GL codes can then be used for downstream reporting. This enhancement lays the groundwork for expanded revenue recognition reporting which will be available in an upcoming release.

A GL code does not need to be associated with each transaction type. The maximum length for a GL code is 100 characters. Changes take effect immediately going forward, however existing transactions are not modified.

Only users who are assigned to a role with Read and Edit access to this page can view this page and make changes to it.

Note: The API portion of this change was implemented as part of GL Code Rationalization - API (DEV-7882).

Getting Here: Click Finance > GL Codes

  1. Enter a debit or credit GL code for any of the listed transactions. If a code is assigned to a transaction, you can change or remove it.

Note: You cannot assign a Credit GL code to the Write Off, Refund Related Reversal, Cash Credit, and Credit Memo Line transactions.

  1. Click Save. Your changes take effect, and the GL code changes you made are associated with the transactions you have modified. Changes do not take effect retroactively.

Setting a Role to Access GL Codes

Before accessing this feature, the role assigned to a user ID must have access to GL Codes within the Finance section of Aria.

Getting Here: Click Configuration > Security > Roles > Select a role > Scroll to the Finance section

  1. Select one of the following:
  • Read: Allow users with this role to view the GL codes.
  • Edit: Allow users with this role to view and modify the GL codes.
  1. Click Save to apply your changes to the role.

Legal Entities (DEV-7883)

This feature provides the use of legal entities as a way to organize accounts. Large enterprise clients have a need for an additional layer of organization within the Aria platform. This need stems from the existence of various business units which, due to geographic or other limitations, require the ability to report on and manage a group of customers individually. Legal entities provide this additional layer of account organization and reporting. A maximum of 99 legal entities is permitted for a client.

Note: The API portion of this change was implemented as part of Legal Entities - API (DEV-7883).  

Configure Legal Entities

Aria Customer Support must enable legal entities for a client before you can set them up. Contact Aria Customer Support for assistance with this feature.

There are two components that Aria Customer Support can enable:

  • Legal Entities Module: When this module is enabled, Legal Entities settings become visible in the Aria UI. You can create legal entities, assign permissions to user roles to create, modify and delete them, and, if a legal entity exists, you can assign user accounts to them.
  • Legal Entities Master Parameter: This parameter allows you to require that all new accounts be assigned to a legal entity, if one exists.

Legal Entity Restrictions

For individual accounts, the link to a legal entity has the following restrictions:

  • An account can only be assigned to a single legal entity. Multiple accounts must be created for customers who span multiple legal entities.
  • If the Legal Entities module is enabled for the client, the Legal Entity Master parameter is enabled, and at least one legal entity is defined, you must assign all new accounts to a legal entity. The account cannot be reassigned to another legal entity at a later date.
  • If the Legal Entities module is enabled for the client, the Legal Entity Master parameter is disabled, and at least one legal entity is defined, accounts can optionally be assigned to a single legal entity upon creation or at a later date. The account cannot be reassigned to another legal entity at a later date.
  • For clients who enable legal entities after they have existing accounts, you can use a script or the Aria user interface to assign accounts to a legal entity. Contact Aria Customer Support for assistance with setting up a script.  
  • While an account can only be assigned to a single legal entity, child accounts can be assigned to a different legal entity than the parent account or than their sibling accounts.
  • Multiple accounts, that have varying currencies, can be assigned to a single legal entity.
  • A single product catalog and marketing section exist across all legal entities within a single client. If clients require unique product catalogs for different legal entities, they must either implement multiple Aria instances or use plan groups.
  • Functional account groups and legal entities can co-exist and each does not impact the other.

Granting Role Access to Legal Entities

The Administrator role initially can see and assign the authority to read, create, edit, and delete legal entities. All other roles must be assigned this authority.

Getting Here: Click Configuration > Security > Roles > Select a role

  1. Select the Permissions tab and scroll down to Legal Entities, which is located under Client Settings.
  2. Click the checkbox for each permission you want to assign to the role.

  1. Scroll to the bottom of the page and click Save. The permissions are assigned to the role.

Create Legal Entities

To create a legal entity, use the following steps:

Getting Here: Click Configuration > Client Settings > Legal Entities

A list of legal entities displays. Note that the default sort order for this page is by Legal Entity Number in descending order.

Note: If no legal entities exist, and you have configured the Legal Entities parameter to require all new accounts be assigned to a legal entity, the parameter is not enforced.

  1. Click New. The Create New Legal Entity screen displays.
  2. Enter values in the following fields as described below.

  • Currency: Select a currency to assign to the legal entity. Currencies defined in Add A Currency are displayed here.

Note: You can only select a currency when you create a legal entity. You cannot change it at a later time.

  • Name: Enter the name of the legal entity. This value must be unique for this client.
  • Client-Defined Identifier: Identifier used for reporting purposes. You can accept the default or change it to another value. This value must be unique for this client.
  • Registration Number: Client-defined registration number for the legal entity. This value must be unique for this client.
  • VAT Registration Number: Client-defined Value Added Tax number for the legal entity. This value must be unique for this client.
  • Legal Entity Contact: Name of the person responsible for administrating the legal entity.
  • Address 1-3: Street address of the legal entity.
  • City: City of the legal entity.
  • Locality: For countries other than the U.S., Canada, and Australia, use this field to indicate the state or province of the legal entity. This field is otherwise ignored.
  • Postal Code: Additional code, such as the U.S. Zip Code, used in the legal entity's mailing address.
  • Country: Country where the legal entity is located.
  • State/Province: For the U.S., Canada, and Australia, select the state or province of the legal entity. For other countries, this field is ignored, and you can use the Locality field to enter this information.
  1. Click Save. The legal entity is saved and is displayed on the Legal Entities page. You can now assign accounts to it.

Note: Once an account is assigned to a legal entity, it cannot be reassigned. And once a legal entity has an account assigned to it, the legal entity cannot be deleted.

Assign an Account to a Legal Entity

Depending on how your Aria instance is configured, assigning an account to a legal entity can work in different ways.

  • If the Legal Entities Master parameter is set to require that all new accounts are assigned to a legal entity, the Legal Entity field is a required field when you create a new account. Note that if no legal entities have been defined, this requirement is not enforced.
  • If the Legal Entities Master parameter is set so it is optional to assign an account to a legal entity, then you can optionally select a legal entity when you create a new account.
  • An account that is not assigned to a legal entity, either because it was created before legal entities were implemented, or because it is optional for new accounts, can be assigned to a legal entity at any time from the Account Overview screen.

Once an account is assigned to a legal entity, it cannot be reassigned.

Assigning a New Account to a Legal Entity

Getting Here: Click Accounts > Create New Account

The Legal Entity drop-down menu is displayed on the Create New Account screen. Select a legal entity to assign to the account while you are creating the account, then save the account when you are done.

Note: Once you have assigned a legal entity to an account, you cannot change the assignment.

The legal entity displays on the Account Overview screen.

Assigning an Existing Account to a Legal Entity

If legal entities are optional for a client, or if they were implemented after other accounts have been created, then accounts can exist that are not assigned to a legal entity. While you cannot change which legal entity is assigned to an account, you can make the initial assignment at any time.

Getting Here: Click Accounts > Search for and select an account

Legal Entity displays as a link on the Account Overview page for accounts that have no legal entity assignment.

To assign a legal entity, click the link. A drop-down menu displays with a list of legal entities.

Note: Once you have assigned an account to a legal entity, you cannot change the assignment.

Select a legal entity and click Save. The assignment displays on the Account Overview page. The Legal Entity link is now text and cannot be selected.


Future Default Rate Schedule Selections Display N/A if None Exist (DEV-7429)

This feature enhances the Aria UI when adding a future default rate schedule. The UI now displays "N/A" if the current rate schedule has an end date and no other rate schedules are available to assign as a future default.

Getting Here: Click Products > Plans > Rates


Product Catalog Event Notifications (DEV-7265) 

Aria’s event notification system allows you to configure Aria to send an electronic message in various formats when specific events happen within the system. This enhancement allows you to configure event notifications for Product Catalog-related events.

XSD and DTD Files 

Below are the Stage Future XSD and DTD files. 

List of Events 

Below is a list of events in the product catalog class.

The table below details the new product catalog events and provides a description of the action that is triggered for each event. To enable or disable these events, navigate to Configuration > Notifications > Events > Products.

Note: These events are disabled by default. To enable an event, select the check box next to the corresponding event(s) and click Save.

Event ID Label Description
1201 Plan Created This event is triggered when a new master plan or supplemental plan is created.
1202 Plan Deleted This event is triggered when an unassigned master plan or supplemental plan is deleted.
1203 Plan Status Modified This event is triggered when the status of a master plan or a supplemental plan is changed from Active to Inactive, or vice versa.
1204 Plan Rate Schedule Added This event is triggered when a new rate schedule is added to an existing plan.
1205 Plan Rate Schedule Modified This event is triggered when a rate schedule of an existing plan is modified.
1206 Plan Service Added This event is triggered when a service is added to an existing plan or a service that was queued to be added is then added to an existing plan.
1207 Plan Service Deleted This event is triggered when a service is deleted from an existing plan or a service that was queued to be deleted is then deleted from an existing plan.
1208 Service Created This event is triggered when a new service is created.
1209 Service Modified This event is triggered when an existing service is modified.
1210 Service Deleted This event is triggered when an unassigned service is deleted.
1211 Usage Type Added This event is triggered when a new usage type is created.
1212 Usage Type Modified This event is triggered when an existing usage type is modified.
1214 Plan Details Modified This event is triggered when the Plan Name, Client Defined Identifier, or Description is modified on an existing plan.
1215 Non-Subscription Offering Created This event is triggered when a new Non-Subscription Offering is created.
1216 Non-Subscription Offering Deactivated This event is triggered when a queued Non-Subscription Offering is deactivated.
1217 Non-Subscription Offering Activated This event is triggered when a queued Non-Subscription Offering is activated.
1218 Non-Subscription Offering Details Modified This event is triggered when an existing non-subscription offering name, Client Defined Identifier, Description, SKU, Track Stock Level, Queue Activation, or Auto Create Service Credit is modified.
1219 Non-Subscription Offering Status Modified This event is triggered when a Non-Subscription Offering status is modified from Active to Inactive, or vice versa.
1222 Non-Subscription Offering Service Modified This event is triggered when a service is modified on an existing Non-Subscription Offering.
1223 Non-Subscription Offering Pricing Modified This event is triggered when pricing on an existing Non-Subscription Offering is modified. 
1224 Plan Service Queued for Removal This event is triggered when a service is queued for removal on an existing plan for new and existing subscriptions.
1225 Plan Service Queued for Addition This event is triggered when a service is queued for addition on an existing plan for new subscriptions and existing subscriptions.
1226

Plan Inventory Item Modified

This event is triggered when a plan inventory item is modified for an existing plan.
1227

Plan Future Item Purchases Modified

This event is triggered when an existing plan’s Future Item Purchases tab is modified.

1228 Translation Modified This event is triggered when a translation is modified for an existing plan including Rate Schedules, Services, Non-subscription Offering, and/or Usage Types.

Ingenico Payment Gateway Support (DEV-7934)

This feature adds Ingenico Payment Gateway support to Aria. This payment gateway replaces the GlobalCollect gateway going forward. Clients using the GlobalCollect payment gateway can continue to use it, but it can no longer be added as a payment gateway.

Supported payment methods include:

  • Credit Card, Tokenized Credit Card
  • Visa, MasterCard, American Express, Discover, JCB and Carte Bancaire
  • Alternative Payment Methods

Note: When you send a transaction to Ingenico, be sure the currency you specify matches the account's currency in Aria. The record_alternative_payment_m API uses the currency specified in the Ingenico transaction, and does not validate it against the Aria account.

  • Boleto Bancario
  • Paysafecard
  • iDEAL
  • SOFORT
  • Yandex
  • WebMoney (Due to testing limitations, this payment method can only be tested in a Production environment. Be sure to test this payment method before fully implementing it)

Configuration

Use the following steps to configure the Ingenico payment gateway.

Getting here: Click Configuration > Payments > Payment Gateways > New

You must have values for the following fields to configure this payment gateway.

  • API Key ID: Ingenico-provided identifier for the secret API key. The apiKeyId can be retrieved from the Ingenico Configuration Center and is also used to identify the correct Ingenico account.
  • Secret API Key: Ingenico-provided shared secret API Key that can be retrieved from the Ingenico Configuration Center. The apiKeyId and secretApiKey always are used together, the difference is that secretApiKey is never visible in API calls to/from Ingenico.
  • API Base URL: Ingenico-distinct Server API endpoint that points to one of the Ingenico environments (sandbox, pre-production, or production). You must include the https:// as part of the URL. For example, https://api.globalcollect.com is the Ingenico Production endpoint.
  • Merchant ID: Ingenico-provided code that identifies the client.
  • WX File SFTP Host: Ingenico-provided hostname for receiving WX Files via SFTP.
  • WX File SFTP Username: Ingenico-provided username needed to receiving WX Files via SFTP.
  • WX File SFTP Password: Ingenico-provided password for receiving WX Files via SFTP.

Click Save when you have entered values for the above fields.


Improvement to TNS Payment Processor (DEV-8048)

This enhancement makes the credit card type (Visa, MasterCard, etc.) available for display for clients using the TNS payment processor. The credit card type can now appear on the account overview page, statements and invoices, and on reports configured by Aria Customer Support.


Updated Payment Gateway Names (DEV-6479)

The names of the payment gateways have been updated to ensure names match current company standards, appropriate capitalization and to display in alphabetical order. No changes to functionality have been made. 


Add Plan Instance Identifier Columns to All Service Rates Page (DEV-7796)

This feature adds two new columns, Plan Instance Number and Plan Instance Client Defined ID, to the All Service Rates page in Aria.

Getting Here: Click Accounts > Search for and select an account > Plans > All Service Rates


Additional Sorting and Filtering Capability in the Finance Section (DEV-7731)

The Payment Terms and Reason Codes list screens now provide the ability to sort each column, filter certain columns, and to show and hide columns. For details on this feature, see Sort and Filter Columns.


Changes to Service Credit Creation (DEV-6972)

This feature changes service credit creation for prepaid order items so it occurs immediately after the account holder has made a payment. Previously, service credit creation occurred as part of the "Invoice Fully Paid" provisioning event. Because of this, when multiple provisioning events were pending, credit creation did not occur. Now, prepaid service credit creation happens regardless of what events are enabled.

Similarly, clients no longer must subscribe to the "Order Paid" event to use the "Auto Credit Service Activation" feature of Non-Subscription Offerings. The service credit is created (if applicable) immediately when the order is paid.


Implement Full-Formed URLs to Support Azure AD/SAML Integration (DEV-7967)

This feature introduces a new parameter that the client can pass to connect with the Aria UI to allow logins to occur from Azure environments. The parameter, <forceentityid>, can contain a fully-formed URL that points to the Aria UI. If this parameter is present, the Aria UI prioritizes it and allows a login to occur with this passed entity ID rather than the default.

Previously, clients using single sign on from within their UIs could only direct users to the Aria UI using entity ID values that did not use fully-formed IDs. This was not supported with Azure AD/SAML integrations.


Applying a Discount to an Account for Extended Durations (DEV-7912)

This feature changes the the maximum number of months that a discount can be applied to an account to 999. This value is available when the user selects Months from the Duration option. Allowable values are 1 to 999.

Note: The API portion of this change was implemented as part of Applying a Discount to an Account for Extended Durations - API (DEV-7912).

Getting Here: Click Marketing > Discount Rules > New


Secondary Payment Method Type Must Match Primary Payment Method Type (DEV-4119)

Note: The secondary payment method was previously labeled as the Backup Payment Method in the user interface. It is now labeled as Secondary Payment Method.  

When creating or updating a billing group, either in the user interface or with an API, the primary and secondary (backup) payment method types must match. This requirement enables clients to set functionality in Aria such as bill lag days and discounts.

Getting Here: Click Accounts > Search for and select an account > Plans > Billing Groups > New or select an existing billing group

For example, if the Primary Payment is a credit card, then the Secondary Payment Method must also be a credit card. A combination of credit card and tokenized credit card is not acceptable and an error message displays. 

For clients using net terms or external payment as a payment method, do not select a secondary method.

Accepted Combinations

Electronic Methods
Primary Payment Method Secondary Payment Method
Electronic Check (ACH) Electronic Check (ACH)
Credit Card Credit Card
Tokenized Credit Card Tokenized Credit Card
Non-electronic Methods
Primary Payment Method Secondary Payment Method
External Payment Do not select secondary payment method
Net Terms Do not select secondary payment method

Enhanced Web Service API Audit Logs and Reports (DEV-7212)

This feature enhances the functionality of the Audit Logs and reports for Web Service APIs. The search now supports:

  • Searching for a Session ID
  • Comparing the details, input, and output parameters of up to 5 APIs
  • Exporting the results of individual API details or multiple API comparisons to a downloadable CSV file
  • Displaying all filters by default, including:
    • Request Date/Time
    • API Name
    • Account Number
    • Calling IP
    • Error Code
    • Session ID

Web Service API Audit Logs

Getting Here: Click Configuration Audit Logs Web Service API

  1. Enter information for any of the fields to search by that parameter.
  • Request Date: The date on which the API call was made to Aria.
  • API Name: The name of the API call that was made to Aria.
  • Account Number: The account number of the customer whose information was updated or retrieved by the API call.
  • Calling IP: The IP address from which the API call was made.
  • Error Code: The error code returned by the API call.
  • Session ID: An Aria-assigned unique identifier for the instance of the API call.
  1. Click Search. Information about API calls display in the following columns:
  • API Name: The name of the API call that was made to Aria.
  • Request Date: The date on which the API call was made to Aria.
  • Elapsed Seconds: The number of seconds that the API call took to complete its task.
  • Account Number: The account number of the customer whose information was updated or retrieved by the API call.
  • Receipt ID: The receipt ID that was passed into the API call (if any).
  • Error Code: The error code returned by the API call.
  • Error Message: The error message returned by the API call.
  • Calling IP: The IP address from which the API call was made.
  • Caller ID: Any additional value that you chose to pass into an API call.
  • Session ID: An Aria-assigned unique identifier for the instance of the API call.

1.png The parameters you searched for display here.
2.png Click Refine Search to update the search parameters.

3.png

The Compare APIs button. To compare 2 to 5 APIs: 

  1. Check the checkbox next to each applicable API. You can check up to 5 APIs.
  2. Click the Compare APIs button. A screen displays with tabs for Details, Input Parameters and Output Parameters.

Details

Input Parameters

Output Parameters

  1. To download the comparison as a CSV file, click Export for each tab
4.png

To view the details of a single API call, click the API name. The details display, including tabs for Details, Input Parameters and Output Parameters.

To download the API call details as a CSV file, click Export for each tab.


Print Zero-Cost Invoice Line Items Parameter Now Applies to Master Plan Instance Replacement String Loops (DEV-7914)

This feature enhances certain Master Plan Instance replacement string loops to honor the client parameter "Print Zero-Cost Invoice Line Items". Previously, when the loops were included on an invoice, zero-cost items always printed on the invoice regardless of the client parameter setting. Now, zero-cost items only print if the client parameter is set to "True". The affected loops are:

  • beginLoopMPIAllChrgTxns
  • beginLoopAllMPITxnsWithCredit
  • beginLoopMPIAllTxns
  • beginLoopMPITxnsWLinkedCredits

Invoicing Options for Newly Added Supplemental Plan Updated in User Interface (DEV-8026)

This feature updates which invoicing option displays based on the Combine Invoices on One Bill client parameter when an Alternate Proration Start Date is used.  

When the Alternate Proration Start Date is the current date or a date in the future, if the Combine Invoices on One Bill parameter has been configured to not allow combined invoices (setting is False), then only Short Cycle (Multiple Invoices) displays. Short cycle invoicing creates one invoice per billing period. 

When the Alternate Proration Start Date is the current date or a date in the future, if the Combine Invoices on One Bill parameter has been configured to allow combined invoices (setting is True), then only Long Cycle (Combine Invoices) displays. Long cycle invoicing creates a combined invoice that covers multiple billing periods.

When the Alternate Proration Start Date is in the past, both invoicing options display.


Prorated Taxes for Service Credits Applied Based on Client Parameter (DEV-4425)

This feature enables the application of prorated tax service credits when the Proportional Allocation of Service Credits client parameter is enabled. Previously, the Proportional Allocation of Service Credits parameter prevented the application of tax-only service credits.

Note: Refer to Change an Invoice Setting to enable the Proportional Allocation of Service Credits parameter.

Service credits that apply to services other than tax-only services continue to apply prior to tax calculations when the Proportional Allocation of Service Credits client parameter is enabled.


Enhancement of View-Only CSR level and Page Restrictions in the Account Access Module (DEV-8019)

The available configurations for controlling access to the user interface have been expanded on the Account Access > Pages tab for each module. The Pages tab sections have been updated to include all pages and action links (for example, a link to Remove Plan) within Accounts. 

Note: Account Access assigns a CSR level to pages and links in the interface. The CSR level then needs to be assigned to a role.  Refer to Security for more information about configuring Account Access, creating and assigning roles to users.  

In addition, the View-only CSR level has been updated to remove any edit access from any section and to only allow view access for the following sections: 

  • Plans
  • Payments & Credits
  • Statements and Invoices
  • Usage

Note:  If a View-only CSR level user access is given access to an action link, the View-only CSR user is able to use the action link.  For example, if access is given to the Remove Plan link, the user is able to remove a plan from the account. 

Examples for Controlling Display of Pages and Action Links by CSR Levels

CSRs can see pages or action links assigned to their level or any CSR level below. For example, if the user is a Basic CSR and the action link has a View-only CSR level, then the link or page is visible for the Basic CSR user. However, if a link has a Basic CSR level, the link is not displayed for a View-only User.

For example, a Basic CSR is assigned access to the Remove Plan link:

A user with the View-only CSR level does not see the Remove Plan link, but a Basic User or higher level does. Note that the Replace Plan link is assigned to a View-only CSR level, and this link displays for the Basic CSR and for the View-only CSR. 

Basic CSR or Higher CSR Level

View-only CSR

Configure Account Access

Getting HereConfiguration > Security > choose a section > Pages tab

Note: In this example, the Plans section has been selected. 

  • Each page has a Minimum CSR Level drop-down to assign access. This grants access for the selected CSR level and those with higher levels of access to view the pages and/or action link.
  • The available Viewable links in this section have been expanded to include all options for each page.  

  1. Select the appropriate Minimum CSR Level access for each option. For example, if Basic CSR is chosen for the Future Plan Changes Page, any level above and including Basic CSR is also able to view the page.  
  2. Click Save. The Account Access has been updated for each option. 

Application Fixes

  • Print Invoice Button Not Displaying in Chrome (DEV-8018)
  • Master Plan Instance field was not required when adding a master plan (TICKET-12863)
  • Aggregate Usage Data was missing on Unbilled History tab (TICKET-12885)
  • Master Plan Instance substitution values were not displaying on Plan Deprovisioning Template (TICKET-12897)
  • Incorrect billing dates were set when an account was created with an alternate bill day in the UI (TICKET-12912)
  • Preview Invoice button was not working in the supplemental plan removal screen (TICKET-12915)
  • Copy Config error had Foreign Key constraint on client_locale_translation (TICKET-12984)
  • Account locale was not updated properly (TICKET-13034)
  • Creating an advance invoice created an invoice with no items or balance (TICKET-13151)
  • "Account Supplemental Service Plan Assigned" event XML was created with incorrect information (TICKET-13195)
  • Reason code was not validated properly when the Type was changed (TICKET-13202)
  • Create New Rate Card incorrectly allowed more than 10 digits to the left or right of decimal (TICKET-13293)
  • Invoice preview displayed incorrectly if account or billing name contained an ampersand (TICKET-13301)
  • An error occurred when attempting to create a new billing group (TICKET-13388)
  • Plan assignment generated an error for an existing account (TICKET-13437)
  • Large product field values and plans with fulfillment-based services sometimes caused plan assignments to fail (TICKET-13479)
  • Could not type a decimal place in price field  (TICKET-13449)
  • Alphabetical sorting was case-sensitive (TICKET-13466)
  • Excluded taxes were presented on statement using the insertInvcNetTaxOnly replacement string (TICKET-13750)
  • Future plan assignments failed to execute when virtual time was advanced (TICKET-13799)
  • The EOM_INVOICER.GEN batch log was not logging correctly (TICKET-13859)

API Features

GL Code Rationalization - API (DEV-7882)

This feature provides three new Admintool APIs to manage assigning general ledger (GL) codes to Aria transactions.

These APIs allow you assign debit and credit general ledger (GL) codes to several transaction types within Aria. GL codes can then be used for downstream reporting. This enhancement lays the groundwork for expanded revenue recognition reporting which will be available in an upcoming release.

A GL code does not need to be associated with each transaction type. The maximum length for a GL code is 100 characters. Changes take effect immediately going forward, however existing transactions are not modified.

Only users who are assigned to a role with Read and Edit access to GL Codes can use these APIs.

set_gl_code_m

This API sets or deletes one or more GL codes. If only a credit or debit value is provided, the alternate value is overwritten with a null value, which removes any previously-assigned value. If neither are provided, both are overwritten with null values. Changes take effect immediately going forward, however existing transactions are not updated.

Input values for this API are as follows:

Field Name Required Field Type Length Description
client_no Y Long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key Y String 32

Aria-assigned unique key passed with each method call for authenticating the validity of the requestor.

gl_code   Array  

This array permits you to input one or more values for various financial transaction types.

 

financial_transaction_
type

Y String 2

Aria-assigned transaction type number. Allowable values and their description are as follows:

  • 2 - Check
  • 3 - Electronic Payment
  • 4 - Balance Transfer to Account
  • 5 - Balance Transfer from Account
  • 6 - Write-Off
  • 8 - Refund-Related Reversal
  • 9 - Balance Forward
  • 10 - Cash Credit
  • 12 - Refund of Electronic Payment
  • 13 - Refund of External Payment
  • 14 - External Charge
  • 15 - Dunning Charge
  • 22 - Credit Line
  • 24 - Credit Memo Line
debit_value N String 100 The debit specific GL Code value that is appended to each transaction of the specified type.
credit_value N String 100

The credit specific GL Code value that is appended to each transaction of the specified type.

Note: You cannot assign a Credit GL code to the Write Off, Refund Related Reversal, Cash Credit, and Credit Memo Line transactions.

Outputs for this API are as follows:

Field Name Field Type Description

<error_code>

Long

Aria-assigned error identifier. "0" indicates no error has occurred.

<error_msg>

String

Description of any error that occurred. If no error occurred, the returned message is "OK".

remove_gl_code_m

This API allows you to delete one or more GL codes from a specified transaction type. Changes take effect immediately going forward, however existing transactions are not updated.

Inputs for this API are as follows:

Field Name Required Field Type Length Description
client_no Y Long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key Y String 32

Aria-assigned unique key passed with each method call for authenticating the validity of the requestor.

gl_code   Array  

This array permits you to input one or more values for various financial transaction types.

  financial_transaction_
type
Y String 2

Aria-assigned transaction type number. Allowable values and their description, are as follows:

  • 2 - Check
  • 3 - Electronic Payment
  • 4 - Balance Transfer to Account
  • 5 - Balance Transfer from Account
  • 6 - Write-Off
  • 8 - Refund-Related Reversal
  • 9 - Balance Forward
  • 10 - Cash Credit
  • 12 - Refund of Electronic Payment
  • 13 - Refund of External Payment
  • 14 - External Charge
  • 15 - Dunning Charge
  • 22 - Credit Line
  • 24 - Credit Memo Line
gl_code_type Y String 1

Defines which values to erase. Allowable values are as follows:

  • 0 - Debit Only
  • 1 - Credit Only
  • 2 - Both

 Outputs for this API are as follows:

Field Name Field Type Description
<error_code> Long Aria-assigned error identifier. "0" indicates no error has occurred.
<error_msg> String Description of any error that occurred. If no error occurred, the returned message is "OK".

get_gl_code_info_m

This API retrieves information for the specified financial_transaction_type.

Inputs for this API are as follows:

Field Name Required Field Type Length Description
client_no Y Long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key Y String 32

Aria-assigned unique key passed with each method call for authenticating the validity of the requestor.

financial_transaction_type_array   Array  

This array specifies which financial transaction type GL Code values are displayed. If this is  blank, all financial transaction types are displayed.

  financial_transaction_
type
Y String 2

Aria-assigned transaction type number. Allowable values and their description, are as follows:

  • 2 - Check
  • 3 - Electronic Payment
  • 4 - Balance Transfer to Account
  • 5 - Balance Transfer from Account
  • 6 - Write-Off
  • 8 - Refund-Related Reversal
  • 9 - Balance Forward
  • 10 - Cash Credit
  • 12 - Refund of Electronic Payment
  • 13 - Refund of External Payment
  • 14 - External Charge
  • 15 - Dunning Charge
  • 22 - Credit Line
  • 24 - Credit Memo Line

 Outputs for this API are as follows:

Field Name Field Type Description
<error_code> Long Aria-assigned error identifier. "0" indicates no error has occurred.
<error_msg> String Description of any error that occurred. If no error occurred, the returned message is "OK".
gl_code Array This array displays all currently configured GL codes within the system.
  financial_transaction_
type
Long Aria-assigned financial transaction type number.
financial_transaction_
type_description
String Aria-assigned financial transaction type description.
debit_value String The debit-specific GL code value that is appended to each transaction for the specified type.
credit_value String The credit-specific GL code value that is appended to each transaction for the specified type.

Legal Entities - API (DEV-7883)

This feature adds API support for legal entities. Legal entities provide an additional layer of account organization and reporting.

Prerequisites

Before using legal entities, they must be configured for your site. See Configure Legal Entities for additional information.

New APIs

To support the use of legal entities, the following APIs have been created:

  • create_legal_entity_m: Creates a new legal entity within an Aria client. This API works only if the Legal Entity module is enabled.
  • update_legal_entity_m: Updates an existing legal entity within an Aria client that has the Legal Entity module enabled.
  • delete_legal_entity_m: Deletes an existing legal entity that has not been assigned to an account.
  • get_legal_entity_m: Retrieves a list of legal entities for the specified client.

Updated APIs

The following APIs have been updated to support legal entities.

create_acct_complete_m and update_acct_complete_m: The following fields have been added as an input:

Required Field Name Description
One of these fields is required if the Legal Entity Master Parameter is set to require all new accounts to be assigned to a legal entity.

legal_entity_no
 

or

client_legal_entity_id

Aria-assigned legal entity identification number

 

Client-assigned unique identifier for the legal entity

get_account_details_all_m: The following fields have been added as outputs:

Output Field Description
legal_entity_no Aria-assigned legal entity identification number
legal_entity_name Client-assigned name of the legal entity
client_legal_entity_id Client-assigned unique identifier for the legal entity

Bulk Collection Support (DEV-7405)

A new API, settle_account_balance_bulk_m, allows you to collect from multiple accounts using one API call. You can filter your collection based on payment method or master plan instance. This API allows for the batch submission of up to 5,000 accounts to a payment processor for collection attempts on each account. The maximum number of records permitted in this API call is determined by the client parameter MAXIMUM_RECORDS_ALLOWED_IN_A_BULK_SETTLE_API_CALL and is set by Aria Customer Support.

This API is being implemented for clients who want to submit multiple collection attempts each day in one call. It differs from  settle_account_balance_m, which submits just one collection attempt per account in real time. This new API does not submit a collection attempt in real time. Instead, a batch process runs every 30 minutes and submits all collection attempts to the payment processor that were sent to Aria at one time. Once these collection attempts are made, a batch file is sent back to Aria and the associated accounts are updated with the collection attempt outcome information.

This API is currently only supported by Vantiv. It does not function with other payment processors.

Inputs for this API are as follows:

Field Name Required Field Type Length Description
<client_no> Y long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
<auth_key> Y string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
<account_info> N array   Array that allows for multiple account submissions for account balance settlement.
<acct_no>
or
<client_acct_id>
N long
or
string
22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
Client-assigned identifier for the account.
<payment_method_no>


or


<client_payment_method_no>


or


<master_plan_instance_no>


or


<client_master_plan_instance_id>
Y long
 




string





long
 




string
22
 




32





22





100
Aria-assigned sequence number for this payment method. Either payment method or master plan instance information must be provided. If both are provided, the payment method is used to collect the amount due for the plan instance specified.

Client-defined identifier for this payment method. Either payment method or master plan instance information must be provided. If both are provided, the payment method is used to collect the amount due for the plan instance specified.

Aria-generated unique identifier for the master plan instance. Either payment method or master plan instance information must be provided. If both are provided, the payment method is used to collect the amount due for the plan instance specified.

Client-defined unique identifier for the master plan instance. Either payment method or master plan instance information must be provided. If both are provided, the payment method is used to collect the amount due for the plan instance specified.

Outputs for this API are as follows:

Field Name Field Type Description
<error_code> long Aria-assigned error identifier. "0" indicates no error has occurred.
<error_msg> string Description of any error that occurred. If no error occurred, the returned message is "OK".

Updated Returns for collect_from_account_m and manage_pending_invoice_m APIs When No Collection is Attempted (DEV-7543)

Two APIs have been updated to improve support for accounts where no collections are attempted when the API runs. The new <collection_errors> hash allows for backward compatibility with existing <error_code> and <error_msg> outputs for these APIs, which are unchanged.

The affected APIs are:

The new <collection_errors> hash is populated when the API successfully runs, returning an error_code of 0, but no collection occurs. The values in the hash are as follows:

<collection_error_code> <collection_error_msg>
4033 Current form of payment is non-electronic. No collections were attempted.
4034 Collection Amount less than Currency Threshold. No collections were attempted.
4035 Collection Amount is zero. No collections were attempted.
8010 Collection attempted, email address not valid or missing.

Applying a Discount to an Account for Extended Durations - API (DEV-7912)

This feature enhances the create_discount_rule API by changing the the maximum number of months that a discount can be applied to an account to 999, and by changing the maximum length of the field to 3 characters.

Updated Field

Req Field Name Field Type Max Length Description
No max_applicable_months int 3 Specifies the duration of the discount in months. Allowable values are from 1 to 999.

Enhancements to get_catalog_hierarchy_m API (DEV-7884)

This feature adds several input and output parameters to the get_catalog_hierarchy_m API. These inputs and outputs provide additional filtering of catalog hierarchy results.

New input fields are as follows:

Field Name Required Description
<include_parent_plan_list> N

Controls whether to include the <parent_plan_list> array in the response. Allowable values are as follows:

  • True: (Default) Include the <parent_plan_list array> in the response.
  • False: Do not include the <parent_plan_list array> in the response.
<include_child_plans_list> N

Controls whether to include the <child_plan_list array> in the response. Allowable values are as follows:

  • True: (Default) Include the <child_plan_list array> in the response.
  • False: Do not include the <child_plan_list array> in the response.
<Include_total_count> N

Controls whether to include the <plans_count> in the response. Allowable values are as follows:

  • True: Include the <plans_count> in the response.
  • False: (Default) Do not include the <plans_count> in the response.
<limit> N Controls the number of records to be returned in the <all_plans_basic_details> array. Allowable values are a minimum of 1 and a maximum of 999. The default value is 100.
<offset> N Controls the number of records to be skipped in the <all_plans_basic_details> array. Allowable values are a minimum of 0 (default) and a maximum of 998.

The new output field is as follows:

Parameter Type Description
<plans_count> long

Returns the total number of plans for the given <client>, <promo_code>, or <parent_plan_no>. This field is displayed only when the <include_total_count> input parameter is set to "True".

Note: Since this count is either at the <client>, <promo_code>, or <parent_plan_no> level, it is unaffected by the <offset> and <limit> input parameters.


Secondary Payment Method Type Must Match Primary Payment Method Type - API (DEV-4119)

When creating or updating a billing group in the user interface or with an API, the primary and secondary (backup) payment method types must match. 

For example, if the Primary Payment is a credit card, then the Secondary Payment Method must also be a credit card. A combination of credit card and tokenized credit card is not acceptable and an error message displays. 

For clients using net terms or external payment as a payment method, do not select a secondary method.

Validation has been implemented in the following APIs to return an error message if the primary and secondary payment method types do not match:  

  • create_acct_complete_m
  • create_acct_billing_group_m
  • update_acct_complete_m
  • update_payment_method_m
  • update_acct_billing_group_m
  • update_acct_plan_multi_m

No input or output field changes have been made. 

Accepted Combinations

Electronic Methods
Primary Payment Method Secondary Payment Method
Electronic Check (ACH) Electronic Check (ACH)
Credit Card Credit Card
Tokenized Credit Card Tokenized Credit Card
Non-electronic Methods
Primary Payment Method Secondary Payment Method
External Payment Do not select secondary payment method
Net Terms Do not select secondary payment method

 


Expanded Range for Adjustment Date for adjust_acct_billing_dates_m API (DEV-7146)

This feature expands the range of permissible values for the adjustment_days and the adjustment_date input of the adjust_acct_plan_billing_dates_m API. Permissible values are as follows:

Billing Status of Plan Permissible Values for adjustment_days or adjustment_date
Plan previously billed Up to 27 days before or after the current billing date
Plan not previously billed Up to 99 days prior to the current billing date or up to 27 days after the current bill date (-99 days to +27 days)

Note: The input of adjustment_date or adjustment_days is set by the action_directive input of the API.

If the date or number of days specified in the adjustment_days or adjustment_date input is outside of the permissible range, an error message displays.


Updated get_account_details_m to Support Search for All Contact Types (DEV-7264)

This feature updates the get_account_details_m API to support searching for all contact types (Billing, Statement, Destination and Account contacts).

You can now search for an account with any of the following input parameters: 

  • First_name
  • Last_name
  • Company_name
  • City
  • Country_cd
  • Postal_cd

Note: When searching by the above parameters, the search values are not case-sensitive.

A search by any contact detail returns the matching contact IDs. If there is no match or if no contact details were included in the API call, all of the account contact IDs are returned.

The following new output arrays return which contacts matched the provided search criteria. 

Output Description
matching_account_contact_id_number This output displays all Aria-assigned unique identifiers for all account contacts that match the contact search criteria entered. The get_acct_contacts_m API can be used to review details for each matching contact. If no contact-specific search criteria was input, then all account contact ID numbers for the account are displayed.
matching_statement_contact_id_number

This output displays all Aria-assigned unique identifiers for all statement contacts that match the contact search criteria entered. The get_acct_contacts_m API can be used to reference contact information for each matching contact. If no contact-specific search criteria was input, then all statement contact ID numbers for the account are displayed.

matching_billing_contact_id_number This output displays all Aria-assigned unique identifiers for all billing contacts that match the contact search criteria entered. The get_acct_contacts_m API can be used to reference contact information for each matching contact. If no contact-specific search criteria was input, then all billing contact ID numbers for the account are displayed.
matching_destination_contact_order_id_number This output displays all Aria-assigned unique identifiers for all destination contacts, related to orders, which match the contact search criteria entered. The get_acct_contacts_m API can be used to reference contact information for each matching contact. If no contact-specific search criteria was input, then all destination contact order ID numbers for the account are displayed.
matching_destination_contact_service_id_number This output displays all Aria assigned unique identifiers for all destination contacts, related to services, which match the contact search criteria entered. If no contact-specific search criteria was input, then all destination contact service ID numbers for the account are displayed.
matching_inactive_contact_id_number This output displays all Aria-assigned unique identifiers for all inactive contacts that matched the contact search criteria entered.

Support for settle_dispute_hold_m API (DEV-7674)

The settle_dispute_hold_m API is now supported for Aria Crescendo. This API allows you to settle a dispute hold by converting it to a permanent write-off, removing and re-aging the disputed charge, or permanently removing the disputed charge.


Updated get_acct_plan_queued_changes_m API Response to Contain Data for Anniversary Queued Plan Assignments (DEV-7666)

This feature updates the get_acct_plan_queued_changes_m API to include data for anniversary-queued changes for master plans and supplemental plans. Previously, only non-anniversary queued changes were returned in the API.

The following outputs:

  • target_plan_no
  • target_client_plan_id
  • target_plan_units
  • target_rate_schedule_no
  • target_plan_inst_status
  • target_rate_schedule_no
  • target_client rate_schedule_id

are now populated in the get_acct_plan_queued_changes_m API when a plan assignment is made for a future anniversary date using any of the following APIs: 


API Fixes

  • Update_acct_plan_multi_m error_code response was a string instead of an integer (TICKET-12865)
  • Get_acct_plans_all_m response was not fully displayed in log files (TICKET-12991)
  • Set_acct_tax_exempt_status_m generated misspelled account comment (TICKET-12996)
  • Update_usage_type_m returned the Exception Class object with the response (TICKET-13032)
  • <Alt_caller_id> length is now 30 characters instead of 100 (TICKET-13098)
  • Incorrect error code returned from create_order_m when the master plan instance was suspended (TICKET-12894)
  • Update_acct_complete_m returned an error when using <client_acct_id> (TICKET-13003)
  • Prorated invoice was not created when creating an account with create_acct_complete_m (TICKET-13583)
  • Unexpected error while setting "auto_offset_months_option" to value 1 in update_acct_plan_multi_m (TICKET-13431)
  • Record_usage_m not honoring the client paramater "Reject usage type if not on plan" (TICKET-13010)
  • Create_service_location_m generated an Oracle error (TICKET-13683)
  • Unexpected error in get_acct_plans_all_m when the offset value was equal or greater than the master plan instance’s value on the account (TICKET-13801)

You must to post a comment.
Last modified
15:07, 22 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.