Aria Subscription Billing Platform 6.5 Release Notes
Version 6.2 Release Notes 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 19008 Phone: 484.427.8200 E-mail: info@ariasystems.com Web site: www.ariasystems.com 3
Table of Contents PURPOSE OF THIS DOCUMENT... 6 ARIA SUBSCRIPTION BILLING PLATFORM 6.5 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 6.5... 9 NEW FEATURES... 9 IMPROVEMENTS... 9 FIXES... 9 REMOVALS... 9 KNOWN ISSUES... 9 ARIA6... 10 NEW FEATURES... 10 Ticket DEV-2439: Multiple Activations on an Invoice are now Allowed... 10 Ticket DEV-2452: Service Outage Credit Calculator... 10 Ticket DEV-2472: Set Session based on Account Number... 10 Ticket DEV-2493: Provide more granular operational scope for existing email template class "Electronic Collection Attempt"... 11 Ticket DEV-2507: Suppress client-defined alternate Sequential Statement Number creation when total statement charges equals zero... 11 Ticket DEV-2508: Improve output of "ItemPlanAndComments" replacement string in statement distillation... 11 Ticket DEV-2509: Add exemption_level to create_acct_complete... 12 Ticket DEV-2517: Hierarchical account creation API... 12 Ticket DEV-2518: Ability to preview invoice line items in the create_acct_complete API... 12 Ticket DEV-2530: Ability to choose alternate/custom rate schedules during master plan change via UI... 13 Ticket DEV-2532: API Enhancements to support coupons from external applications... 14 Ticket DEV-2535: Develop "Create Channel" wrapper API method... 14 Ticket DEV-2536: Allow Toggle Test Account Flag to be used for filtering ad-hoc searches in Admin Tools... 14 Ticket DEV-2538: Channel Management UI Module... 14 Ticket DEV-2546 and DEV-2563: New WSDLs for 6.5... 14 Ticket DEV-2569: New e-mail Template Logo... 14 IMPROVEMENTS... 15 Ticket DEV-2547: Set session based on account number... 15 Ticket DEV-2529: Event Notification Provisioning enhanced to add Client Defined Object Supplemental Fields... 15 4
Ticket DEV-2537: Improved presentation of tax on statements... 16 FIXES... 16 Ticket DEV-2571: Activation Fee should not be considered for Service Outage Credit Calculation... 16 Ticket DEV-2573: There is an unnecessary link 'Explain This' on 'Service Outage Credit Calculator' screen... 16 Ticket BUG-424: Account created with Plan which has resource type mapped to it, does not show resource balance under Resource Control even though invoice is fully paid (generic ARC related issue)... 16 Ticket BUG-971: Update statement functions to reflect reversals and display negative values... 16 Ticket BUG-987: CyberSource connector was misinterpreting the character set of data coming from the database... 16 Ticket BUG-1010: insertcontractstartdate and insertcontractenddate populating NULL in statement templates... 17 Ticket BUG-1016: Refunds fail when collection account group is changed.... 17 Ticket BUG-1130: Created users are not displayed in the user list in NGUI.... 17 Ticket BUG-1148: Need new usage threshold events for warning percentage... 17 Ticket BUG-1152: UI does not validate if the queued plan has an effective date in the past or is the current date (related to DEV-2455)... 17 Ticket BUG-1162: Invoice number is generated although not applied when a queued plan is executed with error.... 17 Ticket BUG-1171: NGUI - if creating new Aria6 user that exists in another client_no, no errors are displayed in Firefox.... 17 Ticket BUG-1176: NGUI permits mapping of dunning plans to supplemental plans that should not be allowed.... 18 Ticket BUG-1184: Need to change warning text in CLOB and Java script supporting NGUI for Coupon deletion confirmation prompt.... 18 Ticket BUG-1189: Attempt to use the PDF Master File process to send files is failing... 18 Ticket BUG-1191: Copy Plan function hangs and does not complete.... 18 Ticket BUG-1200: PTD balance is reset to 0 during invoice batch run without consideration of what usage has been invoiced.... 18 Ticket BUG- 1233: Discount Rule Parameter (Max Applications Per Account) not honored when option (Invoice Display Method Reduce Price of Original Line Item(s) is selected.... 18 Ticket BUG- 1281: Payment Settings are showing no results in SF... 18 Ticket BUG- 1313: Custom rates applied to a master or supplemental plan are removed from the acct_alt_rates table as soon as the number of units are modified on the plan, which causes an invoice to be generated for the default rate schedule.... 18 Ticket BUG-1335: Reversal "Credits" are not applied to their corresponding Refund "Charges."... 18 REMOVALS... 19 KNOWN ISSUES... 19 ARIA WEB SERVICES API 6.5... 20 NEW FEATURES... 20 Ticket DEV-2517: Hierarchical account creation API... 20 Ticket DEV-2518: Ability to preview invoice line items in the create_acct_complete API... 20 IMPROVEMENTS... 21 Ticket DEV-25472: Set session based on account number... 21 Ticket DEV-2518: Ability to preview invoice line items in the create_acct_complete API... 21 FIXES... 22 REMOVALS... 22 KNOWN ISSUES... 22 ARIA WEB SERVICES API 6.5 SUITE CHANGES... 23 5
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
Aria Subscription Billing Platform 6.5 Overview Release Date 2/20/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: https://secure.current.stage.ariasystems.net/api/advanced/wsdl/6.5/complete-doc_literal_wrapped.wsdl EUR: None Stage Future WSDL File Locations The WSDL files for the Web Services API in the stage future environment are located here: US: https://secure.future.stage.ariasystems.net/api/advanced/wsdl/6.5/complete-doc_literal_wrapped.wsdl EUR: https://secure.future.stage.cph.ariasystems.net/api/advanced/wsdl/6.5/complete-doc_literal_wrapped.wsdl Production WSDL File Locations The WSDL files for the Web Services API in the production environment are located here: US: https://secure.ariasystems.net/api/advanced/wsdl/6.5/complete-doc_literal_wrapped.wsdl EUR: https://secure.prod.cph.ariasystems.net/api/advanced/wsdl/6.5/complete-doc_literal_wrapped.wsdl 7
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
AdminTools Application 6.5 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
Aria6 New Features Ticket DEV-2439: Multiple Activations on an Invoice are now Allowed The Aria billing system now enables you to bill for multiple activation fees for subscribers that purchase a plan with more than one plan unit. This change enables clients to configure the activation fee by multiplying the plan unit(s) and is available for both master and supplemental plans. A new system parameter, Charge Setup Fees by the factor of the unit numbers, has been added to support this function through UI/NGUI. To set this parameter, select either True or False. This parameter provides backward compatibility if you decide to disable the feature. Note: The supplemental plan assignment also includes a previous system parameter, Charge Activation Fees on New Supp Plan Assignment. This parameter can be turned on to invoice a flat rate Activation Fee on a new supplemental plan assignment. The combination of Charge Setup Fees by the factor of the unit numbers and Charge Activation Fees on New Supp Plan Assignment will enable the Activation Fee for supplemental plans to be turned on as well as enable the Plan Unit Multiplier for the Activation Fee. This change affects the following APIs: create_acct_complete update_master_plan assign_supp_plan modify_supp_plan replace_supp_plan assign_supp_plan_multi Activation Fee in UI now displays "On Activation per unit" when "Change Setup Fees by the factor of the unit number" is turned on. Ticket DEV-2452: Service Outage Credit Calculator The new Service Outage Credit Calculator provides a precise tool embedded in "Create a New Credit" under the Credits tab that pulls up all invoices on affected service plans within a specified service outage period, and calculates the appropriate credit amount based on the percentage of the outage duration spanning one or more billing periods associated with the plan and service. It also enables you to apply a percentage of the calculated total credit amount for a final adjustment. Ticket DEV-2472: Set Session based on Account Number The set_session API call now uses the account number as the argument in place of the userid. 10
Ticket DEV-2493: Provide more granular operational scope for existing email template class "Electronic Collection Attempt" A new client parameter, "ELECTRONIC_COLLECTION_ATTEMPT_EMAIL_NOTIFICATION_SCOPE" replaces the "AUTO_SEND_EMAIL_ON_ELECTRONIC_COLLECTION_ATTEMPT" client parameter for improved collection notification granularity. This new parameter provides the following options: 0 - Never Send - Account holders will not be sent an email message on any electronic payment collection attempt. 1 - On Any Attempt Account holders will be sent an email message on any electronic payment collection attempt. 2 - On Successful Attempts Account holders will be sent an email message only when a given electronic payment collection attempt is deemed successful by the payment processor. 3 - On Failed Attempts Account holders will be sent an email message only when a given electronic payment collection attempt is deemed failed by the payment processor. Note: Existing parameter values for"auto_send_email_on_electronic_collection_attempt" will be migrated to new parameter values. For example, False will be changed to option 0, and TRUE will be changed to option 1. Ticket DEV-2507: Suppress client-defined alternate Sequential Statement Number creation when total statement charges equals zero If a statement does not have any non-zero charges and the client setting for sending statements out has been set to "suppress zero debit invoices" and client is using client defined sequential statement number then the system is not going to increment this client defined sequential statement number. Ticket DEV-2508: Improve output of "ItemPlanAndComments" replacement string in statement distillation The following changes and improvements have been made to the output for ItemPlanAndComments: 1. When an invoice line item is a Charge line item derived from a plan description, depending on the loop marker used, one of the following actions will be completed: If the loop marker is itemplanandcomments, print a concatenation of the source plan name and service code description (existing behavior, no change). If the loop marker is itemsimplelabel, print the service code description only (no plan name as is the case today for loop marker itemplanandcomments ). 2. When an invoice line item is a Charge line item derived from an order of an inventory item, print the clientdefined label of that inventory item. 3. When an invoice line item is Credit line item derived from application of a service credit, print the description of the associated service credit record. 11
4. When an invoice line item is a Credit line item derived from application of a discount rule, print the client defined external description associated with that discount rule. Ticket DEV-2509: Add exemption_level to create_acct_complete A new optional input parameter, tax_exemption_level is now available in the create_acct_complete and update_acct_complete APIs. The following are the permitted values for the new tax_exemption_level parameter: 0 - Account is not exempt from taxation (DEFAULT) 1 - Account is exempt from state/province taxation 2 - Account is exempt from federal/national taxation 3 - Account is exempt from both federal/national and state/province taxation Note: Note: If a value different from the above values is passed to this API, the API will generate an "invalid_tax_exemption_level" error with an error code of 1046. This account tax exemption level configuration is intended only for Aria Internal Taxes. Ticket DEV-2517: Hierarchical account creation API A new API, create_acct_hierarchy, has been added that can create a maximum of five levels of parent/child accounts with a single call. Each account's input and output parameters are preceded with a1, a2, a3, a4, or a5. Each account's inputs and outputs match with the same parameters as the create_acct_complete API. A new client parameter, "Check Client Account ID" has been added to Hierarchical Account Creation for this API. The default value for this parameter is FALSE. When the value is FALSE, the API will function as follows: a1 is the parent of a2 a2 is the parent of a3 a3 is the parent of a4 a4 is the parent of a5 When the value is TRUE, each account passed into the API must have a client_acct_id value: If a1_client_acct_id does not exist, accounts a1, a2, a3, a4, and a5 will all be created. If a1_client_acct_id does exist, this account is skipped. If a2_client_acct_id does not exist, accounts a2, a3, a4, and a5 will be created. a2 will be a child of the preexisting account whose client_acct_id matches a1_client_acct_id. Ticket DEV-2518: Ability to preview invoice line items in the create_acct_complete API New output parameters have been added to the create_acct_complete API that provide invoice details. The following are the new output parameters for the the create_acct_complete API: invoice_charges_before_tax: { type: double, nullable: true } - total amount of charges before taxes invoice_tax_charges: { type: double, nullable: true } - total amount of tax charges 12
invoice_charges_after_tax: { type: double, nullable: true } - total charges invoice_credit_amount: { type: double, nullable: true } - total credit amount invoice_total_amount: { type: double, nullable: true } - total charges minus total credit new_acct_invoice_line_items: - array of invoice line items invoice_line_no: { type: long, nullable: true } invoice_plan_no: { type: long, nullable: true } invoice_plan_name: { type: string, nullable: true } invoice_service_no: { type: long, nullable: true } invoice_service_name: { type: string, nullable: true } invoice_service_coa_id: { type: long, nullable: true } invoice_units: { type: double, nullable: true } invoice_rate_per_unit: { type: double, nullable: true } invoice_line_amount: { type: double, nullable: true } invoice_line_description: { type: string, nullable: true } invoice_start_date_range: { type: string, nullable: true } invoice_end_date_range: { type: string, nullable: true } A new input parameter, do_write, has been added to create_acct_complete. Allowable values are "true" and "false". When null, it will default to "true". When "false" is given, the API will not commit any data to the database and will rollback in the end. Invoice information, other than invoice number, will still be returned (if applicable). Ticket DEV-2530: Ability to choose alternate/custom rate schedules during master plan change via UI This feature introduces the ability to select alternate/custom rate schedules during master plan change from 'Change Master Service Plan' screen. Also 'Change Master Service Plan' screen has been improved by not drawing all the plan details of the client on the same page. Once the new master plan is selected on the first screen of Change Master Service Plan page, the user can navigate to the second page where the plan assignment parameters will be presented along with the new section for alternate/custom rate schedules. 1. The Rate Schedule will be applicable for all three assignment scopes Anniversary, Immediate, and Future. 2. The Custom Rates will be applicable for 'Immediate' and 'Future' assignment scopes. 13
Ticket DEV-2532: API Enhancements to support coupons from external applications This new feature adds two new coupon-related core APIs: get_coupon_details and delete_acct_coupon. The get_coupon_details API returns complete coupon details including, coupons, credit template, discount rules, and discount bundle details for the selected account and/or coupon. The delete_acct_coupon API removes the association of a coupon with an account. Ticket DEV-2535: Develop "Create Channel" wrapper API method This is a new wrapper opcode to support the multi-tier channel commerce feature. Ticket DEV-2536: Allow Toggle Test Account Flag to be used for filtering ad-hoc searches in Admin Tools While the option to select "test account flag" as a filtering method may appear in the old Aria AdminTools product, the actual filtering values will not appear. Ticket DEV-2538: Channel Management UI Module This feature contains the new UI screens for the multi-tier channel commerce feature. Ticket DEV-2546 and DEV-2563: New WSDLs for 6.5 New WSDLs are generated for this release. Ticket DEV-2569: New e-mail Template Logo Two new parameters have been added to the Control Panel/System Settings/Miscellaneous section to enable you to specify a URL address where a company logo would be located: Email Message Logo URL (default value is NULL) and to specify the value of width (HTML tag): Size of Logo URL (HTML img width attribute) - default value is 250. When a value for an Email Message Logo URL parameter is included, the specified logo will be displayed in the email by replacing the insertclientlogourl tag used in corresponding email template with the actual logo located at specified URL. 14
Improvements Ticket DEV-2547: Set session based on account number Aria s existing API method set_session takes an input user_id parameter as the sole method for identification of the Aria account record (within the client implementation indicated by required input parameter client_no ) for which a USS (User Self Service) session is desired when clients require single-sign-on interoperability between their own account-holder-facing application and account-holder-facing-applications hosted by Aria. This enhancement extends the set_session API method such that accounts may be alternately identified using an input acct_no value instead of a user_id value, based on client preference, with no other functional change to the output or behavior of the set_session method. Ticket DEV-2529: Event Notification Provisioning enhanced to add Client Defined Object Supplemental Fields This ticket introduces 3.1 Version of account_prov.xsd and account_prov.dtd files to accommodate the Master and Supplementary Plan's Supplemental Object Fields. Clients subscribing to version 3.1 and above will be able to get the "Account" provisional outputs which include this Master and Supplementary Plan's Supplemental Object Fields. These supplementary fields are available under Account data, Old Account data, Supplemental Plans and Old Supplemental Plans with "Plan Supplemental Object Fields Data" title. - XML file will be generated in the following format: <plan_supp_field_data> <plan_supp_field> <supp_field_name><supp_field_name> <supp_field_value><supp_field_value> <plan_supp_field>.........<plan_supp_field> <supp_field_name><supp_field_name> <supp_field_value><supp_field_value> <plan_supp_field> <\plan_supp_field_data> 15
Ticket DEV-2537: Improved presentation of tax on statements For each line item charge on an invoice, if there is zero or one tax applied to that charge, then allow the charge without tax, the tax, and the charge with tax to be on a single line on the statement. The following are the generic minimal requirements common to most countries in Europe regarding the use of multiple VAT rates on a single invoice. On each invoice detail line item, the vat rate % to be applied has to be identified; this can be by showing the actual % or by showing a reference so that % can be identified on another location on the invoice. The amount on which the VAT is calculated (Amount excl. VAT) must be shown for each VAT rate The calculated VAT must be shown for each VAT rate Fixes Ticket DEV-2571: Activation Fee should not be considered for Service Outage Credit Calculation With this fix, activation fees are excluded from the service outage credit calculation. Ticket DEV-2573: There is an unnecessary link 'Explain This' on 'Service Outage Credit Calculator' screen The link has been converted into hover over option. Ticket BUG-424: Account created with Plan which has resource type mapped to it, does not show resource balance under Resource Control even though invoice is fully paid (generic ARC related issue) If the Plan has a resource type mapped to it, when an account is created, the Resource Balance now indicates an increased balance when an invoice has been fully paid. Ticket BUG-971: Update statement functions to reflect reversals and display negative values Statements will now indicate the cashflow direction as positive (+) or negative (-) to reflect reversals and correctly display negative values. Ticket BUG-987: CyberSource connector was misinterpreting the character set of data coming from the database Accent characters are now correctly interpreted and transferred to CyberSource from Aria 16
Ticket BUG-1010: insertcontractstartdate and insertcontractenddate populating NULL in statement templates The replacement strings of the contract details are now populated during invoice statement generation. Contract details correspond to the following: 1. Single plan contract on the master plan ( plan_no on the invoice). 2. Multiplan contract, if the master plan is part of it. 3. Universal plan contract on account (which is independent of plan_no). 4. For each of the preceding, the contract should be in "In Effect" status (renewed status is not considered, as it indicates that a copy of the contract was created after the end date in effect). 5. For the remaining cases, the start/end date will contain 'n/a' and will appear as "Subscription Term: n/a - n/a." Ticket BUG-1016: Refunds fail when collection account group is changed. Changing the collection account group no longer causes a refund to fail. Ticket BUG-1130: Created users are not displayed in the user list in NGUI. Created users are now successfully displayed in the user list in NGUI. Ticket BUG-1148: Need new usage threshold events for warning percentage Implemented new set of usage class events to notify the usage warning based on threshold percentage defined by the client through client parameters. Ticket BUG-1152: UI does not validate if the queued plan has an effective date in the past or is the current date (related to DEV-2455). When effective date is entered on master plan or supplemental plan, a check is added to make sure that the effective date is in the future. In addition, added a check to recognize any invalid effective date format. Ticket BUG-1162: Invoice number is generated although not applied when a queued plan is executed with error. Suppressed the functionality of invoice number logging in api_queue_result table after a plan is queued. In addition, suppressed the functionality of replacing new master plan through update_master_plan API with illegitimate supplemental child for the new replacement master plan. Ticket BUG-1171: NGUI - if creating new Aria6 user that exists in another client_no, no errors are displayed in Firefox. Firefox now displays an error message if a new Aria6 user is created that already exits in another client-no. 17
Ticket BUG-1176: NGUI permits mapping of dunning plans to supplemental plans that should not be allowed. The new UI now only allows you to map a dunning plan to a Master Plan, and not to a supplemental plan. Ticket BUG-1184: Need to change warning text in CLOB and Java script supporting NGUI for Coupon deletion confirmation prompt. The warning message displayed by the Java Script when a user clicks the Delete Icon/Cancel link has been changed to read as follows: "Are you sure you want to cancel the unconsumed credits and discount rules generated by this coupon?" Ticket BUG-1189: Attempt to use the PDF Master File process to send files is failing. Added ability to send file using SFTP_ident not just SFTP. In addition, standard batch 15 is used to send all output files. Ticket BUG-1191: Copy Plan function hangs and does not complete. The Copy Plan function now completes correctly. Ticket BUG-1200: PTD balance is reset to 0 during invoice batch run without consideration of what usage has been invoiced. The PTD balance is no longer reset to zero (0) whenever there is any unbilled usage on the account. Ticket BUG- 1233: Discount Rule Parameter (Max Applications Per Account) not honored when option (Invoice Display Method Reduce Price of Original Line Item(s) is selected. The 'inline' discounts provided by 'DR' during 'pro-ration' are not incrementing the discount application count, and causing the coupon to be applied more than the 'max applications count' configured on the DR coupon. Ticket BUG- 1281: Payment Settings are showing no results in SF. Payment settings are now showing the proper results. Ticket BUG- 1313: Custom rates applied to a master or supplemental plan are removed from the acct_alt_rates table as soon as the number of units are modified on the plan, which causes an invoice to be generated for the default rate schedule. Custom rates are no longer dropped when the number of units in a master or supplemental are changed. Ticket BUG-1335: Reversal "Credits" are not applied to their corresponding Refund "Charges." Reversal "Credits" are now applied to their corresponding Refund "Charges" only. 18
Removals There are no removals in this release of Aria6. Known Issues There are no known issues in this release of Aria6. 19
Aria Web Services API 6.5 New Features Ticket DEV-2517: Hierarchical account creation API A new API, create_acct_hierarchy, has been added that can create a maximum of five levels of parent/child accounts with a single call. Each account's input and output parameters are preceded with a1, a2, a3, a4, or a5. Each account's inputs and outputs match with the same parameters as the create_acct_complete API. A new client parameter, "Check Client Account ID" has been added to Hierarchical Account Creation for this API. The default value for this parameter is FALSE. When the value is FALSE, the API will function as follows: a1 is the parent of a2 a2 is the parent of a3 a3 is the parent of a4 a4 is the parent of a5 When the value is TRUE, each account passed into the API must have a client_acct_id value: If a1_client_acct_id does not exist, accounts a1, a2, a3, a4, and a5 will all be created. If a1_client_acct_id does exist, this account is skipped. If a2_client_acct_id does not exist, accounts a2, a3, a4, and a5 will be created. a2 will be a child of the preexisting account whose client_acct_id matches a1_client_acct_id. Ticket DEV-2518: Ability to preview invoice line items in the create_acct_complete API New output parameters have been added to the create_acct_complete API that provide invoice details. The following are the new output parameters for the the create_acct_complete API: invoice_charges_before_tax: { type: double, nullable: true } - total amount of charges before taxes invoice_tax_charges: { type: double, nullable: true } - total amount of tax charges invoice_charges_after_tax: { type: double, nullable: true } - total charges invoice_credit_amount: { type: double, nullable: true } - total credit amount invoice_total_amount: { type: double, nullable: true } - total charges minus total credit new_acct_invoice_line_items: - array of invoice line items invoice_line_no: { type: long, nullable: true } invoice_plan_no: { type: long, nullable: true } invoice_plan_name: { type: string, nullable: true } invoice_service_no: { type: long, nullable: true } invoice_service_name: { type: string, nullable: true } 20
invoice_service_coa_id: { type: long, nullable: true } invoice_units: { type: double, nullable: true } invoice_rate_per_unit: { type: double, nullable: true } invoice_line_amount: { type: double, nullable: true } invoice_line_description: { type: string, nullable: true } invoice_start_date_range: { type: string, nullable: true } invoice_end_date_range: { type: string, nullable: true } A new input parameter, do_write, has been added to create_acct_complete. Allowable values are "true" and "false". When null, it will default to "true". When "false" is given, the API will not commit any data to the database and will rollback in the end. Invoice information, other than invoice number, will still be returned (if applicable). Improvements Ticket DEV-25472: Set session based on account number Aria s existing API method set_session takes an input user_id parameter as the sole method for identification of the Aria account record (within the client implementation indicated by required input parameter client_no ) for which a USS (User Self Service) session is desired when clients require single-sign-on interoperability between their own account-holder-facing application and account-holder-facing-applications hosted by Aria. This enhancement extends the set_session API method such that accounts may be alternately identified using an input acct_no value instead of a user_id value, based on client preference, with no other functional change to the output or behavior of the set_session method. Ticket DEV-2518: Ability to preview invoice line items in the create_acct_complete API New output parameters have been added to the create_acct_complete API that provide invoice details. The following are the new output parameters for the the create_acct_complete API: invoice_charges_before_tax: { type: double, nullable: true } - total amount of charges before taxes invoice_tax_charges: { type: double, nullable: true } - total amount of tax charges invoice_charges_after_tax: { type: double, nullable: true } - total charges invoice_credit_amount: { type: double, nullable: true } - total credit amount invoice_total_amount: { type: double, nullable: true } - total charges minus total credit new_acct_invoice_line_items: - array of invoice line items 21
invoice_line_no: { type: long, nullable: true } invoice_plan_no: { type: long, nullable: true } invoice_plan_name: { type: string, nullable: true } invoice_service_no: { type: long, nullable: true } invoice_service_name: { type: string, nullable: true } invoice_service_coa_id: { type: long, nullable: true } invoice_units: { type: double, nullable: true } invoice_rate_per_unit: { type: double, nullable: true } invoice_line_amount: { type: double, nullable: true } invoice_line_description: { type: string, nullable: true } invoice_start_date_range: { type: string, nullable: true } invoice_end_date_range: { type: string, nullable: true } A new input parameter, do_write, has been added to create_acct_complete. Allowable values are "true" and "false". When null, it will default to "true". When "false" is given, the API will not commit any data to the database and will rollback in the end. Invoice information, other than invoice number, will still be returned (if applicable). Fixes 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. 22
Aria Web Services API 6.5 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 No No Yes No 23