Home > Aria Crescendo Documentation > Aria Release Notes > Release 20

Release 20

Application Features
API Features
WSDL File Locations
1. Object Query WSDL Files

Overview

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

Release Date

Stage Future Release Date

21-February-2019

Production Release Date

14-March-2019

System Requirements

Supported Browsers

Chrome 63
Firefox 52
IE11
Safari 11 on MacOS

Screen Resolution

1024 x 768 or higher

Release 20 Contents

Application Features
API Features
WSDL File Locations
1. Object Query WSDL Files

Application Features

Tax Integrations (DEV-8260)

A number of changes have been made to tax integrations within the Aria UI via the > Configuration > Integrations > Taxation Configuration tabs.

The following third party tax integration services are no longer in use/supported and have been removed from the tax service "Method" dropdown:

Intuit Tax
Dex-One Sabrix Tax
OLD DEV Avalara
test tax
Vertex Comm Tax Q
Taxware Enterprise

The following third party tax integration services have been renamed in the tax service "Method" dropdown:

Sabrix MTS to OneSource
Billsoft EZTax Web Service to Avalara Communications Tax

4 New Payment/Credit Totals Available For Customer Statements (DEV-8981)

Four (4) new statement replacement strings are now available for display on customers' statements:

insertCurrStmtMappedPmtTotal displays the total of all external and electronic payments received for the current statement.
insertPrevStmtMappedPmtTotal displays the total of all external and electronic payments received for the previous statement.
insertStmtNewNonInvLineCrdPmts displays the total of external, electronic, and cash credits, *excluding* service credits and discounts, applied on the invoice.
insertTotalInvoiceLineCredits displays the total of all service and discount credits applied on the invoice.

Aria's Customer Support team develops Statement Templates. To learn more about how to update your current customer statements, or how to implement a newly designed customer statement, see Introduction to Statement Templates on the Aria Academy learning portal (login required).

Plan Name Displayed for Prorated Credits on Anniversary Invoices Too (DEV-8990)

The applicable plan name is now displayed next to any prorated credit transactions on anniversary invoices that reflect any credits generated by proration actions taken in a prior billing period (actions completed using APIs or the Aria application). Example: prorated credits generated by using the update_acct_plan_multi_m API to change the number of plan units assigned to a customer. Aria will also identify each prorated credit as tax or non-tax with these updated descriptions:

For tax credit line items: "Prorated tax credit for adjusted prior period for units already on the plan".
For non-tax credit line items: "Prorated credit for adjusted prior period for units already on the plan".

This will allow you to provide your customers with statements that clearly identify the plans from which prorated credits were generated. Previously, the information described above was displayed only on prorated invoices.

Force Currency Change - UI Updates (DEV-9023)

This enhancement further supports the "force currency change" functionality delivered in DEV-8995. This feature introduces UI updates in the replace and edit rates UI screens to allow for the selection of rate schedules having a different currency while also providing a custom rate template in the Assign/Replace Master or Supplemental Plan UI screens to allow for the selection of a different template for providing custom rates.

Force Currency Change on Existing Plan(s) Via Plan > Plan Instance(s) Screen

Getting Here: Accounts > Search > Account Overview > Plans

Click on the Plan Instance ID.

Click on the Edit Rates button.

Note: The "Do you wish to change currency" check box will not be displayed for an account that has already been charged for services in a previous currency.

To change the account's currency, click on the "Do you wish to change currency?" check box.

Select (click) on any of the pre-configured rate schedule(s) radio button for the plan to force a currency change for this account.
Select (click) on Custom Rates radio button to open a template for creating custom rates for the displayed currencies.

Click on the Plan Scope drop-down arrow to select a plan for the custom rate(s).
Click on the Rate Schedule Template drop-down to select a pre-configured rate schedule to customize for a custom rate for the plan.
Click on the Add Rate Tier button to add additional unit/rate tiers to the custom rate.

Click on the Application Scope check box to save this custom rate as a re-usable rate for this plan for other account/plan assignment.
Type in a Rate Schedule Name for this custom rate schedule.
Click on the Save button to save the new custom rate schedule.

Force Currency Change on Existing Plan(s) Via Plan > Plan Instance(s) > All Service Rates

Getting Here: Accounts > Search > Account Overview > Plans

Click on the All Service Rates menu tab.

Click on the existing Rate Schedule Name for the plan.

Repeat steps #3 through #11 to force a currency change on the account / plan(s) by selecting an alternate rate schedule in a different currency or by creating a custom rate in a new currency.

Note: A currency change to one Master / Supplemental Plan Instance will effect a currency change to all other Master/Supplemental Instances on the account.

An error will be thrown if any Master / Supplemental Plan instances on the account does not have a corresponding Rate Schedule in the selected currency.

For Parent / Child accounts, where Payment Responsibility = 2 (Parent Pay), both the Parent and child account(s) must have the same currency .

SOFORT Payment Method Support Added to Aria Adyen Integration (DEV-9045)

If you use Adyen as your payment gateway, you can now accept payments made using SOFORT. In addition, you can process refunds for those payments. SOFORT is a European online direct payment method that works via online banking.
You can now see SOFORT listed as an accepted payment method for Adyen when you add or edit a payment gateway.
To process a SOFORT payment, Aria will first convert it to SEPA (Single Euro Payments Area) Direct Debit.
After a SOFORT payment is processed, in the Aria application, for the applicable customer:
- You will see SOFORT listed as the Source for the payment on the Payments tab (under Accounts > search for the account > Payments & Credits > Payments).
- You will see Direct Debit and SOFORT listed on the Payment Methods tab (under Accounts > search for the account > Account Overview > Payment Methods).
Please contact your Adyen representative for more information and documentation about working with SOFORT payments.

You can use the record_alternative_payment_m API to process SOFORT payments.

Aria Internal Tax: GST Support for Inclusive and Exclusive Tax on Single Invoice (DEV-9150)

Aria now supports tax calculation on a single invoice for any combination of tax inclusive, tax exclusive, or non-taxable service charge line items.

You must use to Aria Internal Tax Engine to leverage this feature.
The client parameter "Aria Internal Tax Rounding Method" must be set to "Per invoice."

Note: Once set, changing this setting may cause faulty calculations on reversals, credit memos, or other transactions applied to invoices created with the previous setting.

Aria Internal Tax: Precision and Rounding Calculation Amounts Stored For Future Retrieval (DEV-9151)

Aria now stores the following amounts generated by its Internal Tax Engine when calculating taxes for invoice line items:

<unrounded_tax_amt>—The amount multiplied by tax rate before rounding precision. Also referred to as "raw tax amount."
<carryover_from_prev_amt>—The amount that is a carryover from the previous unrounded_tax_amt. It is a remainder, and its value can be positive or negative (based on the previous remainder).
<before_round_adjusted_tax_amt>—The amount of adjusted tax before rounding precision (i.e. the sum of unrounded_tax_amt, and carryover_from_prev_amt).
<carryover_from_current_amt>—The amount that is a carryover from current unrounded tax amt. It is remainder and value can be positive or negative based on the previous remainder.

New XML Statement Templates Display Precision & Rounding Fields Used For Aria Internal Tax Calculations (DEV-9225)

Aria has introduced new global XML statement templates that include a new tax_details tag as follows:
<tax_details>
beginLoopTaxDetails
</tax_details>

To use the new XML statement templates, set the client parameter XML Statement Distillation Option (available under Configuration > Notifications > Notification Settings) to a value other than "No XML Statements"; and, ask Aria Customer Support to set the client parameter SYS_XML_STATEMENT_WITH_USG_SCHEMA_VERSION to '4.0.'

beginLoopTaxDetails is a new loop that returns four new Precision/Rounding fields <unrounded_tax_amt>, <carryover_from_prev_amt>, <before_round_adjusted_tax_amt>, <carryover_from_current_amt>, and other tax details.

It is also now possible to display such tax details on non-XML-based statement by including this loop.

Enhanced CSR Privacy Logging (DEV-9248)

This feature enhances the CSR account access extract to include accounts' personally identifiable information (PII) that client CSRs accessed, modified, or deleted. It is enabled via a client parameter on the back end. PII fields include:

Account Contact
Account Owner
Account PIN
Billing Contact
Child Account
Client Account ID
Comments
Company Name

Current Password
Notes
Parent Account
Security Answer
Security Question
Taxpayer ID
User ID
User Name

Cardholder- and Merchant-Initiated Transactions Implemented in Worldpay Payment Processor for Visa and MasterCard (DEV-9272)

This feature enhances Aria's Worldpay payment processor integration by sending flags distinguishing Cardholder Initiated Transactions (CIT) and Merchant Initiated Transactions (MIT) for Visa and MasterCard credit card transactions, to comply with Visa's Payment Card Industry Data Security Standards (PCI DSS). These standards establish a set of 12 requirements for safeguarding sensitive information and controlling data access.

This feature applies to Credit Card and Tokenized Credit Card payment methods and leverages existing API input <recurring_processing_model_ind> and output <proc_initial_auth_txn_id>. Aria has also updated the following API’s:

Application Fixes

The Aria UI now correctly displays the value set on the backend for the parameter "Auto Send Statement On Pending Invoice Approval." (TICKET-14053)
Accounts with pending invoices no longer generate "Internal errror: Invalid plan instance no" when a plan is replaced immediately. If any errors occur while replacing a plan then the system will rollback the applied changes. (TICKET-14708)
Aria corrected the currency label for ERN to be "Eritrean Nakfa." (TICKET-14783)
Order totals are now displayed on the corresponding statements for the applicable customers instead of on the wrong statements. (TICKET-15593)
When a write-off is created successfully, the write-off amount in the confirmation message now shows the correct amount. (TICKET-15851)
A newly assigned Supplemental Plan(s) activation fees are now correctly being invoiced after activating/reactivating it's Master Plan Instance when the client parameter Multiply Activation Fees By Plan Unit is set to "True". (TICKET-16002)
If you have an account with a master plan instance in the active non-billable status and you try to create an order with the selection "Allow this order's line items to be reflected on the next regularly schedule periodic invoice for this account", the correct error message now appears: "single order billing not allowed plan instance status prevents it". You no longer encounter an ORA error. (TICKET-16109)
The fixes listed below have been implemented in the Aria application. When you assign a master plan and a supplemental plan at the same time:
- The override bill through date is now honored when both plans have the same billing interval.
- As expected, the override master plan instance number (Sync With Master Plan Instance option) is honored when both plans have the same billing interval. This is true whether the supplemental plan is mandatory or optional.
- When you set a retroactive start date or alternate start date for the master plan, that date is now honored.
  (TICKET-16187)
If you use Chase Paymentech as your payment gateway, your selected Recurring Options in your Collection Group Options for that gateway are saved, as expected. (TICKET-16504)
Long-cycle combined invoices resulting from creating accounts with Supplemental Plans that include one-month rollovers now retain and bill for the initial (non-rollover) Supplemental Plans rather than immediately rolling over to the new plan. (TICKET-16544)
Usage submitted via bulk_record_usage_m inclusive of units and a pre-defined amount (rate = Null) with the client setting Include Usage Charges on First Invoice = "True" is now correctly billed and charged on the customer's first invoice. (TICKET-16609).
save_paypal_bill_agreement_m, get_paypal_avs_status_m, and init_paypal_bill_agreement_m now successfully initialize audit records via the > Configuration > Audit Logs > Web Service API. (TICKET-16679)
All currency codes in the Aria databases are now mapped to their corresponding numeric ISO codes in support of downstream payment processing and/or taxation vendors where possible. In some cases non-ISO currencies were entered to support specific needs for particular payment processors and/or taxation providers. (TICKET-16747)
When you pass a <locality> along with a complete address (at the account, billing, or statement level) into the create_acct_complete_m API call, then the address on the Contacts screen and Orders (Assign a Contact) screen will be displayed in the same way as on the Account Overview screen. (TICKET-16754)
Service credits created for a tax line item during a proration calculation now reflect the correct discounted tax amount. (TICKET-16766)
Master Plan now gets replaced on anniversary. Custom rate details of the new master plan are updated after updating the plan_instance table with new plan details. (TICKET-16780)

The rollover credit screen in the Aria UI has been updated with text relating to currency when creating a new service credit. The text, "Your access level dictates that you may create Master Plan Instance credits of an unlimited amount. Fill out the form below using a valid US Dollars amount and click Create Credit", has been revised to state "Your access level....Fill out the form below using a valid currency amount and click Create Credit". For limited service credit creation the text has been altered to state "Your access level dictates that you may not create Master Plan Instance credits greater than <currency_code><currency_symbol>XXXX" to indicate the dynamic parts (currency would vary from account to account). (TICKET-16806)
The <master_plan_instance> tag in payload version 2.0 of the "Account Created" provisioning event is now spelled correctly; and, the order of the <user_id> and <client_acct_id> fields now matches the versions 1.0 and 2.0 payloads in the 1.0 and 2.0 XSDs. (TICKET-16817)
Editing a newly assigned contact now functions as expected. A user is now able to go back to an assigned contact and update the values. (TICKET-16836)
Custom Rate Tiers for a Supplemental Plan Instance are now displaying correctly in the UI via the > Account > Plans > Supplemental Plan Instance screen, when the Supplemental Plan's parent Master Plan Instance is canceled/suspended, and then reactivated. (TICKET-16869)
When usage accumulation reset months is set, and a plan with a usage service whose name exceeds 75 characters is processed by the Aria Invoicer, the invoicer no longer fails with a "character string buffer too small error occurred" error. (TICKET-16886)
When you cancel a supplemental plan, any recorded usage associated with that plan is billed, as expected. (TICKET-17007)
get_usage_history_m now correctly returns all usage records for a pending invoice when filtered using the <invoice_no> input parameter. (TICKET-17030)
General credit memo applied on the invoice is now correctly reflected in the statement by allowing the system to consider the "account-level credit memo" for the statement as well as loopers used for sending the statement invoice.(TICKET-17047)
An error no longer occurs when you try to create a new chart of accounts (COA) code while adding a new service to a new plan. (TICKET-17050)
Aria now correctly updates the due date for invoices in Dispute Hold, and now handles Dispute Hold for child account invoices as expected. (TICKET-17106)
Supplemental plans queued for cancellation on their Anniversary dates are no longer being billed in error. Aria now checks the future queued status assigned on anniversary date before calculating the recurring change and the plan instance is now canceled without billing as expected. (TICKET-17107)
The SPI's product field/plans locale description value column size has been extended to 1000 and events are processed as expected and no longer cause the event notification message creation to fail. Additionally, along with the SPI's product field, the account field value and plan's product field value have also been extended. (TICKET-17113)
A Product Catalog change event notification with a method delivery of XML Document is now successfully generated for a plan description having up to 1000 characters. (TICKET-17114)
Aria's Workflow integration now supports Active Orchestration Event 708 (Account Supplemental Field Value Deleted within the "Accounts and Master Plan Instances" event group). (TICKET-17161)
When you delete a plan and event 1202 (Plan Deleted) is triggered, that event is now successfully transmitted to Workflow. (TICKET-17170)

API Features

Use APIs to Set Bill Lag Days (DEV-8933)

To set the bill lag days for a master plan instance (MPI), you can now pass a value into a new input called <bill_lag_days> using these APIs:

This will allow you to set the bill lag days for multiple MPIs at the same time (if the API allows multiple plan assignments/changes) instead of having to manually set them individually in the Aria application.

You will see the bill lag days that you set on the Bill Lag Days tab for the account in the Aria application.

Notes:

You cannot pass a value into the <bill_lag_days> field by itself. You must also pass in a value to update the plan units, plan status, and/or alternate rate schedule.
<bill_lag_days> cannot be passed in as part of an API call used to schedule changes that will take place on a customer's anniversary date. You must set the <bill_lag_days> to go into effect on a date other than the anniversary date.

Example: If you have an MPI replacement scheduled for a customer's anniversary date, you should not set <bill_lag_days> in the API used for the MPI replacement. If you do, Aria will ignore the <bill_lag_days>.

You can now obtain the number of bill lag days that apply to an MPI from the new <bill_lag_days> output in these APIs:

Process SOFORT Payments with Adyen (DEV-9045)

If you use Adyen as your payment gateway, you can now accept payments made using SOFORT (pay_method 36). SOFORT is a European online direct payment method that works via online banking.
To complete a SOFORT payment, your customers will need to enter their bank details on the SOFORT website.
To process payments made using SOFORT with Adyen, after your customer enters bank details on the SOFORT website, pass values into these new inputs added to the record_alternative_payment_m API:
- payment_auth_received;
- proc_payment_method_id.
Please contact your Adyen representative for more information and documentation about working with SOFORT payments.

After a SOFORT payment is processed, you will see the payment details in the Aria application.

Identify Tax Inclusive Plans in API Outputs (DEV-9152)

The APIs listed below now identify any services (included in master or supplemental plans) that are tax-inclusive in the new <tax_inclusive_ind> output field. You can use the tax inclusive information returned by these APIs for record-keeping purposes, to implement rules in your applications, or for other business reasons:

API Fixes

Aria now correctly charges for recurring arrears services when a Supplemental Plan with a monthly rollover is assigned via assign_acct_plan_m with alt_proration_start_date and combined_invoice set to "true." (TICKET-16027)
XML Exception error: Unexpected element: CDATA was being displayed in authorize_electronic_payment_m API response instead of in the correct XML format (TICKET-16091)
Aria now charges Activation Fees as expected when a prorated invoice results from assigning a master plan via update_acct_plan_multi_m. (TICKET-16178)
Empty spaces in the <is_batch_running> output parameter are no longer being returned in get_virtual_datetime_m. The data_type has been altered such that <is_batch_running> will return only a "Y" or "N" without empty spaces in the JSON response. (TICKET-16386)
All affected next bill dates are now set correctly when you assign or replace a master plan and/or supplemental plan using the update_acct_plan_multi_m API and you specify any of these billing date/billing options:
- set your Override Bill Thru Date Supp Plan Behavior parameter to Align supplemental plans by backtracking from master plan renewal date (in the Aria application under Configuration > Billing > Invoice Settings); and/or
- pass a value into the <override_bill_thru_date>, <force_master_bill_date_reset>, <offset_months>, <auto_offset_months_option>, or <alt_proration_start_date> field. (TICKET-16645)
When you use the update_acct_plan_multi_m API to a) replace one plan with another plan that has a different billing interval or b) update a plan's rate schedule, the next bill date and last bill through date are now set correctly for the assigned plan. (TICKET-16676)
You can now successfully update the early cancelation fee alone in a multi-plan contract when using modify_instance_contract_m. (TICKET-16752)
When a master plan is replaced on anniversary with custom rate given via update_acct_plan_multi_m API, then the master plan is replaced with the custom rate details of the new master plan after updating plan_instance table with new plan details. Future queued replace plan is displayed in the executed status and the plan should be replaced with corresponding custom rate given. (TICKET-16780)
When you use the update_acct_plan_multi_m API to assign a supplemental plan in the middle of a customer's billing cycle, the charges are prorated, as expected. (TICKET-16835)
When you pass a <locality> along with a complete address (at the account, billing, or statement level) into the create_acct_complete_m API call, then the address on the Contacts screen and Orders (Assign a Contact) screen will be displayed in the same way as on the Account Overview screen. (TICKET-16754)
When you call the update_acct_complete_m API and pass in an <acct_start_date>, that input is now honored. (TICKET-16875)
Minimum and maximum allowable plan units for the mandatory supplemental plan's units are now being suppressed when the input_parameter plan units is NULL and the value will no longer be changed to "1" when the update_acct_plan_m is called for updating the product fields alone. (TICKET-16944)
When you cancel a supplemental plan, any recorded usage associated with that plan is billed, as expected. (TICKET-17007)
get_usage_history_m now correctly returns all usage records for a pending invoice when filtered using the <invoice_no> input parameter. (TICKET-17030)
get_recurring_credit_info_m API is now honoring the locale_no input. The Oracle session context is now populated with the given locale to get to the translated values. The following Aria 6-related output fields were deprecated: <eligible_plan_no>, <eligible_plan_name>, <eligible_service_no>, <eligible_service_name>, <client_eligible_plan_id>, <client_eligible_service_id> (TICKET-17035)
These 2 fixes have been implemented:
- When you pass an alphabetical value into the <existing_client_dunning_group_id> field in the update_acct_plan_multi_m API, an error no longer occurs.
- Decimal numbers are honored, as expected, when you pass them into:
  - the <contract_cancel_fee> field in the create_acct_complete_m API; or
  - the <balance_forward> field in the update_acct_plan_multi_m API.
    (TICKET-17115)
When you use the update_acct_plan_multi_m API to complete multiple plan changes involving payments with multiple billing groups, if a collection attempt made with one billing group fails:
- now plan changes are saved in Aria if the collections were made successfully with the associated billing groups and Aria no longer rolls back the changes;
- plan changes are rolled back only if they were attempted with an unsuccessful collection made with its associated billing group, as expected. (TICKET-17133)
The issue that was causing timeouts and periodic 500 internal server errors when making calls to the get_account_details_m API with larger/more complex accounts has been resolved and the API calls now work as expected. (TICKET-17153)

WSDL File Locations

Stage Current

US	https://secure.current.stage.ariasystems.net/api/Advanced/wsdl/20/complete_m-doc_literal_wrapped.wsdl
EUR	None
AUS	https://secure.current.stage.aus.ariasystems.net/api/Advanced/wsdl/20/complete_m-doc_literal_wrapped.wsdl

Stage Future

US	https://secure.future.stage.ariasystems.net/api/Advanced/wsdl/20/complete_m-doc_literal_wrapped.wsdl
EUR	https://secure.future.stage.cph.ariasystems.net/api/Advanced/wsdl/20/complete_m-doc_literal_wrapped.wsdl
AUS	https://secure.future.stage.aus.ariasystems.net/api/Advanced/wsdl/20/complete_m-doc_literal_wrapped.wsdl

Production

US	https://secure.ariasystems.net/api/Advanced/wsdl/20/complete_m-doc_literal_wrapped.wsdl
EUR	https://secure.prod.cph.ariasystems.net/api/Advanced/wsdl/20/complete_m-doc_literal_wrapped.wsdl
AUS	https://secure.prod.aus.ariasystems.net/api/Advanced/wsdl/20/complete_m-doc_literal_wrapped.wsdl

Object Query WSDL Files

Stage Current

US	https://secure.current.stage.ariasystems.net/api/AriaQuery/wsdl/20/integration_services_m-doc_literal_wrapped.wsdl
EUR	None
AUS	https://secure.current.stage.aus.ariasystems.net/api/AriaQuery/wsdl/20/integration_services_m-doc_literal_wrapped.wsdl

Stage Future

US	https://secure.future.stage.ariasystems.net/api/AriaQuery/wsdl/20/integration_services_m-doc_literal_wrapped.wsdl
EUR	https://secure.future.stage.cph.ariasystems.net/api/AriaQuery/wsdl/20/integration_services_m-doc_literal_wrapped.wsdl
AUS	https://secure.future.stage.aus.ariasystems.net/api/AriaQuery/wsdl/20/integration_services_m-doc_literal_wrapped.wsdl

Production

US	https://secure.ariasystems.net/api/AriaQuery/wsdl/20/integration_services_m-doc_literal_wrapped.wsdl
EUR	https://secure.prod.cph.ariasystems.net/api/AriaQuery/wsdl/20/integration_services_m-doc_literal_wrapped.wsdl
AUS	https://secure.prod.aus.ariasystems.net/api/AriaQuery/wsdl/20/integration_services_m-doc_literal_wrapped.wsdl

Release 20

Table of contents