Skip to main content
Aria Knowledge Central

Release 71

Note: This is a draft version of the release notes for Aria Billing Cloud—Version 71, which is currently available in Stage Future.

Overview

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

Release Date

Stage Future Release Date

 12-May-2026

System Requirements

Supported Browsers

Aria supports the latest stable versions of the following Web browsers: 

  • Chrome 63
  • Firefox 52
  • Microsoft Edge
  • Safari 11 on MacOS 

Screen Resolution

1024 x 768 or higher

Release 71 Contents

  1. Application Features 
    1. Append Schedule ID to Filename Client Parameter Added (DEV-11697)
    2. Payment Plans—Phase 6 (DEV-12220)
    3. Cash Credit Details in CCP (DEV-12243)
    4. CCP Accounts—Notification Method (DEV-12313)
    5. CCP Create And Update Credit Memo After Creation (DEV-12355)
    6. Installment Due Reminder Emails: New Fields, and Sent in XML Master File (DEV-12417)
    7. Nets Netaxept for Smart Payments - Phase 3 (DEV-12428)
    8. CCP Edit Queued Subscriptions - Part 2 (DEV-12455)
    9. CCP Bug Fixes and Improvements (DEV-12457)
    10. CCP Show Payment Transaction ID and Payment ID (DEV-12482)
    11. Error Messaging Enhanced for Braintree and Worldpay Smart Payments (DEV-12538)
    12. Run Payments Added to Aria Smart Payments (DEV-12539)
    13. CCP Account > Subscription > Details > Create Subscription - Part 3 (DEV-12546)
    14. CCP Subscription Details [Plan Instance] - Part 10 (DEV-12553)
    15. Business Network (BN) Code Added for PayPal Smart Payments (DEV-12583)
    16. Billie and Billie Connect (DEV-12626)
    17. Application Fixes 
  2. API Features 
    1. Payment Plans—Phase 6 (DEV-12220)
    2. Add Multiple Prorated SPIs and NSOs on Non-Default Rate for update_acct_plan_multi_m (DEV-12433)
    3. API get_payment_unapplication_details_m Now Returns Voided Transactions (DEV-12472)
    4. Aligned Installment Estimated Due Date Fix for MPIs with Non-Billable SPIs (DEV-12493)
    5. DST Midnight Error Fix for Installment and Payment Plan APIs (DEV-12554)
    6. API update_acct_plan_multi_m Enhancement – Introduce line_credit_amount in invoice_item_details (DEV-12605)
    7. Enhanced create_acct_dunning_group_m API Response To Return Newly Created Dunning Group Information (DEV-12608)
    8. Surcharge API Update—Include <surcharge_rate_schedule_details> in get_acct_surcharges_m (DEV-12609)
    9. Addition Of <line_credit_amount> In Response of Account Plan APIs (DEV-12610)
    10. API Fixes
  3. WSDL File Locations
    1. Object Query WSDL Files

Application Features 

Append Schedule ID to Filename Client Parameter Added (DEV-11697)

The client parameter Append Schedule ID to Filename is introduced in this release.

When this parameter is set to True (default), the schedule_id will be appended (after the filename prefix or rpt_id) during report file name generation. This ensures a unique file name for each schedule of the same report type. Additionally, milliseconds have been included in the timestamp portion of the file name to further enhance uniqueness, particularly in scenarios where duplicate schedule_id values may occur (e.g., sandbox generation).

When the client parameter is set to False, the existing report file naming behavior remains unchanged.

With this enhancement, the report filename will be set as follows:

Schedule ID output_file_name_prefix file_name (if Client Parameter is set to False) file_name (if Client Parameter is set to True)
22318 mb_inv_item_child_dtl mb_inv_item_child_dtl-20240723-133236.csv mb_inv_item_child_dtl-22318-20240723-133236123.csv
22318 - (if no prefix is configured) <rpt_id>-20240723-133236.csv <rpt_id>-22318-20240723-133236123.csv




Payment Plans—Phase 6 (DEV-12220)

Aria delivers Phase 6 of the Payment Plans feature, continuing to expand and refine the payment plan lifecycle management introduced in earlier phases. Following are Aria application updates related to Payment Plans—Phase 6.

Note: View the API writeup for this ticket.

Notified Sequence Handling for Aligned Payment Plans

For aligned payment plans, Aria now treats any sequence assigned to a statement as notified immediately upon assignment, even if the statement has not yet been sent to the account. This prevents modifications to a sequence schedule after the sequence has been assigned to a statement.

Installment Invoice Re-enablement After Dunning

After each dunning pass on a payment plan installment invoice, Aria now re-enables the invoice for billing batch processing regardless of whether the collection attempt was successful. This ensures that installment invoices remain available for collection in subsequent billing batch runs.

Child Account Dunning Corrected for Parent-Pay Payment Plans

In a parent-pay payment plan, Aria no longer pushes child Master Plan Instances (MPIs) into dunning based on future, not-yet-due installment balances. Aria now evaluates dunning for child accounts based only on balances that are currently due. This behavior applies to both cumulative and non-cumulative statement configurations. No configuration changes are required.

Payment Plan Cancellation Collection Logic

Aria made the following improvements to payment plan installment cancellation processing:

  • Aria now records the payment plan number on cancellation queue entries for future-dated cancellations, ensuring accurate tracking through the cancellation process.
  • Aria derives the collection amount for a cancellation from the installment schedule detail rather than the invoice balance, providing more accurate collection for invoices that are only partially covered by an installment.
  • Aria marks an invoice to prevent duplicate billing batch processing only when the full invoice balance equals the installment open amount.
  • Aria marks an invoice after any cancellation collection attempt, regardless of whether the collection was successful.

Cash Credit Details in CCP (DEV-12243)

You can now view full details for a cash credit directly in CCP. When you click the Reason column on the Cash Credits page, a Details drawer opens with a complete view of the selected cash credit.

The drawer displays in two sections. The top section shows the credit number, amount, creation details, comment, and reason. The bottom section shows all transaction line items for the selected cash credit in a grid.


CCP Accounts—Notification Method (DEV-12313)

A new Notification Method page has been added to CCP, which lists all available notification methods in a sortable, filterable grid. From here you can update an account's notification method. For email-related notification methods, the popover allows users to add CC and BCC email recipients. For master file-related methods, users can configure the List Account First in Master File option. When you select a combined method involving both email and master file, the popover opens displaying both the recipient configuration and the master file listing option.

To access this new page, select Accounts > Notification Method from the CCP side navigation menu.


CCP Create And Update Credit Memo After Creation (DEV-12355)

Each credit memo record in CCP now includes a new update action, which opens a dedicated Update Credit Memo drawer. In this drawer you can review the Credit type, Reason Code, and Amount as well as view, edit, or add up to 9 qualifier name-value pairs per credit memo. To access this new drawer, navigate to Transactions > Credits > open the Credit Memos tab > select Update on any credit memo record.


Installment Due Reminder Emails: New Fields, and Sent in XML Master File (DEV-12417)

Aria Billing Cloud (ABC) now supports Billing Group and statement contact detail fields in the installment due reminder (IDR) XML output delivered through notification method 13 (XML Master File). The additional fields provide a more complete notification record for accounts whose invoices are paid through an independent installment term.

Use these new fields when configuring the IDR email template, then specify that IDR email template in the Notification Template Group. Aria generates the IDR XML from the configured template and delivers IDRs as a separate XML master file in the overnight batch.

Note: This feature applies to clients configured to use notification method 13 (XML Master File) for independent installment plans.

New Fields

The following Billing Group and Statement Contact fields have been added to the IDR email template:

New Field Description
<StmtCompanyName> Company name of the statement contact for the Billing Group
<StmtFirstName> First name of the statement contact for the Billing Group
<StmtLastName> Last name of the statement contact for the Billing Group
<StmtAddress1> Primary address line of the statement contact
<StmtAddress2> Secondary address line of the statement contact
<StmtCity> City of the statement contact
<StmtState> State or province of the statement contact
<StmtLocality> Locality of the statement contact
<StmtZip> Postal code of the statement contact
<StmtCountry> Country of the statement contact
<BillingGroupNo> Aria-assigned identifier for the Billing Group
<ClientBillingGroupID> Client-assigned identifier for the Billing Group
<BillingGroupTermNo> Term number associated with the Billing Group
<BillingGroupClientTermID> Client-assigned term identifier for the Billing Group
<BillingGroupEANGLN> European Article Number (EAN) or Global Location Number (GLN) associated with the Billing Group
<BillingGroupEANGLNREQ> Required European Article Number (EAN) or Global Location Number (GLN) for the Billing Group

Nets Netaxept for Smart Payments - Phase 3 (DEV-12428)

Aria's Smart Payments integration with Nets Netaxept now supports Tokenized Credit Card payments for the Visa, Mastercard, American Express, Diners and Dankort card types. The following actions are supported for this payment type:

  • Create Token
  • Query Token
  • Authorizations (both 3DS and non-3DS)
  • Reversal
  • Capture
  • Payment

Tokenized Credit Card payments also support Cardholder-Initiated Transactions (CIT) and Merchant-Initiated Transactions (MIT). Additionally, Aria sends soft descriptor values at both the Payment Gateway and Collection Group UI screens; a maximum field value of 1,000 characters is allowed (Configuration > Payments > Payment Gateways/Collection Groups > Field Options).


CCP Edit Queued Subscriptions - Part 2 (DEV-12455)

You can now update the Rate Schedule on a queued subscription or add-on in CCP by navigating to Subscriptions > All Service Rates > select a queued subscription or add-on > select View Details button in the upper right corner of the screen to open the editable drawer.

Note: Only the default rate schedule change is currently supported (proration selection is not available as of R71).


CCP Bug Fixes and Improvements (DEV-12457)

  • Invalid session needs to redirect to the login page CCP now automatically redirects users to the login page when their session is deemed invalid. This ensures users with an invalid dashboard_session or those subject to the DISABLED_CONCURRENT_USER_SESSIONS parameter are not left in a broken state. Previously, CCP did not redirect users to the login page when their session became invalid.

  • Account Groups Edit/Save CCP now enables Edit and Save functionality within the Account Groups section, and displays a tooltip when a user attempts to select an account group that shares the same payment method as an already-assigned group. This makes it clear why a particular group is unavailable for assignment. Previously, Edit and Save functionality did not exist in the Account Groups section.

  • Add Newly Created Record to the Top of the Grid CCP now automatically populates a newly created record at the top of the main grid with a highlight animation upon successful creation, currently available in the Create Dunning Group and Child Account Assignment flows. This improves visibility of new records immediately after creation. Previously, newly created records were not surfaced at the top of the grid, and any pre-applied filters or sorting remained in place.

  • Manage Test Account Flag CCP now displays a persistent top-hat banner when viewing accounts flagged as test accounts in Crescendo, clearly indicating the account's test status and noting that no payments will be processed. Users can expand the banner to view additional details, including the automatic 5-day termination policy and specific test account limitations. Previously, no such banner existed to alert users that they were viewing a test account.

  • Add/Update Payment Method: Custom Payment Method ID Form Validation for Duplicate Entries CCP now validates the Custom Payment Method ID field in real time as soon as a user enters an ID and moves focus away from the field, immediately displaying an error message if a duplicate entry is detected. This catches duplicate entries earlier in the process, reducing errors at submission. Previously, duplicate entries were only flagged upon clicking the Save button at the final step.

  • Quick Search by a field, that field should be included in results [non-standard Fields] CCP now automatically includes the field used in a quick search as the second column from the right in the results grid, displaying how the entered search term matches the field value and showing only the first matching record per account. The newly added column supports standard functionalities such as reordering, hiding, and exporting. Previously, the search field was not automatically included in the results grid when a non-standard field was used for the search.

  • [Invoice details] Add Subscription ID as a default-hidden field in the grid actions and Enhanced Actions button CCP now adds a default-hidden Subscription ID column to the transactions grid within the Invoice Details drawer, which users can enable for quick access when needed. The Actions button has also been replaced with a segmented button for commonly used actions that remembers the user's previous selection. Previously, the Subscription ID was only accessible via a tooltip on each subscription row, and no segmented Actions button existed.

  • All Service Rates—Update grid total to show Total Invoice balance vs Total Charges CCP now displays total values in the All Service Rates preview invoices that are consistent with Crescendo, and also shows Paid and Balance columns alongside the corrected totals. This resolves a discrepancy that occurred in certain proration scenarios. Previously, the preview invoices displayed during proration application showed mismatched totals compared to Crescendo when NET_NEGATIVE_PRO_RATION_ACTION=2 was set.


CCP Show Payment Transaction ID and Payment ID (DEV-12482)

The Payment Details popover found from the Payments grid in CCP now includes a new Payment ID field for each payment record alongside the existing Payment Transaction ID (shown as "ID"). To view these, navigate to Transactions > Payments > select the Transaction Type for any payment in the grid.


Error Messaging Enhanced for Braintree and Worldpay Smart Payments (DEV-12538)

For Worldpay Smart Payments, error codes are now accompanied by error messages when message text is available (e.g., when attempting a tokenized payment where a token is unavailable, the message “Error 5 – Token Does Not Exist” will appear). Additionally for Braintree, validation error handling will first check for primary validation errors and, if none are available, then check for secondary validation errors to ensure the first available validation error is returned.


Run Payments Added to Aria Smart Payments (DEV-12539)

Aria now adds Run Payments as part of its Smart Payments integration with this release. Run Payments supports the Visa, Mastercard, American Express, and Discover credit card types (processor ID: 44). Run Payments handles the full payment process, including authorizing charges, capturing money, issuing full or partial refunds (up to 60 days later), and reversing authorizations (along with a zero authorization capability for supported cards). Card information is kept safe through tokenization, meaning real card numbers are swapped for secure codes, which are refreshed every hour.

Payment Gateway UI Fields

The following fields appear at the Merchant Account Details tab (Configuration > Payments > Payment Gateways...all fields are required unless noted):

  • API URL
  • Merchant ID
  • API Key (duration is 1 hour - new key and refresh token is persisted upon expiration; expiry time of new key is stored so it can be used for subsequent transactions)
  • Refresh Token
  • Create Token API URL (required for the TCC pay method, but otherwise optional)

Note: The API Key and Refresh Token fields are unavailable from the Collection Group screen for this payment gateway.

Address Verification Service (AVS) Code Support

Run Payments supports the following AVS codes for all supported card brands, with region-specific handling (U.S., U.K., Non-U.S.):

Field Description
Y Both street addresses and 5-digit ZIP match (U.S.)
X Both street addresses and 9-digit ZIP match (U.S.)
F, D International/U.K. matches
A, Z, W, P Partial matches
N No match
R, S, U, G Unattempted or unsupported

Card Verification Value (CVV) Code Support

Run Payments supports the following CVV codes for all supported card brands:

Field Description
M CVV values match (success)
N CVV values do not match
P Authorization not processed
S CVV not present on card
U CVV verification not supported
X Provider did not respond

Webhook Notifications

The following events are supported to update payment statuses:

  • transaction.processed (marks payment as verified)
  • transaction.reject (marks payment as failed)

Transaction Logging

The Refresh Token and API Key values are masked in Transaction Logging.


CCP Account > Subscription > Details > Create Subscription - Part 3 (DEV-12546)

The Add New Subscription and Add New Add-on workflows in CCP have been enhanced in the following ways:

  • Product Fields has been renamed to Subscription Fields (or Add-on Fields).
  • An Add New Field button has been added that opens a drawer for assigning values to non-required fields.
  • An Inventory Items section now appears in the second step of the Add New Add-on process.
  • The Contact Assignment step has been redesigned and now includes a Create New Contact button.

To access these workflows, navigate to Accounts > Subscriptions > Details > select Add New Subscription or expand a subscription to open the Add-on Details drawer.


CCP Subscription Details [Plan Instance] - Part 10 (DEV-12553)

CCP now includes an Add New button in the Add-on Details drawer which allows you create a new add-on through a three-step flow that immediately reflects the new add-on in the expanded subscription row. These steps include Details, Services, and Rate Schedule.

The Subscription Details drawer also includes a new Surcharges section that lists all surcharges on the selected subscription. Selecting a Surcharge ID opens a details drawer showing key details and the selected rate schedule.

To access these new improvements, navigate to Accounts > Subscriptions > Details >, open the Subscription Details drawer, or expand a subscription to view the Add-on Details drawer.

Note: In CCP the Tax Group displayed is the Tax Group code. Additionally, only the selected Rate Schedule is shown at this time. Support for updating rate schedules for surcharges will be addressed in a future release.


Business Network (BN) Code Added for PayPal Smart Payments (DEV-12583)

For PayPal Smart Payments, Aria now sends a partner identifier code (called a BN code) on every API call to PayPal, identifying Aria as a certified PayPal partner for tracking, support, and compliance purposes. This applies to payment authorizations, captures, refunds, reversals, token creation, token retrieval, and order management. The partner identifier is now also included on all GET (data retrieval) requests to PayPal, which previously had no partner identification attached.


Billie and Billie Connect (DEV-12626)

This release of Billie and Billie Connect focuses on introducing Slash Command capabilities for contract cancellation and a client-level configurator for managing slash command visibility. This release also delivers full CSR Activity Logging across all skill domains, a new Billie Connect API skill for contact updates, and enhancements to Bill Shock event handling with credit recommendations for pending invoices. Alongside these features, R71 includes tech debt cleanup, and several critical bug fixes addressing calculation accuracy, multilingual response quality, and conversation context handling.

Slash Commands for Contract Cancellation

Billie Conversational User Interface (CUI) supports four slash commands for canceling contracts and universal contracts. You can invoke these commands from the slash menu by typing a forward slash (/) in the Billie CUI input field.

The following commands are available:

  • /cancel_contract [Account No] [Contract No]Cancels the contract identified by Account No and Contract No.
  • /cancel_contract [Client Account ID] [Client Contract ID]Cancels the contract identified by Client Account ID and Client Contract ID.
  • /cancel_universal_contract [Account No]Cancels the universal contract associated with Account No.
  • /cancel_universal_contract [Client Account ID]Cancels the universal contract associated with Client Account ID.

When you select a command, Billie displays a summary of the identified contract. You then choose Cancel or Terminate and enter a comment to explain the reason for the action.

For instructions on canceling a contract, see Cancel a Contract.

Slash Menu Configurator

Administrators and Super Users can manage the visibility of slash commands for all users in their client instance using the Slash Menu option in the Billie CUI context menu.

To open the configurator, click the context menu icon in the Billie CUI header bar and select Slash Menu. The option is greyed out for users without Administrator or Super User roles.

The Slash Menu displays an alphabetical list of all slash commands. Each command can be toggled between the following states:

  • VisibleThe command is available to users based on their role permissions.
  • HiddenThe command is not displayed to users.

You can filter the list by typing ahead in the search field to locate commands quickly.

Billie Connect: Update Contact Information

Billie Connect supports updating contact addresses and other contact details for a specified contact on an account. When you call Billie Connect with an utterance that identifies the contact, account, and updated details, Billie Connect updates only the fields you specify and retains all other contact information.

If the contact is not found, Billie Connect returns an error message. If the update fails, the system returns the standard API or UI error message.

BillShock: Service Credit and Cash Credit Recommendations for Pending Invoices

When BillShock identifies a pending invoice with unexpected charge variances, the system now includes service credit and cash credit recommendations alongside the BillShock event details. This allows CSRs to act on credit recommendations directly from the BillShock workflow without navigating to a separate screen.

CSR Activity Logging across All Skill Domains

All legacy API calls triggered by Billie CUI, Billie Connect, and Billie Connect A2A now include the <alt_caller_id> field. This field identifies the originating Billie component and improves traceability in Core Audit Logs.

CSR activity originating from these Billie components now appears under CSR Activity in Core Audit Logs. The corresponding API call is also visible under Web Service API in Core Audit Logs.

Logging is active for the following skill domains: Account, Cash Credit and Service Credit, Invoice and Statement, Payment, and Subscription and Contract.

The <alt_caller_id> field follows these formats:

  • Billie CUI: First 30 characters of "BCUI-" followed by the logged-in <user_id>. Example: "BCUI-dgamage".
  • Billie Connect (v2, v3, or A2A): First 30 characters of "BC" followed by <version> and the trimmed service account name. Example: "BCv2-90123456.8901234-67890".

Service Credit Confirmation: Buttons Disabled after Confirmation

After a CSR confirms a service credit in Billie CUI, the Confirm Service Credit, Edit SC, and Edit Comment buttons are disabled. This prevents duplicate submissions if the CSR attempts to confirm again after the action has already been completed.

Improved Access Restriction Message

The message displayed when a user does not have permission to access a requested resource now reads: "Access to the requested resource is restricted. If you believe this is incorrect, please contact your organization's Aria Billing Cloud administrator."

A Reference ID may also appear in the message to help users provide a specific identifier when contacting their administrator.

Bug Fixes

Conversation History: Intent Classification Corrected

After Billie responds to a billing-related query in a session, subsequent non-billing queries are now correctly identified as outside Billie's supported topics. Billie returns a message indicating the request is not supported rather than misclassifying it to an incorrect skill category.

Subscription Total Calculation Corrected

Billie now correctly calculates the total of monthly subscription charges by applying the unit quantity to the applicable rate card. Previously, the calculation did not account for the number of units, resulting in an incorrect total.


Application Fixes 

  • Aria now saves custom rates on a recurring service that shares a plan instance with an Allegro-rated usage service. Previously, Aria threw the error "Every 'From Unit' must contain a valid number greater than zero" when saving, because the system incorrectly validated the missing rate fields for the Allegro-rated usage service—which does not use those fields. (TICKET-19984)
  • You can now save plans with more than 10 rate schedules (including configuring "any units" on an NSO) without resulting in an error. Aria has updated validation logic to only check rate schedules that are actually included in the save request and handle missing ones appropriately to prevent a misleading currency mismatch error.  (TICKET-19921)

API Features 

Payment Plans—Phase 6 (DEV-12220)

Aria delivers Phase 6 of the Payment Plans (Promise to Pay) feature, continuing to expand and refine the payment plan lifecycle management introduced in earlier phases. This phase builds on Phase 5’s parent pay support and expanded modification use cases in the following APIs:

Note: View the application writeup for this ticket.

New Payment Plan Fields in get_acct_trans_history_m

The get_acct_trans_history_m API now returns four additional output fields within the <history> array. These fields provide payment plan context for each account transaction.

New Output Field Data Type Description
<transaction_remaining_amount> Float The remaining balance on the transaction after payments are applied.
<client_payment_plan_id> String The client-assigned identifier of the payment plan associated with the transaction.
<payment_plan_no> String The Aria-assigned number of the payment plan associated with the transaction.
<payment_plan_status> String The status of the payment plan associated with the transaction. Allowable values: Active, Completed, Cancelled, Discontinued.

Note: If a transaction is associated with multiple payment plans, the API only returns the most recently associated payment plan.

New Payment Plan and Child Account Fields in get_payment_plan_details_m

The get_payment_plan_details_m API returns new output fields that support parent-pay payment plan scenarios. New header-level fields provide plan metadata, and new fields in the <payment_plan_seq_transaction_list> array identify the child account associated with each transaction.

New header-level output fields:

New Output Field Data Type Description
<payment_plan_create_date> Date The date the payment plan was created.
<payment_plan_name> String The name of the payment plan.
<payment_plan_description> String The description of the payment plan.
<client_billing_group_id> String The client-assigned identifier of the billing group associated with the payment plan.
<payment_plan_client_payment_method_id> String The client-assigned identifier of the payment method associated with the payment plan.
<payment_plan_status> String The current status of the payment plan.

New fields in the <payment_plan_seq_transaction_list> array:

New Array Field Data Type Description
<child_account_no> Long The Aria-assigned account number of the child account in a parent-pay payment plan.
<child_client_acct_id> String The client-assigned identifier of the child account in a parent-pay payment plan.

Aria updated the description of the <invoice_no> field to reflect that it supports invoices for both self-pay and parent-pay payment plan accounts.

Updates to update_payment_plan_m

The update_payment_plan_m API:

  • now supports two additional update scenarios when <update_scope> is set to 1 for independent payment plans:
    • You can update dates only without changing the due amount.
    • You can update the due amount only without changing the dates.
  • now returns the following validation error when you attempt to update <notify_date> or <due_date> on an aligned payment plan: notify_date and due_date cannot be updated for aligned payment plans.
  • supports additional input fields when <update_scope> is set to 2 (replace the existing payment plan with a new schedule). These fields allow you to define lump sum parameters and immediate collection behavior for the new schedule.
    New Field Data Type Description
    <new_client_payment_plan_id> String The client-assigned identifier for the new payment plan created when <update_scope> is set to 2.
    <new_payment_plan_lump_sum_type> String The lump sum type for the new payment plan. Allowable values: P (proportional), T (tax only).
    <new_payment_plan_lump_sum_amount> Float The lump sum amount for the new payment plan.
    <new_payment_plan_lump_sum_amount_type> String Specifies how the lump sum amount is calculated. Allowable values: P (percentage of invoice total), F (flat amount).
    <new_payment_plan_lump_sum_date> Date The due date for the lump sum payment on the new payment plan.
    <new_payment_plan_lump_sum_days_until_due> Integer The number of days from plan creation until the lump sum payment is due on the new payment plan.
    <do_collect> Boolean Specifies whether Aria attempts collection immediately when the new schedule is created. Set to true to collect immediately; set to false to defer collection. Default: false.
  • returns validation errors in the following scenarios:
    • If you provide fields in <update_specific_sequence_list> without providing <update_scope>, the API returns: "Missing fields: update_scope must be set when update_specific_sequence_list fields are provided."
    • If you provide fields for a new payment plan schedule without setting <update_scope> to 2, the API returns: "Missing fields: when fields for new payment plan schedule are provided, you need to specify update_scope as 2."
  • returns the following output fields with details about the collection attempt when you set <do_collect> to true
    New Output Field Data Type Description
    <payment_transaction_id> Integer The Aria-assigned identifier of the payment transaction.
    <collected_amount> Float The total amount collected during the transaction.
    <proc_cvv_response> String The Card Verification Value (CVV) response code returned by the payment processor.
    <proc_avs_response> String The Address Verification Service (AVS) response code returned by the payment processor.
    <proc_cavv_response> String The Cardholder Authentication Verification Value (CAVV) response code returned by the payment processor.
    <proc_status_code> String The status code returned by the payment processor.
    <proc_status_text> String The status message returned by the payment processor.
    <proc_payment_id> String The payment identifier assigned by the payment processor.
    <proc_auth_code> String The authorization code returned by the payment processor.
    <proc_merch_comments> String Merchant comments returned by the payment processor.
    <collection_error_code> Integer The error code returned if the collection attempt fails.
    <collection_error_msg> String The error message returned if the collection attempt fails.
    <collection_payment_method_no> Integer The Aria-assigned number of the payment method used in the collection attempt.

Updates to get_payment_plan_list_m

  • The get_payment_plan_list_m API now returns the correct <payment_plan_length> value after you update a payment plan using update_payment_plan_m. When an update changes due amounts and triggers a recalculation of the plan length, the updated length is reflected in subsequent calls to get_payment_plan_list_m.
  • When you replace a payment plan using <update_scope> set to 2, the get_payment_plan_list_m API now returns the correct <client_payment_method_id> value for the discontinued plan. The discontinued plan retains the payment method identifier that was originally assigned (or null if none was set). The new plan reflects the updated payment method value.

Lump Sum Type Validation in create_payment_plan_m

The create_payment_plan_m API now returns error code 32006 when you submit lump sum fields without also providing <payment_plan_lump_sum_type>. The error message lists all conflicting fields submitted without the required type field. This validation also applies when using the installment variant of the API.

New Payment Plan Fields in get_acct_statement_all_m

The get_acct_statement_all_m API returns a new output field and a new output array that provide payment plan information at the statement level.

New top-level output field:

New Field Data Type Description
<statement_payment_plan_due> Float The total amount due from payment plan sequences included on the statement.

New <payment_plan_on_statement_details> array:

New Field Data Type Description
<payment_plan_no> Integer The Aria-assigned number of the payment plan.
<client_payment_plan_id> String The client-assigned identifier of the payment plan.
<payment_plan_seq_no> Integer The sequence number of the payment plan installment included on the statement.
<payment_plan_seq_due_amount> Float The amount due for the payment plan sequence.
<payment_plan_seq_due_balance> Float The remaining balance due for the payment plan sequence.

The descriptions for the following existing output fields have been updated to reflect payment plan amounts where applicable: <balance_forward>, <statement_balance_forward>, <statement_total_due>, <invoice_due_amount>, and <invoice_amount>.

Sequence Message ID Display for Independent Lump Sum Sequences

The get_payment_plan_details_m and get_invoice_details_m APIs now return the <seq_message_id> field correctly for independent payment plan lump sum schedule sequences.



Add Multiple Prorated SPIs and NSOs on Non-Default Rate for update_acct_plan_multi_m (DEV-12433)

You can assign multiple supplemental plan instances (SPIs) and non subscription offering (NSO) items at a non-default rate alongside a master plan instance (MPI) assignment or replacement in a single update_acct_plan_multi_m API call. Aria generates a single invoice for the upsell, either immediately or on the next bill batch run.

To use this capability, include the new <mpi_orders> input array in your update_acct_plan_multi_m request alongside the existing <plan_updates> array. Each entry in <mpi_orders> links an order to the corresponding MPI and controls when Aria fulfills and bills it. Aria returns a summary of all orders created in the <mpi_orders_created> output array.

Use Cases and Caveats

This feature supports upsell scenarios where an account requires two or more SPIs plus one or more NSO items in a single transaction—for example, adding supplemental service plans together with associated offerings at a customized rate in one billable event.

  • The <mpi_orders> array must accompany a <plan_updates> entry. Use <master_plan_instance_no>, <client_master_plan_instance_id>, or <master_plan_instance_idx> to identify the MPI—provide exactly one.
  • Use <master_plan_instance_idx> when creating a new plan instance in the same call and no persistent instance number yet exists. The value maps to the corresponding <plan_instance_idx> in the <plan_updates> array.
  • If <order_bill_immediately> is null, billing timing is determined by the AUTO BILL ORDERS client parameter. Contact Customer Support to configure this parameter.
  • If <order_fulfill_date> is set to a past date and <order_bill_immediately> is 3 or 5, Aria fulfills the order immediately (equivalent to value 0). If the value is 4, Aria fulfills and bills immediately (equivalent to value 1).
  • <order_qualifier_list> and <order_line_items> are child arrays within <mpi_orders>.

New <mpi_orders> Input Array

New Field Data Type Description
<master_plan_instance_no> Long The unique identifier of the master plan instance. The value must also be present in the <plan_updates> array. Provide <master_plan_instance_no>, <client_master_plan_instance_id>, or <master_plan_instance_idx>.
<client_master_plan_instance_id> String The client-defined identifier of the master plan instance. Provide <master_plan_instance_no>, <client_master_plan_instance_id>, or <master_plan_instance_idx>.
<master_plan_instance_idx> Long A non-persistent reference that maps the order to a plan instance within the same API request by linking to the corresponding <plan_instance_idx> in the <plan_updates> array. Provide <master_plan_instance_no>, <client_master_plan_instance_id>, or <master_plan_instance_idx>.
<order_bill_immediately> Long

Determines when Aria fulfills and bills the order. If null, billing timing is determined by the AUTO BILL ORDERS client parameter. Contact Customer Support for more information.

Allowable Values

Values Description
0 Fulfill immediately; bill on the next anniversary.
1 Fulfill immediately; bill immediately.
2 Order Held; places the order in a pending billing state labeled Order Held. Update billing status using the update_order_m API or through the interface.
3 Fulfill on the fulfillment date; bill on the next anniversary after the fulfillment date. If the fulfillment date is in the past, Aria applies value 0 behavior.
4 Fulfill on the fulfillment date; bill on the fulfillment date. If the fulfillment date is in the past, Aria applies value 1 behavior.
5 Fulfill on the fulfillment date; bill on the next anniversary that bills arrears services through the fulfillment date. If the fulfillment date is in the past, Aria applies value 0 behavior.
<client_order_id> String The client-assigned identifier for the order.
<order_comments> String Comments for the order.
<order_po_num> String The purchase order number assigned to the one-time order.
<order_fulfill_date> String The date on which the order is fulfilled.
<order_qualifier_list> Array Qualifiers for the order.
<order_line_items> Array Line items for the order, including NSO items and applicable rates.

New <mpi_orders_created> Output Array

New Field Data Type Description
<master_plan_instance_no> Long The unique identifier of the master plan instance associated with the created order.
<client_master_plan_instance_id> String The client-defined identifier of the master plan instance associated with the created order.
<order_no> Long The unique identifier of the order in the context of the client and account.
<order_status_label> String The status label for the order.

New Error Codes

  • 3121—Only one order per MPI can be passed in mpi_orders array.
  • 3122—The <master_plan_instance_idx>, <master_plan_instance_no>, or <client_master_plan_instance_id> referenced in the <mpi_orders> array does not exist in the <plan_updates> array with plan directive 1 (assign) or 2 (replace).

API get_payment_unapplication_details_m Now Returns Voided Transactions (DEV-12472)

The get_payment_unapplication_details_m API has been updated to return voided transaction details when the input payment transaction ID is voided. The underlying query now determines if the input payment transaction ID is voided and then retrieves and returns the corresponding voided transaction details in the API output response.


Aligned Installment Estimated Due Date Fix for MPIs with Non-Billable SPIs (DEV-12493)

Aria now correctly calculates estimated due dates for aligned installments when a master plan instance (MPI) includes a supplemental plan instance (SPI) in a non-billable state. Previously, Aria incorrectly factored in the non-billable SPI's past next bill due date when calculating estimated installment due dates, resulting in inaccurate values returned by affected APIs and the batch process. The fix ensures that non-billable SPIs are excluded from the estimated due date calculation, so you receive accurate future dates. This correction applies to the get_acct_installment_m and get_invoice_details_m APIs, and the Estimate Installment Dates batch process.


DST Midnight Error Fix for Installment and Payment Plan APIs (DEV-12554)

Aria now correctly handles billing dates that fall on a Daylight Saving Time spring-forward midnight (for example, in time zones such as Chile and Lord Howe Island), preventing 1001 Unexpected Error from installment and payment plan APIs. Previously, when an aligned installment’s estimated notify or due date landed on a non-existent local midnight caused by a DST clock change, APIs returned an unexpected error, even though Aria did create the order and invoice. This fix applies to installment APIs (create_acct_complete_m, create_order_m, create_order_with_plan_m, get_acct_installment_m, update_acct_installment_m, get_invoice_details_m) and payment plan APIs (create_payment_plan_m, update_payment_plan_m, get_payment_plan_list_m, get_payment_plan_details_m), and the Estimate Installment Dates batch process.


API update_acct_plan_multi_m Enhancement – Introduce line_credit_amount in invoice_item_details (DEV-12605)

Aria now includes a new field, <line_credit_amount>, in the <invoice_item_details> array returned by the update_acct_plan_multi_m API. This field represents the total credit amount applied to each specific line item, including all credits associated with that invoice line. The <invoice_item_details> array is unique to update_acct_plan_multi_m, so this change does not affect other API responses. You can use this new field to see the full credit breakdown at the invoice line level when updating multiple account plans.


Enhanced create_acct_dunning_group_m API Response To Return Newly Created Dunning Group Information (DEV-12608)

Aria now returns two additional output parameters—<dunning_group_no> and <client_dunning_group_id>—in the response for the create_acct_dunning_group_m API, giving you the unique identifier and client-defined ID of the newly created dunning group without requiring a separate lookup. Previously, the API returned only an error or success status, leaving the caller without the ID of the record it had just created.

New Output Fields in the create_acct_dunning_group_m API

Field Data Type Description
<dunning_group_no> Long

The unique identifier of the dunning group.

<client_dunning_group_id> String

Client-defined unique identifier for the dunning group.


Surcharge API Update—Include <surcharge_rate_schedule_details> in get_acct_surcharges_m (DEV-12609)

Aria now includes a new <surcharge_rate_schedule_details> array in the response of the get_acct_surcharges_m API, giving you complete rate schedule information for each surcharge. The older <surcharge_rate> array has been deprecated as of this release. Aria also introduces the <assignment_level> field, which allows you to identify whether a surcharge is applied at the account, master plan instance, plan, payment method, or payment term level, resolving ambiguity when the same surcharge appears in multiple contexts. Related fields <master_plan_instance_no>, <plan_no>, <plan_name>, <pay_method_type>, <pay_method_name>, <payment_terms_no>, and <payment_terms_name> are populated based on the assignment level.

Note—Deprecation: The <surcharge_rate> array is deprecated as of this release. You should migrate integrations to <surcharge_rate_schedule_details>.

New Fields in the <all_surcharges> Array

Field Data Type Description
<assignment_level> Long

Identifies the level at which the surcharge is applied. 

The fields <master_plan_instance_no><plan_no><plan_name><pay_method_type><pay_method_type_name><payment_terms_no>, and <payment_terms_name> are populated based on this value. When <assignment_level> does not correspond to a given related field, that field returns null.

Allowable Values

Value Description
1 Account level
2 Master plan instance level
3 Plan level
4 Payment method level
5 Payment terms level

New <surcharge_rate_schedule_details> Array

The <surcharge_rate_schedule_details> array replaces the deprecated <surcharge_rate> array and returns complete rate schedule information for each surcharge.

Field Data Type Description
<schedule_no> Long The Aria-assigned unique identifier for the rate schedule.
<schedule_name> String The name of the rate schedule.
<include_zero> Long Indicates whether the rate schedule includes a zero tier.
<comments> String Comments associated with the surcharge rate schedule.

Fields within <surcharge_rate_schedule_rates>

Field Data Type Description
<rate_seq_no> Long The sequential number within the rate schedule, used to determine tier order.
<from_amount> Double The start value of the tiered range.
<to_amount> Double The end value of the tiered range.
<rate> Double The rate applied for the tiered amount.
<rate_tier_description> String The description for the rate tier.

Addition Of <line_credit_amount> In Response of Account Plan APIs (DEV-12610)

Aria now includes a new field, <line_credit_amount>, in the <acct_plan_line_items> array returned by these account plan APIs:

This field represents the total credit amount applied to each specific line item, including all credits associated with that line.

New Fields in the <acct_plan_line_items> Array

Field Data Type Description
<line_credit_amount> Long The total credit amount applied to that specific line item.


API Fixes

None


WSDL File Locations

Stage Current

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

Stage Future

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

Production

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

Object Query WSDL Files

Stage Current

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

Stage Future

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

Production

US https://secure.ariasystems.net/api/AriaQuery/wsdl/70/integration_services_m-doc_literal_wrapped.wsdl
EUR https://secure.prod.cph.ariasystems.net/api/AriaQuery/wsdl/70/integration_services_m-doc_literal_wrapped.wsdl
AUS https://secure.prod.aus.ariasystems.net/api/AriaQuery/wsdl/70/integration_services_m-doc_literal_wrapped.wsdl
TOP
  • Was this article helpful?