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

 

Home > Aria Crescendo Documentation > Aria Crescendo Release Notes > Release 6.49

Release 6.49

Table of contents
  1. Overview
    1. Production Release Date
    2. System Requirements
      1. Supported Browsers
      2. Java Settings
      3. Screen Resolution
    3. Application
      1. Features
      2. Fixes
    4. API
      1. Features
      2. Fixes
  2. Application Features
    1. Replacement Strings Updated to Support Credit Card Expiry Email Template (DEV-6632)
    2. Service Credit Outage Calculator Moved to Service Credit Screen (DEV-6846)
    3. Notification of Expiration Email and Display of Information Enabled for Tokenized Credit Cards (DEV-6933)
    4. Rate Schedule Enhancements (DEV-6951)
      1. Accessing this Functionality
    5. Enhancements to Direct Post (DEV-6982)
    6. Billing Date Inputs Enhanced for Master Plan Assignments (DEV-7173)
      1. Adding a new master plan to an existing account
      2. Adding a master plan during Account Creation
    7. Access to Create New Account Restricted from Level 1/View-Only CSR User (DEV-7184)
    8. Tax Request Sent to Avalara Now Includes Currency Code (DEV-7193)  
    9. Application Fixes
  3. API Features
    1. Rate Schedule Enhancements - API (DEV-6951)
    2. New Refresh_token_from_pmt_processor_m Core API (DEV-6933)
    3. Enhancements to Direct Post - API (DEV-6982)
    4. New set_usg_threshold_m API Deprecates set_monetary_usg_threshold_m (DEV-7026)
    5. Improved Performance for create_inventory_item_m and update_inventory_item_m API (DEV-7059) 
    6. Unexpected Error Returned When Attempting a Refund (DEV-7106)
    7. API Updates to Accommodate Aria for Salesforce Heap Size Limit (DEV-7149)
      1. get_catalog_hierarchy_m
      2. get_acct_plans_all_m
      3. get_acct_details_all_m
    8. client_order_id added to Generic Tax Service (DEV-7167)
    9. Billing Date Inputs Enhanced for Master Plan Assignments - API (DEV-7173)
      1. Modified Parameters
      2. New Parameters 
    10. API Fixes
  4. 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.

Production Release Date

8/24/2016

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

Replacement Strings Updated to Support Credit Card Expiry Email Template (DEV-6632)

Replacement strings, used to add account-specific data to various notifications, have been updated to support the credit card expiry email notification. Previously, the credit card expiration email notification was not displaying the card type, last 4 digits or the expiration date. 

For more information, including configuration and navigating to email templates, refer to Email Templates.


Service Credit Outage Calculator Moved to Service Credit Screen (DEV-6846)

A link to calculate the credit amount based on the outage date is now provided on the service credit screen. 

Getting Here: Search for and select an account > Payments & Credits > Service Credits > New

Service Calculator Link 6.49.png

To calculate service credit based on outage dates:

  1. Click the Service Outage Credit Calculator link. The calculator displays.

Calculator Screen 6.49.png

  1. Enter the dates for when the outage started and ended.  The outage duration is calculated based on the difference between the start date and end date. 
  2. Click Next. 
  3. Select the affected service plans from the list.  

Select Services 6.49.png

  1. Click Next
  2. The Total Outage Credit Amount is automatically calculated, and displays.  To add an additional credit, enter a percentage amount in the percentage field. 

Adjustment percent 6.49.png

  1. Click Apply. The credit amount is transferred to the Credit Amount field. 

Credit AMount 6.49.png


Notification of Expiration Email and Display of Information Enabled for Tokenized Credit Cards (DEV-6933)

For Cybersource, Litle, Pay Junction, TNSI and Braintree payment processors, the last four digits of the credit card and expiration dates (month and year) for tokenized credit cards are now displayed in the user interface. In addition, sending a credit card expiration notification email to the account holder of the tokenized credit card has been enabled. 

For more information, refer to Email Templates or Payment Processors.

Getting Here: Click Accounts > Search for and select an account > Account Overview > Payment Methods

Token ID 6.49.png

Note that you can edit the payment method by clicking the pencil icon. However, the tokenized credit card information cannot be manually updated. A Refresh Token link has been added on the edit screen which sends an API call to the payment processor that returns any updated information.  

refresh token link 6.png


Rate Schedule Enhancements (DEV-6951)

This feature improves rate schedule functionality by providing the ability to:

  • Specify an optional rate schedule start date and end date for all services on a Master plan and/or Supplemental plan. This provides control over when a rate schedule is available for assignment for both new and existing customers.

Note: If a rate schedule’s availability expires and it is already assigned on an Account’s plan, then the account continues to be charged based on the assigned rate schedule and it does not automatically roll over to a different rate schedule.

  • Specify a secondary default rate schedule for an existing default rate schedule that is scheduled to expire. If a default currency rate schedule’s availability expires and a secondary default rate schedule is not specified, then a default rate schedule is not available for assignment for that particular currency. 
  • Specify and queue future rate changes for a particular rate schedule. If the rate schedule being changed is already assigned to an account plan, then the new rate takes effect as of the Future Rate Change Start Date and any invoice that is generated after the rate change is based on the new rate for the entire billing period. 

Note: Rate schedule modifications apply for the entire billing period to any recurring services and usage services that are rated during invoicing, regardless of when the modification occurred within the billing period.

In addition, when bill lag days are considered, the current rates on the account, or from the rate schedule on the assigned plan, are used. 

Accessing this Functionality

Getting Here: Click Products > Plansselect a plan > Rates
                        -or-
                        Click 
Products > Plans > New > Rates

Rate schedules now display vertically on the screen, as opposed to the previous horizontal layout. For additional details, refer to the below images: 

Rate Settings 6.49.png

Selecting a rate schedule expands its details:


Enhancements to Direct Post (DEV-6982)

This feature adds the following enhancements to Direct Post:

  1. Flexibility to use the total of one or more master plan instances or invoices as the collection amount using the <do_one_time_collection> parameter of the set_reg_uss_config_params API and the following form input fields

  • <pending_invoice_no>: The Aria system-generated number for the pending invoice(s) on the account for which the payment method is being collected. Multiple pending invoices can be provided in this field. If multiple pending invoices are provided, there are separate collection attempts – one for each pending invoice specified.

  • <full_invoice_no>: The Aria system-generated number for the non-pending invoice(s) on the account for which the payment method is being collected. If multiple invoices are provided, only one collection attempt occurs for the combined amount due for all invoices specified.

  • <master_plan_instance_no>: The Aria system-generated number for the master plan instance(s) on the account for which the payment method is being collected. If multiple master plan instances are provided, there is only one collection attempt for the combined total or current balance due (based on the client parameter setting) for all master plan instances specified. 

  • <client_master_plan_instance_id>: The client-defined identifier for the master plan instance(s) on the account for which the payment method is being collected.

When <do_one_time_collection> is set to True (1), and a collection amount is not provided in the form, then any invoices or master plan instances provided in the above fields are used to calculate the <collection_amount>. If neither invoices or master plan instances are provided, then the account balance is collected.

When <do_one_time_collection> is False (0), then only one field is used to calculate the <collection_amount>The fields listed above are evaluated in the same order of precedence.  

  1. An optional <do_ach_collect> parameter has been added to the set_reg_uss_config_params API to determine whether to collect when ACH details are provided. Note that the <min_collect_threshold> is honored for all collection attempts, so in cases where the amount to be collected falls below the <min_collect_threshold>, no collection is performed. By default, <do_ach_collect> is set to True (1). 
  2. Whenever a credit card or ACH payment method is saved on an account in Aria (regardless of whether authorization succeeds or fails, regardless of whether collection succeeds or fails, and regardless of whether the payment method is disabled due in failure scenarios), the <payment_method_no> (the Aria-assigned unique identifier of the payment method) is now included in the Direct Post response (for both success and error conditions).

Billing Date Inputs Enhanced for Master Plan Assignments (DEV-7173)

This feature supports aligning billing dates for a new master plan with an existing master plan instance on an account.

Note: When using the following inputs, prorated invoicing is required.

Adding a new master plan to an existing account

When adding a new master plan to an account, a new field for Override Bill Through Date has been added.  This field allows you to specify an alternate bill through date (the date through which services and usage are billed) or to align the bill through date with another master plan instance assigned to the account.  

Capability to assign alternate bill start dates is also included in the user interface design.

In addition, the previous drop-down for Temporary Plan Status Until Bill Date has been integrated into the options when selecting an Override Bill Through Date

Getting Here: Click Accounts > Search for and select an account > Plans > Add New Plan

Ovverride Bill Through Date Contect 6.49.png

The Override Bill Through Date drop-down contains three options:

  1. No: This selection does not change the bill through date, and the default bill through dates for the master plan apply.

In addition, you can select an Alternate Billing Option: 

  • Alternate Billing Day: This date can be used to choose an alternate billing day than the date set to the master plan. The Temporary Plan Status Until Bill Date specifies the plan status prior to the alternate billing day. 

Alt Bill Day 6.49.png

  • Alternate Start Date: This date can be used to delay providing services to the account holder (for example: until they have been email validated), and must be within one billing interval of the plan being assigned. The Temporary Plan Status Until Bill Date specifies the plan status prior to the alternate start day. 

 alt start date 6.49.png

  1. Yes - Use Bill Through Date: The date specified in the Bill Through Date field is used as the bill through date for the new master plan being assigned to the account.

Specifiy Bill Through Date 6.49.png

  1. Yes - Sync with Master Plan Instance: This option aligns the bill through dates for the new master plan being assigned to the account with the bill through dates of an existing master plan instance. Choose the existing master plan instance from the Master Plan Instance drop-down. 

Master Plan Instance Override 6.49.png

When an Override Bill Through Date option is selected (i.e the option is not No), you can customize the Billing Start Date Options by defining an Alternate Start Date or a Retroactive Start Date for the bill start date.

Bill Start date Option 6.49.png 

Adding a master plan during Account Creation

When assigning a master plan during account creation, you can specify an override for the master plan instance’s bill through date. 

Getting Here: Click Accounts > Create New Account 

Note: In order for the Override Bill Through Date field to display, it must be enabled in the Account Creation Template

Override Bill Through (2) 6.49.png


Access to Create New Account Restricted from Level 1/View-Only CSR User (DEV-7184)

This feature restricts a user with only the View-Only CSR level from creating accounts. Refer to Create a Role for more information about permissions and roles. 


Tax Request Sent to Avalara Now Includes Currency Code (DEV-7193)  

The currency code is now included the tax request sent from Aria to Avalara. 

Example request (truncated): 

<GetTaxRequest><DocDate/><CustomerCode>123</CustomerCode><CompanyCode>12345</CompanyCode><CurrencyCode>USD</CurrencyCode><BusinessIdentificationNo/><Client>Aria Systems </Client><DocCode>1234</DocCode><Addresses><Address><AddressCode>1234</AddressCode><Line1>1 Anywhere Rd</Line1><City>Anytown</City><Region>AB</Region><PostalCode>1234</PostalCode> . . .


Application Fixes

  • An "undefined" error message was displayed when the phone number input was more than 25 characters (TICKET-12590)
  • Email address not saving in Statement Contact (TICKET-12053)

API Features

Rate Schedule Enhancements - API (DEV-6951)

When a rate schedule is created or updated, the following APIs support the capability to specify the Available From Date, Available End Date, Follow-up Default Rate Schedule, Future Rate, and Future Change Date:

  • create_new_plan_m
  • edit_plan_m

The following APIs now output additional rate schedule parameters:

  • get_rate_schedules_for_plan_m
  • get_plans_by_promo_code_all_m
  • get_ supp_plans_by_promo_code_all_m
  • get_acct_plans_m
  • get_acct_plans_all_m
  • get_avail_ plans_for_acct_all_m
  • get_avail_child_plans_for_plan_all_m
  • get_available_plans_all_m
  • get_client_plans_all_m

In addition, the following APIs now include additional logic to verify the availability of a rate schedule by checking its "Available From Date":

  • create_acct_complete_m
  • assign_acct_plan_m
  • update_acct_plan_multi_m
  • update_acct_complete_m
  • replace_ acct _plan_m

 

 Note: If a rate schedule is queued for future availability, then it becomes available on the specified date.


New Refresh_token_from_pmt_processor_m Core API (DEV-6933)

The new refresh_token_from_pmt_processor_m API sends an already-tokenized credit card saved in Aria to the payment processor to check for updated information (e.g., credit card expiration date has been updated).

If the payment processor returns a token value that is different from the token value submitted in this API, a new payment method with the updated information provided by the payment processor is created on the account.  This new payment method is also automatically linked as the primary or backup payment method to the same billing groups as the original tokenized credit card.


Enhancements to Direct Post - API (DEV-6982)

The Direct Post form has been updated to accept:

  • Multiple pending invoices
  • One or more full invoices
  • One or more master plan instances

The update_payment_method_m Core API has a new <cc_auth_amount> input parameter for authorization amount to support full authorizations.

For the collect_from_account_m Core API, the <specific_charge_transaction_id> parameter has been updated to an either/or input array adding the following options: 

  • <invoice_no>: The Aria-assigned unique identifier for invoices. If a single invoice is provided, collection is attempted for the amount due for that invoice. If multiple invoices are provided, one collection is attempted for the combined amount due for all invoices specified. Payment is automatically applied to the invoice line items for the invoices provided (first-in, first-out). Note that <invoice_no> takes precedence over <master_plan_instance_no>, which in turn takes precedence over <client_master_plan_instance_id>.
  • <master_plan_instance_no>: The Aria-assigned unique identifier for master plan instances. If a single master plan instance is provided, collection is attempted for the total or current balance due (based on the client parameter setting) of that master plan instance. If multiple master plan instances are provided, one collection is attempted for the combined total / current balance due for all master plan instances specified. Payment is automatically applied to the invoice line items for the master plan instances provided (first-in, first-out). Note that <invoice_no> takes precedence over <master_plan_instance_no>, which in turn takes precedence over <client_master_plan_instance_id>.
  • <client_master_plan_instance_id>: The client-defined unique identifier for master plan instances. If a single master plan instance is provided, collection is attempted for the total or current balance due (based on the client parameter setting) of that master plan instance. If multiple master plan instances are provided, one collection is attempted for the combined total / current balance due for all master plan instances specified. Payment is automatically applied to the invoice line items for the master plan instances provided (first-in, first-out). Note that <invoice_no> takes precedence over <master_plan_instance_no>, which in turn takes precedence over <client_master_plan_instance_id>.

New set_usg_threshold_m API Deprecates set_monetary_usg_threshold_m (DEV-7026)

The new API set_usg_threshold_m sets either a monetary (amount) or unit-based usage threshold for a defined plan instance. The set_monetary_usg_threshold_m API has been deprecated. 


Improved Performance for create_inventory_item_m and update_inventory_item_m API (DEV-7059) 

The create_inventory_item_m and the update_inventory_item_m API performance has been optimized to decrease response time. 


Unexpected Error Returned When Attempting a Refund (DEV-7106)

An unexpected error was displayed when a refund was attempted for an amount that was paid using a payment method that is in a disabled state. The functionality of the update_payment_method_m API has been modified so that a payment method is not disabled by default during a payment method update. 


API Updates to Accommodate Aria for Salesforce Heap Size Limit (DEV-7149)

Typically, the get_client_plans_all_m and get_acct_plans_all_m APIs are used to sync Aria product catalog data with Aria for Salesforce.  However, for clients with complex and large product catalogs, these APIs can return high data loads that exceed the data limit cap of Salesforce. 

The following API updates have been made to lessen the data load when retrieving product catalogs from Aria. 

get_catalog_hierarchy_m

This feature introduces the get_catalog_hierarchy_m API as an alternative which reduces the data load by returning the catalog hierarchy with minimal data. The get_catalog_hierarchy_m API retrieves the plan catalog at the client level, and provides the ability to filter the results by promo code, parent plan number, or client parent plan ID. Each filter can be used independently or in combination to provide control on reading the catalog.  

get_acct_plans_all_m

The get_acct_plans_all_m API has been modified to support the following filtration input parameters. You can restrict the number of records in the response by using these filtration parameters:

Parameter Name Description
include_service_supp_fields

Indicates whether to include the service supplemental fields array. 

If set to "true", retrieves all service supplemental fields. If left blank, defaults to "false".

Allowable values: True / False

limit

Limits the number of records returned in the all_account_plan_m array. Min of 1 and Max 999. If no value is specified, the default is 100.
offset The number of records to skip in the all_account_plans array.  Min of 0 and Max 998. If no value is specified, the default is 0.
include_product_fields

Indicates whether to include the product fields array. If set to "true", returns the product fields array. If left blank,  defaults to "false".

Allowable values: True / False
include_plan_instance_fields

Indicates whether to include the plan's instance fields array. If set to "true", returns array. If left blank, defaults to "false".

Allowable values: True / False
include_plan_services

Indicates whether to include the plan's services array. If set to "true", will return array. If left blank, will default to "false".

Allowable values: True / False
include_ surcharges

Indicates whether to include the surcharges array. If set to "true", returns the array. If left blank, defaults to "false".

Allowable values: True / False

The ability to paginate the response returned for all records has also been added.

get_acct_details_all_m

The get_acct_details_all_m API has been modified to include the following filtration input field: 

Parameter name Description
include_master_plans

Indicates whether to include the master plan info array. If set to 1/yes, it returns the full array of master plan information. If set to 0/no it does not return the array. If no value, it returns the array.

Allowable values: 1 = Yes / 0 = No

client_order_id added to Generic Tax Service (DEV-7167)

This enhancement supports an unlimited number of unique IDs by passing the <client_order_id> field to Aria's generic tax service. The <client_order_id> field is configured at the order level with each line item, and if a value is not defined, the field is passed as null. 


Billing Date Inputs Enhanced for Master Plan Assignments - API (DEV-7173)

This feature addresses limitations with aligning billing dates for a new master plan with an existing master plan instance on an account.  Input parameters have been added or modified to the plan assignment APIs to use as the bill-through date. 

When creating a new account:

  • A new input for <override_bill_thru_date> has been added to use as the bill-through date for the master plan instance.
  • The <alt_start_date> or <retroactive_date> input is honored with the <override_bill_thru_date>.

Note: Invoicing_option must be set to Perform Prorated Invoicing.

When assigning a master plan to an existing account:

  • The <override_bill_thru_date>, as described above, is available.
  • An existing master plan instance on the account can be specified for aligning bill dates.

Modified Parameters

Plan Assignment Core APIs Modified Input Parameters
  • create_acct_complete_m
  • assign_acct_plan_m 
  • update_acct_plan_multi_m

alt_start_date

Description modified: Alternative start date for the master plan instance being assigned on the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated), and must be within one billing interval of the plan being assigned.

  • status_until_alt_start 
  • status_until_alt_start_cd

Description modified

Status of the master plan instance prior to alt_start_date or alt_bill_day. If the alt_start_date or alt_bill_day field is used, this field is required and defaults to 0 (inactive) if no value is provided.

If an alternate starting date or alternate bill day is provided, the master plan instance remains in this status until its start date arrives. This only applies if a prorated invoice is not created. If a prorated invoice is created, this field is ignored.

Inputs:

  • Active
  • Pending Termination
  • Pending Cancellation
  • Trial
  • Active Non-Billable
  • Inactive
  • Suspended
  • Terminated
  • Cancelled
  • Pending Activation
  • Pending Installation

New Parameters 

To honor the alt_start_date (described above) or retroactive_start_date input with the following new input parameters, the invoicing_option must be set to Perform Prorated Invoicing.

Core API New Input Parameter
create_acct_complete_m

override_bill_thru_date

Description: 

Applicable only for master plan assignment.

When provided, this date is used as the bill through date for the master plan instance.

To honor alt_start_date or retroactive_start_date input, the invoicing_option must be set to Perform Prorated Invoicing and the date provided must be in the future, after the alt_start_date (if provided), and cannot exceed one recurring billing interval.

This parameter cannot be used with alt_bill_day or status_until_alt_start (defaults to Inactive). A prorated invoice is generated for recurring services from the effective start date of the plan instance through the override_bill_thru_date provided. If the plan being assigned has no usage services, the next_bill_date (aka anniversary date) is the override_bill_thru_date + 1 day. If the plan has usage services, then the next_bill_date is calculated based on the usage interval to be the earliest date in the future that ensures usage and recurring services are invoiced together on the override_bill_thru_date + 1 day.

  • assign_acct_plan_m
  • update_acct_plan_multi_m

override_dates_mp_instance_no

OR

override_dates_client_mp_instance_id

Description

Applicable only for master plan assignment.

When provided, the billing dates for the new master plan being assigned are aligned with the billing dates of the existing master plan instance specified (honoring the bill day of the existing master plan instance). 

These parameters take precedence over the override_bill_thru_date parameter, and cannot be used with alt_bill_day or status_until_alt_start (defaults to Inactive).

If the recurring interval of the new master plan instance is the same as or longer than the existing master plan instance, a prorated invoice for the master plan being assigned is generated for recurring services from the effective start date of the plan instance through the bill_thru_date of the existing master plan instance. If the recurring interval of the new master plan instance is shorter than the existing master plan instance, the bill_thru_date for the new master plan instance is calculated based on its recurring interval to be the earliest date in the future that ensures the recurring services for both master plan instances are invoiced together on the existing master plan instance’s bill_thru_date + 1 day.

In the above scenarios, if the new master plan instance has no usage services, the next_bill_date (aka anniversary date) is the bill_thru_date + 1 day. If the new master plan instance has usage services, then the next_bill_date is calculated based on the usage interval to be the earliest date in the future that ensures usage and recurring services are invoiced together on the bill_thru_date + 1 day.

override_bill_thru_date

Description

Applicable only for master plan assignment. When provided, this date is used as the bill through date for the master plan instance. The alt_start_date or retroactive_start_date input is honored with override_bill_thru_date, but invoicing_option must be set to Perform Prorated Invoicing.

The override_dates_mp_instance_no or override_dates_client_mp_instance_id parameters take precedence over this input parameter, and if provided together the override_bill_thru_date input is ignored.

The date provided must be:

  • in the future
  • after the alt_start_date (if provided), and
  • cannot exceed one recurring billing interval. 

This parameter cannot be used with alt_bill_day or status_until_alt_start (defaults to Inactive). A prorated invoice is generated for recurring services from the effective start date of the plan instance through the override_bill_thru_date provided. If the plan being assigned has no usage services, the next_bill_date (aka anniversary date) is the override_bill_thru_date + 1 day. If the plan has usage services, then the next_bill_date is calculated based on the usage interval to be the earliest date in the future that ensures usage and recurring services are invoiced together on the override_bill_thru_date + 1 day.


API Fixes

  • Unexpected error was displayed when using get_client_plans_m (TICKET-7376)
  • An "OK" message was displayed on invalid inputs for get_client_plans_m (TICKET-12055)
  • get_invoice_information_m and get_all_invoice_information_m applied credit and surcharge line items were not displayed when passing query_string as master_plan_instance_id (TICKET-12106)
  • update_acct_plan_multi_m was not functioning properly when "Enable_Plan_Unit_Instances" was set to False (TICKET-12409)
  • The response for get_invoice_details_m did not display correctly (TICKET-12588)

You must to post a comment.
Last modified
13:06, 1 Sep 2016

Tags

This page has no custom tags.

Classifications

This page has no classifications.