Version 6.9 Release Notes. Aria Subscription Billing Platform 6.9 Release Notes

Transcription

1 Aria Subscription Billing Platform 6.9 Release Notes

2

3 COPYRIGHT 2013 ARIA SYSTEMS, INC ALL RIGHTS RESERVED Aria Systems, the Aria logo, LiveRelease, DSM, and SmartRec are trademarks or registered trademarks of Aria Systems, Inc. All other trademarks shown are the property of their respective owners. The use of the names of other companies and their trademarked products are for reference purposes only. No portion of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording or information storage and retrieval systems, for any purpose other than the authorized person s or organization s use without express written permission from Aria Systems, Inc. This documentation is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Aria Systems. Aria Systems assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational content contained in this document. For more information: Aria Systems, Inc 600 Reed Road Suite 302 Broomall, PA Phone: [email protected] Web site: 3

4 Table of Contents PURPOSE OF THIS DOCUMENT... 6 ARIA SUBSCRIPTION BILLING PLATFORM 6.9 OVERVIEW... 7 RELEASE DATE... 7 WSDL FILE LOCATIONS... 7 Stage Current WSDL File Locations... 7 Stage Future WSDL File Locations... 7 Production WSDL File Locations... 7 ADMINTOOLS SYSTEM REQUIREMENTS... 8 Supported Browsers... 8 Java Settings... 8 Screen Resolution... 8 ARIA6 SYSTEM REQUIREMENTS... 8 Supported Browsers... 8 ADMINTOOLS APPLICATION... 8 ARIA WEB SERVICES API... 8 ADMINTOOLS APPLICATION NEW FEATURES... 9 IMPROVEMENTS... 9 FIXES... 9 REMOVALS... 9 KNOWN ISSUES... 9 ARIA NEW FEATURES Ticket DEV-2726: Reset Bill Dates on Invoice Void IMPROVEMENTS Ticket DEV-2647: Support for Tax-inclusive pricing in inventory items and "flat" plan fees Ticket DEV-2671: Provide "All or Nothing" option in Discount Rule definition Ticket DEV-2677: UI Improvements for Creating Coupons and Discount Rules DEV-2717: Display Client Sequential Statement Number in UI Ticket DEV-2719: Bill Lag Days at Payment Method Level Should be Available in UI DEV-2723: Allow greater precision for usage entry, output and calculation - API calls round the values DEV-2728: Ability to include tax amount in service groups DEV-2730: Permit alternate statement template input during one-time purchases (orders) DEV-2731: Client Settings to Auto Collect Balance Should Only Collect Invoices that are Due DEV-2744: Create a service credit that applies against original charge line item easily DEV-2746: DEV 2517 enhancement -- return account IDs when account hierarchy attempts fail FIXES Ticket BUG-1023: Voiding a child transaction causes other invoices to be paid Ticket BUG-1248: Credit for supplemental plan change not occurring when next recurring invoice has been generated with negative bill lag days BUG-1285: Client Parameter/ template class parameter UI issues Ticket BUG-1350: Dunning at the Master Plan Level is Not Supported When there is a Payment Method Change Ticket BUG-1435: Activity dates displaying Contract dates when "Suspend service and billing prorate final invoice" option is selected for a Contract

5 Ticket BUG-1537: When adding multiple rates to a tax set, all taxation values are overwritten by the last taxation value when tax set is saved Ticket BUG-1549: View/Print Statement in Aria6 strips style information Ticket BUG-1550: When changing master plan with cancel supp plans option, new invoice does not consume supp plan service credits Ticket BUG-1561: Usage Accumulation Reset values not showing at the service level as expected Ticket BUG-1576: Rules Application Details within Discount rules are displaying inactive plans Ticket BUG-1579: New instances - NGUI Payment Tech Division Code shows "Save was successful" but Division Code remains blank Ticket BUG-1597: Currency Deletion Is Available When In Use Ticket BUG-1599: Help icons in aria6 have the highest z-index; show through other elements Ticket BUG-1626: Delete Progress Does Not Remove When Error Occurs BUG-1627: Contract end date (and prorated charge) are for one more day than should be Ticket BUG-1628: Tax Configuration - Internal Value Description Not Saving If Longer Than 30 Characters Ticket BUG-1633: Aria6 - newly created user stuck on Loading screen after password update BUG-1641: Refunds: Displayed reversible amounts not reduced by applied discounts/service credits Ticket BUG-1646: Aria6 Password Reset Broken BUG-1648: Not able to see all services when Specified Plan/Service charges is picked when making a discount rule BUG-1649: Sorting communications without a sent date BUG-1709: Failed Collection attempt sets account status to "Active" BUG-1725: Re-allow statements to be created when there is more than one invoice BUG-1750: DEV-2656 Querys related to Single Line Upgrade are returning more than one result BUG-1754: Tax request not sent with supplemental acct fields with supplemental plan change BUG-1806: New usage precision functionality does not include bulk usage rating BUG-1823: Bug-1248 needs to be put in place for plan cancellations REMOVALS KNOWN ISSUES ARIA WEB SERVICES API NEW FEATURES Ticket DEV-2733: get_unbilled_usage_summary API only returns high-level summary to the Rated/Unbilled Usage tab Ticket DEV-2734: Need to be able to search for a specific usage record in Aria for verification purposes IMPROVEMENTS DEV-2723: Allow greater precision for usage entry, output and calculation - API calls round the values Ticket DEV-2727: Enhancement of get_acct_trans_history and get_invoice_details API's to present service and cash credit detail DEV-2731: Client Settings to Auto Collect Balance Should Only Collect Invoices that are Due Ticket DEV-2732: Pass devicefingerprintid field to Cybersource DEV-2735: Discard usage API that allows update of existing un-invoiced usage records Ticket DEV-2759: Increase Unit Price field length (rate) on the xml FIXES BUG-1807: GL tax detail does not match taxes on invoice when calling create_order_with_plans with multiple supplemental plans REMOVALS KNOWN ISSUES ARIA WEB SERVICES API 6.9 SUITE CHANGES

6 Purpose of this Document This release notes document provides you with information about the following: New features: Additions to the functionality available in the platform. Improvements: Changes that enhance existing functionality in the platform. Fixes: Resolutions for bugs reported by our clients and Aria Systems staff. Removals: Features removed from the platform. Known Issues: Known bugs in the platform. Aria Web Service API suite changes: An identification of the API suites that contain changed or new API calls. 6

7 Aria Subscription Billing Platform 6.9 Overview Release Date 6/17/13 WSDL File Locations Stage Current WSDL File Locations The WSDL files for the Web Services API in the stage current environment are located here: US: EUR: None Stage Future WSDL File Locations The WSDL files for the Web Services API in the stage future environment are located here: US: EUR: Production WSDL File Locations The WSDL files for the Web Services API in the production environment are located here: US: EUR: 7

8 AdminTools System Requirements Supported Browsers Internet Explorer 7 to 9 Firefox 3 to 8 Java Settings Java 1.5 Screen Resolution 1024 x 768 or higher Aria6 System Requirements Supported Browsers Internet Explorer 9 Firefox 9 AdminTools Application AdminTools is a web-based application that you and Aria Systems staff can use to: Select options for managing your implementation of Aria. Maintain your customers accounts. View dashboards summarizing data such as revenue and account holder activity. Manage plans, coupons, promotions, and inventory Items. View, schedule, print, and download reports. Aria Web Services API The Aria Web Services API (application programming interface) provides you with API calls that you can use to: Develop your own applications for creating and modifying your customers accounts. Integrate Aria with your company s ERP and finance systems. Deliver real-time sales information to your company s portals. Populate critical business systems with customer information. 8

9 AdminTools Application 6.9 New Features There are no new features in this release of the AdminTools application. Improvements There are no improvements in this release of the AdminTools application. Fixes There are no fixes in this release of the AdminTools application. Removals There are no removals in this release of the AdminTools application. Known Issues There are no known issues in this release of the AdminTools application. 9

10 Aria6 New Features Ticket DEV-2726: Reset Bill Dates on Invoice Void This new feature enables you to void the most recent recurring, non-order-based, non-prorated, full invoice, rollback the invoice and the plan, and reset the billing date. Note: Only the most recent recurring (non-order-based) non-prorated invoice may be voided in this manner, you cannot do historical voids more than one pay period in the past. This feature captures invoice billing dates and other values when an invoice is generated. The values that were captured are used to rollback the invoice when the user voids the future billed invoice. Improvements Ticket DEV-2647: Support for Tax-inclusive pricing in inventory items and "flat" plan fees This enhancement adds Tax-inclusive Pricing for inventory items and flat plan fees. When you use Tax-inclusive Pricing, items and plan services are priced at a rate intended to include the tax, and the tax portion of the price or service fee is subtracted by the program to ultimately determine the amount to be applied to the tax. You can use Tax-inclusive pricing for the following: Inventory items (when the same unit rate is used on the order) Recurring fees Activation fees Cancellation fees The following criteria apply when using this feature: For recurring, activation, and cancellation fees, the indicator selector applies for all rate schedules including custom rates for the plan service. The unit amount will also be updated to match the reverse calculated charges. The tax indicator is applicable, even if there are multiple rate tiers. The tax indicator will not be recorded in the rate history. To use this new feature, you must select the option while you are creating a new plan or a new plan service. For plan services, a new table column Tax Inclusive rates? and check box has been added to Services Applied to this Plan. Access Path: Products>Plans>Create a Plan Ticket DEV-2671: Provide "All or Nothing" option in Discount Rule definition This enhancement enables you to choose whether you will accept a coupon for only some of the plans/services listed on the coupon, or whether you will require customers to agree to accept all of the plans/services listed on a coupon (All or nothing) in order to apply the coupon credit. This feature is enabled by the addition of a new parameter selection checkbox, Use all or nothing substitution rule, located on the Rule Application Details tab. When applying this option to a plan, in the Apply Discount Rule to dropdown list, you must select All Plan Charges, Specified Plans. 10

11 Note: When this option is activated for a plan, the discount is applied only when all of the plans associated with the discount are purchased by the customer (account). Access Path: Marketing>Discount Rules>Discount Rules (New). Ticket DEV-2677: UI Improvements for Creating Coupons and Discount Rules When creating Coupon/Discount Bundles and selecting a discount rule from the list, you can now view additional information about the discount rule that was previously only available on the Discount Rule tab. This enhancement adds the following new columns to this table: Description Discount Type Expiry Display Method When creating a new coupon or a new discount bundle, click the Discount Rules tab to view the table of existing discount rules. Using the search box, you can search for active plans. Access Path: Marketing>Coupons (or) Marketing>Discount Bundles DEV-2717: Display Client Sequential Statement Number in UI Sequential Statement Numbers that match the statement numbers printed on client statements have been added in a new column to both the Statements tab and the Invoices tab under Accounts>Statements and Invoices. Access Paths: Accounts>Account Overview>Recent Statements (or) Statements & Invoices Ticket DEV-2719: Bill Lag Days at Payment Method Level Should be Available in UI This enhancement adds a capability to the Aria6 User Interface (UI) that was previously only available to users within the database. Now, you can set Bill Lag Days within the Aria6 UI. To accommodate this change, a new column, Bill Lag Days, has been added to the table on the Payment Methods tab. This change also adds a new field, Bill Lag Days, to the Details tab for Creating a New Payment Method. When creating a new payment method, you can enter either a negative or positive value in the Bill Lag Days field. This value will be displayed in the Bill Lag Days column for the new payment method when you click Save. Access Path: Configuration>Payments>Payment Methods DEV-2723: Allow greater precision for usage entry, output and calculation - API calls round the values You can now specify the numerical precision that you want to apply for usage records calculations. The following two new parameters have been added to Miscellaneous Settings: Precision for usage record calculations Precision for usage record display Both of these parameters provide a dropdown list from which you can select a value from 0 to 10 to choose the level of numerical precision that you want to apply. Note: The default value is 2. Access Path: Configuration>Client Settings>Miscellaneous Settings The same capability is also available in the Transaction Services API. 11

12 Usage_units can now be greater then two decimal places. The length descriptor for usage_units in the record_usage API in Transaction Services is now double (precision). To accommodate this change, the following two new client parameters have been added: USAGE_RECORD_WRITE_SCALE - is used for the usage units and amt calculation. (Range = 0 10, Default value = 2) USAGE_RECORD_READ_SCALE - is used to display usage units and the amount. (Range = 0 10, Default value = 2) These parameters can affect the User Interface, Statements, and the following APIs: record_usage bulk_record_usage get_usage_history get_unbilled_usage_summary DEV-2728: Ability to include tax amount in service groups The following new replacement strings have been added to Aria Subscription Billing: "insertservgrpnntaxes" is used to show the total tax amount for the service group of NN, where NN represents the service group number 1-thru-29. Currently we are supporting 29 clientdefined service groups. "insertservgrpnngross" is used to show the gross amount(total items charges + total taxes) for the service group of NN. As part of this improvement, the replacement string "insertservgrpnntotal" has been modified. This replacement string is now used to show the net amount (total item charges without tax). DEV-2730: Permit alternate statement template input during one-time purchases (orders) An optional Alternate Statement Template dropdown list field has been added to the Accounts tab. This dropdown list displays a selection of templates from which you can select your choice for an alternate template. The alternate template that you select can be used for one-time purchases in cases where you would want to use a different template than the one you use for monthly recurring services. Access Path: Accounts>Statement Template DEV-2731: Client Settings to Auto Collect Balance Should Only Collect Invoices that are Due A new client parameter has been added that enables you to only collect invoices that are due. Invoices with future dates will now not be collected if this new option is set. The new client parameter is Auto-collect Balance Scope. Select from the following options: Current Balance Due Full Balance The default for new clients is Current Balance Due; the default for existing clients is Full Balance. Access Path: Accounts>Statements & Invoices> Invoicing Settings Also, a new parameter, payment_application_method, has been added to the Transaction Services, collect_from_account API to enable you to optionally select how payments are applied. The following are the payment_application_method parameter options: 1 FIFO Applies payment to the oldest invoice 2 FDFO Applies payment to the first-due invoice 12

13 DEV-2744: Create a service credit that applies against original charge line item easily The selectable options for Use Alternate Service? were changed from Yes or No to Standard, Alternate, or Same as the charge line item. Standard Applies the default Aria credit service code (code 0) on any credit line items on the selected account when the credit is used. Alternate Enables you to select an alternate service code to use in place of the default Aria credit service code. Same as the charge line item forces the use of the same service code as the charge line item. Access Path: Accounts>Payments & Credits>Credits>Create a New Credit DEV-2746: DEV 2517 enhancement -- return account IDs when account hierarchy attempts fail This enhancement verifies whether or not an account ID is already in the system. If the account already exists, an error message of Account already exists is returned. Previously, this message was Not attempted. If the account does not exist, the details of the account including the Account Number and Client ID are displayed. Fixes Ticket BUG-1023: Voiding a child transaction causes other invoices to be paid When a child account invoice is voided, and payment for that account is received and processed on the parentaccount level, the credit for the voided invoices is now properly applied to the original invoice. Previously when a child account invoice was voided and payment for the account was received and processed, the credit for the voided invoice was instead applied first to the oldest invoice on the parent account, and not to the voided child account. Ticket BUG-1248: Credit for supplemental plan change not occurring when next recurring invoice has been generated with negative bill lag days When applying credit for a Supplemental Plan change and a next recurring full invoice is generated with negative bill lag days, credit for the Supplemental Plan change is now correctly applied. Previously, credits for supplemental plan changes were not correctly applied when next recurring invoice was generated with negative bill lag days. When the credit for the Supplemental Plan change is applied, the following also occurs: 1. Previously generated future full invoices for the Supplemental Plan change are voided. 2. Previously-invoiced usage records are unlinked so that they can be applied to the new invoice. 3. Bill dates are reset (rolled back). 4. The invoice for the recurring period of the voided invoice is regenerated to include the new plan. Note: The previously-described voided invoice process can only be completed on a future full Invoice and any other invoices that have been generated after that full invoice. The last invoice generated must be a full invoice and not a prorated invoice. 13

14 BUG-1285: Client Parameter/ template class parameter UI issues This ticket applies the following changes to the template client parameter settings for Notification Settings and Templates: template parameter settings are now correctly retained in the Notification Settings parameter table after the value has been changed and saved. Previously, when Notification Settings parameter values were set and saved, the values were not retained in the Notification Settings parameter table. Default values are now displayed in parameter settings tables when no client-selected values have been selected and saved in the table. Previously, before a client-selected value was saved, the table field would be empty. template class parameters now display the correct text selections in parameter selection dropdown lists. Previously, these values were displayed as only numeric values. template class parameters displayed in the Classic Aria User Interface are now correctly displayed. Previously, the values were displayed as only True or False. Access Path: Configuration>Notifications Ticket BUG-1350: Dunning at the Master Plan Level is Not Supported When there is a Payment Method Change Dunning at the Master Plan Level is now supported when there is a Payment Method Change. Accounts in dunning before their payment method was changed from electronic to non-electronic will now remain in dunning after the payment method has been changed. Previously, when a payment method change was initiated, the dunning process was interrupted and the account was removed from dunning. Ticket BUG-1435: Activity dates displaying Contract dates when "Suspend service and billing prorate final invoice" option is selected for a Contract The Activity End Date is now displayed whenever the contract end option, 'Suspend service and billing prorate final invoice' is selected, unless the billing end date occurs within the current billing period, then the contract end date is still used. Previously, when 'Suspend service and billing prorate final invoice' was selected, only the Contract End Date was displayed as the Activity End Date. Ticket BUG-1537: When adding multiple rates to a tax set, all taxation values are overwritten by the last taxation value when tax set is saved Within an individual Tax Set for the Aria Internal Tax feature, you cannot use a start date more than once in a single Tax Set when the Tax Set includes multiple tax rates. If you attempt to add a tax rate to a tax set with the same start date as another rate in the same set, the following error message is now displayed: You cannot have a start date listed more than once. Previously, if you added more than one tax rate to the same tax set, and used the same start date for more than one tax rate, the last rate valued added would overwrite any rates that had the same start date. 14

15 Ticket BUG-1549: View/Print Statement in Aria6 strips style information When selecting View/Print, the invoice document layout in the Preview window now matches the HTML version in the associated template. Previously, the html style format was not correctly applied, and the document layout in the preview window did not match the layout of the template. Ticket BUG-1550: When changing master plan with cancel supp plans option, new invoice does not consume supp plan service credits When a master plan is updated and the mapped supplemental plan is cancelled, the new invoice will now consume the service credits of both the updated master plan and the cancelled supplemental plan. Previously, when a master plan was affected by a cancelled supplemental plan, the new invoice did not consume the supplemental plan service credits. Ticket BUG-1561: Usage Accumulation Reset values not showing at the service level as expected Usage Accumulation and Usage Pooling information for tier-based accumulation for plans and services is now shown at the service level. Previously, these values were displayed at the plan level, but not at the service level. To view this information, select Accounts>Plans and Services>Master Service Plan tab, and then select Usage Accumulation Reset Value. Ticket BUG-1576: Rules Application Details within Discount rules are displaying inactive plans When viewing Specific Plans/Service Charges under Rules Application Details, only active plans are now displayed. Previously, both active and inactive plans were displayed. Ticket BUG-1579: New instances - NGUI Payment Tech Division Code shows "Save was successful" but Division Code remains blank The division code for the Payment Tech payment gateway is now correctly saved to the database. Previously, the Payment Tech Division Code displayed "Save was successful." But the Division Code remained blank. Ticket BUG-1597: Currency Deletion Is Available When In Use A currency can no longer be deleted when it is in use. If a currency is assigned to a rate schedule, you can now only edit it, but not delete it. Previously, it was possible to delete a currency when it was in use. Ticket BUG-1599: Help icons in aria6 have the highest z-index; show through other elements The Help Icons in Aria6 no longer show through overlaid, pop-up screen elements, such as the datepicker. Previously, the Help Icons would show through overlaid screen elements. 15

16 Ticket BUG-1626: Delete Progress Does Not Remove When Error Occurs When an error occurs while deleting an object in Aria6, the progress indicator now discontinues being displayed. Previously, the progress indicator would continue to be displayed even though an error had occurred. BUG-1627: Contract end date (and prorated charge) are for one more day than should be Contract end dates and prorated charges are now ending on the correct date. Previously, contracts and prorated charges were ending one day later than they should have been. Ticket BUG-1628: Tax Configuration - Internal Value Description Not Saving If Longer Than 30 Characters The Description field on the Tax Configuration, Internal Values tab now accepts more than 30 characters. Previously, this field was limited to 30 characters. Access Path: Configuration>Integrations>Taxation Configuration. Ticket BUG-1633: Aria6 - newly created user stuck on Loading screen after password update When a new user logs into Aria6 for the first time, and is prompted to change their password, the log in screen no longer freezes in a Loading state. Previously, the screen would remain on Loading page indefinitely. BUG-1641: Refunds: Displayed reversible amounts not reduced by applied discounts/service credits Displayed reversible amounts are now correct, as any applicable discounts and service credits are now properly deducted from the displayed amount. Previously, discounts and service credits were not properly deducted from reversible amounts, making the displayed reversible amount too high. Ticket BUG-1646: Aria6 Password Reset Broken When resetting a password and prompted for a security question, the screen no longer freezes with a Loading message. BUG-1648: Not able to see all services when Specified Plan/Service charges is picked when making a discount rule You can now see and select all services attached to a plan when selecting them during discount rule creation. Previously, you could not see all services when Specified Plan/Service charge is selected when making a discount rule. BUG-1649: Sorting communications without a sent date The Account Information page now displays both the created date and sent date, and the records are now sorted according to created date. Previously, s were sorted according to the ordered-by date, therefore any s without an ordered-by date were displayed at the top of the list, and not in correct chronological order. BUG-1709: Failed Collection attempt sets account status to "Active" A failed collection attempt will no longer set an account status to active when the client setting AUTO_ROLLBACK_DUNNING_STATUS_ON_ZERO_BALANCE is set to "TRUE." Previously, a failed collection attempt caused an account s status to be set to active. 16

17 BUG-1725: Re-allow statements to be created when there is more than one invoice Aria now allows additional statements to be created when there is more than one invoice. Previously, additional invoices were unstatementized, as additional statements were not allowed to be created. BUG-1750: DEV-2656 Querys related to Single Line Upgrade are returning more than one result. Queries related to Single Line Upgrade no longer return more than one result. Previously, sometimes more than one query result would be returned causing a user-defined exception to also be returned. This change now enables the Flat Rate Pricing rule to be applied to Single Line Upgrade and also includes all tiered pricing rules. BUG-1754: Tax request not sent with supplemental acct fields with supplemental plan change Tax requests now send supplemental account fields with a supplemental plan change. Previously, tax requests were not sent with supplemental acct fields with a supplemental plan change. BUG-1806: New usage precision functionality does not include bulk usage rating The new usage precision functionality has now been added to Bulk Usage Rating. When this change was originally applied, Bulk Usage Rating was not included. BUG-1823: Bug-1248 needs to be put in place for plan cancellations Canceling a plan now causes future recurring invoices to be voided when the next recurring invoice has been generated with negative bill lag days. Removals There are no removals in this release of Aria6. Known Issues There are no known issues in this release of Aria6. 17

18 Aria Web Services API 6.9 New Features Ticket DEV-2733: get_unbilled_usage_summary API only returns high-level summary to the Rated/Unbilled Usage tab This enhancement provides an improved version of the get_unbilled_usage_summary API, which provides detailed information on Period-to-Date (PTD) unbilled usage balances. This API will now also provide detailed information about the Month-to-Date (MTD) balance. (Account Services API) This new feature adds the following new output parameters to the "get_unbilled_usage_summary" API: Usage_type Usage_units Usage_type_code Usage_type_description Usage_date Recorded_units Specific_record_charge_amount Rate Parent_usage_rec_no The following is the API header: Arguments: client_no: { type: long, nullable: false } auth_key: { type: string, nullable: false } acct_no: { type: long, nullable: false } Returns: error_code: { type: long, nullable: true } error_msg: { type: string, nullable: true } currency_cd: { type: string, nullable: true } currency_name: { type: string, nullable: true } acct_mtd_threshold_amount: { type: double, nullable: true } acct_ptd_threshold_amount: { type: double, nullable: true } client_mtd_threshold_amount: { type: double, nullable: true } client_ptd_threshold_amount: { type: double, nullable: true } mtd_balance_amount: { type: double, nullable: true } ptd_balance_amount: { type: double, nullable: true } acct_mtd_delta_sign: { type: string, nullable: true } acct_mtd_delta_amount: { type: double, nullable: true } acct_ptd_delta_sign: { type: string, nullable: true } acct_ptd_delta_amount: { type: double, nullable: true } client_mtd_delta_sign: { type: string, nullable: true } client_mtd_delta_amount: { type: double, nullable: true } 18

19 client_ptd_delta_sign: { type: string, nullable: true } client_ptd_delta_amount: { type: double, nullable: true } unapp_svc_credit_bal_amount: { type: double, nullable: true } unapp_svc_credit_delta_sign: { type: string, nullable: true } unapp_svc_credit_delta_amount: { type: double, nullable: true } unbilled_usage_recs: ### New Array Introduced to provide usage details nullable: true Type: usage_type_no: { type: long, nullable: true } usage_type_description: { type: string, nullable: true } usage_date: { type: string, nullable: true } units: { type: double, nullable: true } specific_record_charge_amount: { type: double, nullable: true } pre_rated_rate: { type: double, nullable: true } recorded_units: { type: double, nullable: true } usage_parent_rec_no: { type: long, nullable: true } usage_type_code: { type: string, nullable: true } Ticket DEV-2734: Need to be able to search for a specific usage record in Aria for verification purposes This newly modified API, get_usage_history, will enable you to query Aria for individual usage records to verify what was sent to Aria and to compare the data with your own data. (Account Services API) This feature adds the following four new input parameters: qualifier_1 qualifier_2 qualifier_3 qualifier_4 The date_range_start and date_range_end parameters have been updated to get both the date and time value. The following is the API header: get_usage_history: class: account_services arguments: client_no: { type: long, nullable: false } auth_key: { type: string, nullable: true } acct_no: { type: long, nullable: false } specified_usage_type_no: { type: long, nullable: true } date_range_start: { type: string, nullable: true } ## extended to include hh24:mi:ss date_range_end: { type: string, nullable: true } ## extended to include hh24:mi:ss specified_usage_type_code: { type: string, nullable: true } usage_qualifier_1: ## New Usage Qualifier Filters added nullable: true 19

20 type: type: type: type: usage_qualifier_1: { type: string, nullable: true } usage_qualifier_2: nullable: true usage_qualifier_2: { type: string, nullable: true } usage_qualifier_3: nullable: true usage_qualifier_3: { type: string, nullable: true } usage_qualifier_4: nullable: true usage_qualifier_4: { type: string, nullable: true } returns: error_code: { type: long, nullable: true } error_msg: { type: string, nullable: true } usage_history_records: nullable: true type: billable_acct_no: { type: long, nullable: true } etc, same as before This new API, set_external_object_id has been created to map external IDs with Aria defined object IDs. The destination_id represents the Aria-defined unique ID of the external destination. Improvements DEV-2723: Allow greater precision for usage entry, output and calculation - API calls round the values You can now specify the numerical precision that you want to apply for usage records calculations. The following two new parameters have been added to Miscellaneous Settings: Precision for usage record calculations Precision for usage record display Both of these parameters provide a dropdown list from which you can select a value from 0 to 10 to choose the level of numerical precision that you want to apply. Note: The default value is 2. Access Path: Configuration>Client Settings>Miscellaneous Settings The same capability is also available in the Transaction Services API. Usage_units can now be greater then two decimal places. The length descriptor for usage_units in the record_usage API in Transaction Services is now double (precision). 20

21 To accommodate this change, the following two new client parameters have been added: USAGE_RECORD_WRITE_SCALE - is used for the usage units and amt calculation. (Range = 0 10, Default value = 2) USAGE_RECORD_READ_SCALE - is used to display usage units and the amount. (Range = 0 10, Default value = 2) These parameters can affect the User Interface, Statements, and the following APIs: record_usage bulk_record_usage get_usage_history get_unbilled_usage_summary Ticket DEV-2727: Enhancement of get_acct_trans_history and get_invoice_details API's to present service and cash credit detail Two new output parameters, credit_reason_code_description and csr_comments, have been added to the following three API's in Account Services: get_acct_trans_history get_family_trans_history get_invoice_details When used with the get_acct_trans_history and get_family_trans_history API's these parameters will return the values for corresponding transaction IDs associated with Cash Credits. When used with the get_invoice_details API these parameters will return the values for corresponding transaction IDs associated with service-related credits. Note: get_acct_trans_history is part of the Account Services API, and get_invoice_details is part of the Transaction Services API. DEV-2731: Client Settings to Auto Collect Balance Should Only Collect Invoices that are Due A new client parameter has been added that enables you to only collect invoices that are due. Invoices with future dates will now not be collected if this new option is set. The new client parameter is Auto-collect Balance Scope. Select from the following options: Current Balance Due Full Balance The default for new clients is Current Balance Due; the default for existing clients is Full Balance. Access Path: Accounts>Statements & Invoices> Invoicing Settings Also, a new parameter, payment_application_method, has been added to the Transaction Services, collect_from_account API to enable you to optionally select how payments are applied. The following are the payment_application_method parameter options: 1 FIFO Applies payment to the oldest invoice 2 FDFO Applies payment to the first-due invoice 21

22 Ticket DEV-2732: Pass devicefingerprintid field to Cybersource As part of an additional layer of security for payment processing fraud prevention, you can now pass an account supplemental field as the devicefingerprintid field to Cybersource for each account. The device ID can be mapped to any of the supplemental fields that can be used to identify the submitting device. To activate this option and select the supplemental field to be mapped, locate the devicefingerprintid field on the Cybersource Options tab, and then select the supplemental field that you want to map to the devicefingerprintid. Access Path: Configuration>Payments>Payment Gateways>Cybersource>Options tab DEV-2735: Discard usage API that allows update of existing un-invoiced usage records Aria has added a new API, discard_usage, to the Transaction Services API. This new API is used to discard a usage record, provided that the usage record has not been invoiced. A error code will be returned from the API if the usage record input array contains any bad records. In addition to this for individual failed records, the following error codes and message at included with API: Usage record not found Usage already billed Given client_record_id associated with multiple usage records usage already discarded If user provided both usage_record_no and client_record_id as an input parameter the following error message is returned Invalid input: Should not give input value to both usage_record_no and client_record_id Parameter. If you do not provide any value to either usage_record_no or client_record_id as an input parameter, the following error code and message will be returned Invalid input: Provide input value to any one of usage_record_no or client_record_id. API Header: arguments: discard_usage: class: transaction_services arguments: client_no: { type: long, nullable: false } auth_key: { type: string, nullable: true } usage_record_nos: nullable: true type: usage_record_no: { type: long, nullable: true } client_record_ids: nullable: true type: client_record_id: { type: string, nullable: true } 22

23 returns: type: exclusion_reason_cd: { type: long, nullable: true } exclusion_comment: { type: string, nullable: true } error_code: { type: long, nullable: true } error_msg: { type: string, nullable: true } failed_records: nullable: true usage_record_no: { type: long, nullable: true } client_record_id: { type: string, nullable: true } record_error_code: { type: long, nullable: true } record_error_msg: { type: string, nullable: true } In addition, the existing APIs, get_usage_history and get_unbilled_usage_summary, have also been modified. A new output parameter, exclude_reason_cd, which gives the reason code for the exclusion of usage, has been added to both of these APIs. exclude_reason_cd: { type: long, nullable: true } Ticket DEV-2759: Increase Unit Price field length (rate) on the xml This enhancement increases the decimal precision for the proration factor for the get_aria_xml_statement API template Unit Price field length from five to ten decimal places. This change applies only to the XML template for the get_aria_xml_statement API. Non-XML templates will continue to work as before by padding/truncating to 10 characters. For non-recurring and non-usage services such as activation, the TEXT/XML statement will not be subject to rounding to two decimal places, whereas the TEXT/HTML statement will continue to be rounded to two decimal places. 23

24 Fixes BUG-1807: GL tax detail does not match taxes on invoice when calling create_order_with_plans with multiple supplemental plans This fix provides the following changes: When calling create_order_with_plans with multiple supplemental plans, the GL tax detail table now matches the taxes on statements. The gl_tax_detail is now populated for all supplemental plans that are passed to the create_order_with_plans API. Previously, only the first supplemental plan passed to the create_order_with_plans API was populated. Service Credits are now being correctly created for all supplemental plans. Removals There are no removals in this release of the Aria Web Services API. Known Issues There are no known issues in this release of the Aria Web Services API. 24

25 Aria Web Services API 6.9 Suite Changes The table below identifies the API suites that contain changed or new API calls. See the API documentation in Parature for more information about the changes/additions in the API suites. API Suite Account API ARC Maintenance API ARC Transaction API Object Query API Registration/USS (User Self Service) Application Parameter Registry API System Services API Transaction API USS (User Self Service) SSO (Single Sign On) Services API Virtual Inventory Engine (VIE) Transaction API Changes Made? Yes No No No No Yes Yes No No 25