Release 74
- Last updated
- Save as PDF
Note: This is a draft version of the release notes for Aria Billing Cloud—Version 74, 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
06-October-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 74 Contents
- Application Features
- Configure Credit Profile Alerts and Notifications in Allegro (AL-850)
- Allegro Grids Now Reset to Default Column Settings Automatically (AL-1124)
- View Cached Configuration Data with the Allegro Cache Inspector (AL-1127)
- Configure Allegro Customer Attribute Pricing by Address (AL-1130)
- New Allegro Permissions for Recently Added Actions (AL-1135)
- Allegro Usage Gateway Now Accepts Compressed Usage Files (AL-1146)
- Allegro Usage File Uploads Now Support Special Characters in File Names (AL-1147)
- Upload Compressed Usage Files from the Allegro UI (AL-1181)
- Run Multiple Batch Schedules per Day with Secondary Batch Schedule Groups (DEV-10552)
- Handling Negative Balance Forward (18) Transaction In Invoice Voiding Process Of Parent Child Scenario (DEV-11689)
- Account Create Part 1 (DEV-12587)
- New Configuration Selection for CyberSource Legacy Integration (DEV-12703)
- Payment Plan Validation and Behavior Improvements (DEV-12716)
- Add Additional Levels NTG Support to Separate XML Masterfiles (DEV-12725)
- Core MCP Server Enhancements Phase (DEV-12742)
- Additional Bug Fixes And Improvements (DEV-12746)
- Subscription Details (Plan Instance) Part 12 (DEV-12751)
- Multi-Select Buyer and Seller Numbers Now Supported for OneSource Smart Tax (DEV-12761)
- Prorated Charges Now Carry Over to Regenerated Invoices (DEV-12769)
- Billie and Billie Connect version 1.74.0 (DEV-12771)
- Application Fixes
- API Features
- New Allegro REST Endpoints for Price Offers and Subscriptions (AL-1151)
- Allegro PUT Balance Unit Endpoint Now Restricted to Credit Profile Updates (AL-1154)
- New Tax Fields Added to the Allegro Billable Service and Price Offer APIs (AL-1194)
- Handling Negative Balance Forward (18) Transaction In Invoice Voiding Process Of Parent Child Scenario (DEV-11689)
- Send Account Notification Emails with the New Create Account Message API (DEV-12683)
- All-Line Rebill Now Supports New Charges, Discounts, and Service Credits (DEV-12711)
- Two New APIs Added for Aria Internal e-invoicing—Phase 2 (DEV-12719)
- Added Details to get_acct_statement_all_m API (DEV-12780)
- API Fixes
- WSDL File Locations
Application Features
Configure Credit Profile Alerts and Notifications in Allegro (AL-850)
Allegro adds an end-to-end alerting framework that notifies your customers when their account activity crosses a configured threshold.
Configure notification email templates, notification template groups, and credit profiles that define currency, allowance, and accumulator thresholds for each customer. When usage rating detects that a customer has reached or exceeded a threshold, such as an exhausted prepaid credit balance, a completed credit top-up, or an allowance or accumulator threshold, Allegro sends the corresponding notification to the customer through core Aria.
Use the new Allegro user interface (UI) screens to create and manage credit profiles, and view the credit profile associated with an account in the Account view and the Usage Billing Data view.
Allegro Grids Now Reset to Default Column Settings Automatically (AL-1124)
Allegro grids now reset to their default column settings automatically when you have not saved a custom column template. Previously, Allegro did not apply a consistent default when no saved template existed. This change applies the default template consistently across your users, deployments, and screens.
View Cached Configuration Data with the Allegro Cache Inspector (AL-1127)
Allegro adds a Cache Inspector screen, available from Operations > Cache Inspector, that lets you view the data currently stored in cache memory. Use this tool to review cached configuration data, primarily related to the usage rating flow. The Cache Inspector helps you diagnose issues that involve cached data.
Configure Allegro Customer Attribute Pricing by Address (AL-1130)
You can now configure customer attribute pricing based on your customers' addresses. Allegro adds support for City, State, Country, and Postal Code as pricing attributes, so you can apply pricing that varies by geography.
Configure this option at the client level, and select the Address attribute from the dropdown on the price offer. This lets you apply region-specific pricing, account for delivery costs, and segment your customers by location.
New Allegro Permissions for Recently Added Actions (AL-1135)
Allegro adds new permissions that you can assign to control access to several recently added actions and configuration screens.
- Back-out actions (undo billing and undo usage)
- Force delete
- Reset file mapping
- Field masking
- Custom attributes
- Mediation reprocess
- Credit profile
- Notification template and notification template group configuration
Assign these permissions to control which of your users can access each action or screen.
Allegro Usage Gateway Now Accepts Compressed Usage Files (AL-1146)
Allegro's usage gateway now accepts compressed usage files in .zip, .tar.gz, .tgz, and .gz formats, in addition to standard text files. When you upload a compressed file, Allegro automatically extracts and processes each file inside it, and reports processing statistics for each extracted file individually rather than for the compressed archive as a whole.
Allegro retains the original compressed file in its Amazon S3 storage folder and moves it through the standard input, in-progress, and processed stages.
Allegro Usage File Uploads Now Support Special Characters in File Names (AL-1147)
Allegro's usage file upload process now supports file names that contain special characters, such as plus signs, spaces, parentheses, square brackets, and exclamation points. Previously, some of these characters caused Allegro to reject valid usage files submitted through the Amazon S3 upload folder. Allegro now correctly restores these characters after upload, so the corresponding files upload and process without error.
Note: File names that contain characters such as hash signs #, ampersands &, or backslashes \ are not supported.
Upload Compressed Usage Files from the Allegro UI (AL-1181)
You can now upload compressed usage files directly from the Allegro UI Usage Data upload screen, in addition to standard text files. Previously, the UI rejected compressed files and displayed an error message stating that the file must be a valid UTF-8 text file.
The upload screen also includes a Quick Notes section that explains the following:
- Allegro does not display a content preview for compressed files.
- Processing statistics reflect the individual files extracted after decompression.
- Allegro retains the original compressed file in Amazon S3 through the standard processing stages.
Run Multiple Batch Schedules per Day with Secondary Batch Schedule Groups (DEV-10552)
Secondary batch schedule groups let you run more than one billing batch schedule per day, so different groups of accounts can be invoiced, billed, and dunned at a time that matches their own time zone or region, instead of every account sharing one nightly run. Each group's invoices, statements, dunning notices, and reminders process independently, so one group's run never affects another group's accounts.
Use the new Batch Schedules page to view, create, and delete secondary schedules, assign a schedule to an account group, and turn individual sub-jobs on, off, or suspended. If invoice generation fails for any records, or Aria finds leftover records from a previous run, Aria sends a detailed notification email so your support team can investigate quickly. Batch activity logs and audit trails also show which schedule produced each run, making it easier to trace results back to the correct group.
Handling Negative Balance Forward (18) Transaction In Invoice Voiding Process Of Parent Child Scenario (DEV-11689)
The handling of negative balance forward transactions in parent/child account relationships has been adjusted. When a negative balance forward is created on a child account, it is now applied to that child account's own outstanding charges first. Then the remaining balance is transferred up to the parent account. Previously, the entire negative balance forward amount was transferred directly to the parent without first being applied against the child's charges, which could leave child-level charges outstanding when they should have been offset.
Account Create Part 1 (DEV-12587)
Advancements in the new CCP Account Creation wizard now add backend support and continue replacing placeholder UI data with live data:
- New REST resources:
- Locales — returns a client's effective locale configuration, combining global system defaults with any client-specific overrides, so the wizard can present the correct locale options for that client.
- Legal-Entities — returns the legal entities configured for a client, for use in entity-selection fields during account creation.
- UI progress: Continued expansion of populating the menus on Step 1 of the Account Creation form with live data pulled from these (and other) resources, as well as replacing the hardcoded placeholder values that were put in place during earlier development.
New Configuration Selection for CyberSource Legacy Integration (DEV-12703)
Aria has added a new configuration selection to its legacy integration with CyberSource to streamline refund processing. When enabled, the Send Capture Request ID Only for Refunds selection ensures that only the Capture Request ID is sent when processing a Tokenized Credit Card refund. Previously, the Subscription ID was sent also when processing this type of refund; CyberSource rejected refunds that carried both identifiers. Turn this on if your CyberSource account has network tokens enabled, or refunds will fail. This selection can be found at the following location: Configuration > Payments > Payment Gateways/Collection Groups > Processing Options tab.
The following are Allowable Options for this selection:
- Use Payment Gateway Setting (for Collection Group)
- False (default—current behavior)
- True
Payment Plan Validation and Behavior Improvements (DEV-12716)
This release closes a set of gaps in Aria's payment plan and installment framework, tightening validation and correcting edge case behavior.
- Aria now rejects a lump sum amount that exceeds the invoice total.
- Aria now rejects an update that would remove a required aligned plan instance.
- Aria now rejects a lump sum sequence change attempted through an unsupported update path.
- Aria now prevents a payment plan from using its own payment method when the associated billing group is on payment terms, because Billing Manager does not collect against net-term balances through that path.
- Aria now displays a clearer account comment when a payment plan cancellation triggers dunning.
Together, these changes make payment plans more consistent.
Add Additional Levels NTG Support to Separate XML Masterfiles (DEV-12725)
When generating daily XML master files (Batch Process 10), Aria now resolves the applicable Notification Template Group (NTG) using a priority order across the following three levels:
- Billing Group
- Account
- Client
Previously, only the Billing Group level was honored for this purpose; if no Billing Group-level NTG applied, the statement fell back into the common master file even if an Account or Client-level NTG existed. Now, all three levels are checked in order, and:
- Statements that resolve to the same NTG are grouped together into the same separate master file, regardless of which level (Billing Group, Account, or Client) supplied it.
- This priority resolution applies consistently across all four Batch 10 template classes: Statement, Credit Memo, Independent Payment Plan, and Independent Due Reminder.
- Documents that have no applicable NTG, or whose NTG is not configured to use a separate master file, continue to be included in the common master file exactly as before. This change does not affect that fallback behavior.
Core MCP Server Enhancements Phase (DEV-12742)
This is Phase 1 of a set of improvements to Aria's Core MCP server, aimed at strengthening the contract presented to AI/MCP clients so that errors are caught earlier and tool usage is clearer.
Note: This is an internal, MCP-server-side change only. The underlying Core API itself is not modified.
- Schema and validation improvements:
- Tool input schemas now correctly advertise which fields are required, including support for either/or identifier groups (e.g., "provide field A or field B").
- Calls missing required data are now rejected at the MCP layer itself, before ever reaching Aria's backend, reducing wasted round-trips and unclear downstream errors.
- Array- and object-typed parameters now generate proper nested JSON Schemas, instead of incorrectly falling back to plain string types.
- Validation error messages now explicitly name the actual missing or invalid field(s), rather than returning a generic error.
- Documentation and usability improvements:
- Every tool description now documents the
error_code/error_msgresponse contract, since Aria's API returns HTTP 200 even when a business-logic failure occurs which is an important detail that AI clients need to know to correctly detect failures. - Enum fields now include human-readable value labels alongside their raw values, making it easier for AI clients to present or reason about valid options.
- Every tool description now documents the
- Resources and prompts:
- MCP resources now expose 8 Knowledge Central guides, up from just 1 previously. These are cached hourly, with automatic fallback to the last-known-good content if a fetch fails.
- Nine new prompts have been added to help guide AI clients toward the correct tool for common lookups and for higher-risk write operations, including preview/confirm flows where the underlying tool supports them.
Additional Bug Fixes And Improvements (DEV-12746)
The following STARK/CCP fixes and improvements have been completed:
- A new "dunning-actions" REST resource exposing a subscription's dunning history.
- The Add New Subscription list now filters available plans by the account's currency.
- CCP now honors a client-level default setting for whether invoice line items are reversed on refunds.
- Quick Search results now display matching Account Field values as their own columns; for standard fields (e.g., Company Name, PO Number), every matching value is shown as an individual pill (a rounded UI element to be clicked on that displays additional values) rather than being truncated or merged.
- Newly created records now appear highlighted at the top of CCP grids immediately after creation, making them easier to locate.
- Added improved handling of partially-provisioned billing databases, preventing unnecessary query failures in that state.
- Credit Memo screens now display actual service names (with subscription/NSO tooltips) instead of generic labels.
- Corrected bug where "FDFO" payment application failed on the Make Payment screen.
- CCP search now also covers Invoice Number and Order Number, bringing its search coverage in line with Aria Billing core.
- Step 1 of a new 7-step Create Account wizard has been introduced.
- Bill Lag Days can now be edited inline directly from Subscription Details.
- The sort order shown in Quick Search's preview panel has been corrected.
- Added support for currency-scoped surcharge assignment.
- Also included is a fix for inaccurate "accessible" values returned for multi-client users via the
v1/clientsendpoint.
Subscription Details (Plan Instance) Part 12 (DEV-12751)
Several enhancements have been added to the Subscription Details view in the Customer Care Portal (CCP), focused on giving CSRs more direct control and visibility without leaving the page:
- Promo Code management: CSRs can now assign, change, or remove a subscription's Promo Code directly from a new drawer opened from Subscription Details. The drawer includes a "None" option specifically for clearing an existing code, so CSRs no longer need to route promo code changes through a separate workflow.
- Statement Contact drawer: A new drawer lets CSRs either select an existing account contact or create a new account contact to serve as the subscription's Statement Contact. From this drawer, CSRs can also view the payment methods associated with that contact and edit contact details inline — importantly, these edits apply only to this subscription's use of the contact and do not alter the shared contact record elsewhere on the account. Alongside this feature, a related bug has been fixed where saving an empty contact form could cause previously-entered details to persist and carry over incorrectly.
- Clickable balance fields: Both the Full Balance and Balance Due fields on Subscription Details are now clickable. Clicking Full Balance opens a drawer showing the subscription's complete transaction history, while clicking Balance Due filters that same view down to only the unpaid or past-due portion. Within the drawer, each transaction row links directly to its associated invoice and can be expanded to show exactly what the transaction was applied against.
Multi-Select Buyer and Seller Numbers Now Supported for OneSource Smart Tax (DEV-12761)
Aria adds support for multi-select Buyer and Seller Tax Registration Numbers used for tax reporting and invoicing for OneSource Smart Tax. Previously, you needed to enter these numbers as a comma-separated text string, which was an error prone and difficult-to-manage process. Now, you can enter new Seller Tax Registration Numbers and Buyer Tax Registration Numbers, select existing numbers, and edit/delete number from a list (Configuration > Integrations > Taxation Configuration > Configuration tab). Enter a maximum of 25 Buyer and 25 Seller Tax Registration Numbers (existing comma-separated text strings are supported). For Buyers, you can use a Supplemental Field Override for account-level values.
This matters because tax authorities in different countries or regions may require the correct registration numbers to be listed in order for taxes to be calculated correctly. If the wrong number is missing, you could be taxed incorrectly, which could cause billing errors or compliance headaches. Now, Aria can accommodate a single customer account that may need its own special tax number setup that's different from the company-wide default of a single number.
Prorated Charges Now Carry Over to Regenerated Invoices (DEV-12769)
Aria now carries deferred, prorated charges forward when it regenerates an invoice after you void the original invoice, so the charges are billed correctly on the regenerated invoice. Previously, a voided invoice's prorated recurring charges did not carry over to the newly generated invoice, and only the next period's regular advance charge appeared.
This ensures your customers receive a complete and accurate invoice for the billing period, reducing the need for manual corrections. The correction applies regardless of how the deferred charge was created, whether through a plan assignment, replacement, update, or cancellation.
Billie and Billie Connect version 1.74.0 (DEV-12771)
Billie and Billie Connect (version 1.74.0) have received the following updates:
- Structured data support: Converse and A2A API responses for dunning and projected-suspension-date queries now support structured data. External agents and integrating systems can request the response in TEXT, DATA, or BOTH modes, depending on whether they need a human-readable answer, machine-parseable data, or both together.
- Clearer dunning responses: Dunning responses now display the Client Plan Instance Id alongside the subscription name, helping CSRs distinguish between multiple subscriptions that happen to share the same plan name. Additionally, when only one subscription on an account is in dunning, the response now gives a clearer, more specific message reflecting that single-subscription case.
- Bill-Shock Slack agent fixes (Slack App 1.0): Several fixes were made to the Bill-Shock agent used with the new Slack App:
- Alert headers now show the correct client-facing account name.
- Alerts are now routed to the correct client-mapped Slack workspace.
- The default cash/service-credit cap used by the agent has been updated.
- Rendering is now cleaner in cases where no alternative plans are available to offer.
Application Fixes
None
API Features
New Allegro REST Endpoints for Price Offers and Subscriptions (AL-1151)
Allegro's API Gateway now exposes two new REST (Representational State Transfer) endpoints.
- Get Price Offer by price offer ID
- Get Subscriptions by balance unit ID
These endpoints give you REST access to data that was previously available only through GraphQL.
Allegro PUT Balance Unit Endpoint Now Restricted to Credit Profile Updates (AL-1154)
The PUT /balance/unit endpoint in Allegro's API Gateway now allows you to update only the credit profile ID field. Previously, this endpoint accepted additional fields, such as subscription ID, parent ID, and accumulator or allowance values, but silently ignored changes to some of these fields without returning an error.
Allegro also removes the masterPlanName field from balance unit API responses, because it never returned a value.
Note: Review any integration that sends other fields to this endpoint, and update it to send only the credit profile ID.
Altered fields
| Name | Direction | Change | Description |
|---|---|---|---|
| <Credit profile ID> | Input | Retained | The only field this endpoint now accepts on an update request. |
| <Subscription ID> | Input | No longer accepted | Previously accepted but silently ignored. Sending this field on an update request no longer has any effect. |
| <Parent ID> | Input | No longer accepted | Previously accepted but silently ignored. Sending this field on an update request no longer has any effect. |
| <Accumulator and allowance values> | Input | No longer accepted | Previously accepted but silently ignored. Sending these fields on an update request no longer has any effect. |
| <masterPlanName> | Output | Removed | Removed from balance unit API responses because it never returned a value. |
New Tax Fields Added to the Allegro Billable Service and Price Offer APIs (AL-1194)
Allegro's Billable Service and Price Offer APIs now expose the tax attributes added to support taxation.
- Billable Service API (create, modify, get, and search endpoints)
- Price Offer API (create, modify, and get endpoints)
The Billable Service create, modify, get, and search endpoints now include the <taxable> and <tax_service_group> fields. The Price Offer create, modify, and get endpoints now include the <tax_inclusive> field. Aria updated the Swagger documentation for both APIs to reflect these fields.
New fields
| Name | API | Description |
|---|---|---|
| <taxable> | Billable Service (create, modify, get, and search) | Indicates whether the billable service is taxable. |
| <tax_service_group> | Billable Service (create, modify, get, and search) | The tax service group assigned to the billable service. |
| <tax_inclusive> | Price Offer (create, modify, and get) | Indicates whether pricing on the price offer is tax-inclusive. |
Handling Negative Balance Forward (18) Transaction In Invoice Voiding Process Of Parent Child Scenario (DEV-11689)
The handling of negative balance forward transactions in parent/child account relationships has been adjusted. Voiding an invoice via the void_transaction_m API now correctly voids the associated negative balance forward (transaction type 18) in parent/child scenarios as well. Previously, this transaction type was not being unapplied when the related invoice was voided, leaving an inconsistent transaction state on the account even after the void completed.
Send Account Notification Emails with the New Create Account Message API (DEV-12683)
Aria has developed a new API method, create_acct_message_m, allowing third-party usage platforms to send account-level notification emails through Aria's existing communication framework.
Email Template Administration
Edit each notification template through the standard email template administration screen. The templates support four notification types: prepaid credit exhausted, prepaid credit top-up applied, usage allowance threshold reached, and usage accumulator threshold reached.
Create Account Message API
Use the create_acct_message_m API to send these notifications. Supply the usage details, such as resource names, amounts, and thresholds, in the request, so Aria does not need to calculate or store that usage data itself. Aria resolves the correct recipient and message template from the account, billing group, or plan instance you provide. This gives you a way to keep your customers informed about usage-based thresholds without building separate email infrastructure outside Aria.
All-Line Rebill Now Supports New Charges, Discounts, and Service Credits (DEV-12711)
This release adds a new <rb_new_lines> input array and associated fields to the gen_rb_m API method, supporting the all-line rebill feature introduced in Release 73. You can now edit any type of line item and add new line items to a rebill invoice that were not present on the original invoice. Supported new line types are recurring charges (including proration), surcharges, order-based charges, service credits, and discounts. You can also specify ship-from/to and bill-from/to addressing per new line for tax engine purposes to the associated account.
Enable All Invoice Lines Edit for Rebill Parameter
Enable the Enable All Invoice Lines Edit for Rebill client parameter to allow discount amounts, service credit amounts, and unit quantities, including decimal units, to be edited on a rebill. If you already rely on the existing rebill behavior, this parameter does not change your system behavior unless you turn it on.
With the parameter enabled, the gen_rb_m API accepts these additional line edits. Aria creates the new service credits and discounts using the same definitions as the originals, so the reissued invoice closely resembles the invoice it replaces.
New and altered fields
| Name | Direction | Type | Required | Description |
|---|---|---|---|---|
| <rb_new_lines> | Input | array | No | Array of new lines (not part of the original invoice) to add to the rebill invoice, such as a charge, credit or discount, order, or surcharge line. See the fields below. |
The <rb_new_lines> array includes the following fields:
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| <rb_new_line_seq_no> | long | 22 | Yes | Sequence number for the new line. The new line appears below the original invoice line being rebilled. |
| <rb_new_service_no> | long | 22 | No | Aria-assigned unique service number for the new line. Not applicable for order or surcharge lines. Alternative field: <rb_new_client_service_id> |
| <rb_new_client_service_id> | string | 100 | No | Client-defined unique service ID for the new line. Not applicable for order or surcharge lines. Alternative field: <rb_new_service_no> |
| <rb_new_amount> | double | Yes | Amount of the new line. For a credit or discount line, enter a negative value and provide either <rb_new_credit_reason_cd> or <rb_new_coupon_cd>. | |
| <rb_new_units> | double | No | Number of units for the new line. Units can be zero or greater than zero. | |
| <rb_new_rate_per_unit> | double | No | Rate per unit for the new line. Aria records this value; it is not part of any calculation. | |
| <rb_new_master_plan_instance_no> | long | 22 | No | Aria-assigned number identifying the master plan instance associated with the new line. Alternative field: <rb_new_client_master_plan_instance_id> |
| <rb_new_client_master_plan_instance_id> | string | 100 | No | Client-defined identifier for the master plan instance associated with the new line. Alternative field: <rb_new_master_plan_instance_no> |
| <rb_new_plan_instance_no> | long | 22 | No | Aria-assigned plan instance number for the new line. Required for recurring charge lines. Alternative field: <rb_new_client_plan_instance_id> |
| <rb_new_client_plan_instance_id> | string | 100 | No | Client-defined plan instance ID for the new line. Required for recurring charge lines. Alternative field: <rb_new_plan_instance_no> |
| <rb_new_po_num> | string | 100 | No | Purchase order number associated with the new line. Used for reference and reporting purposes. |
| <rb_new_start_date> | string | No | Start date for the new line, in yyyy-mm-dd format. Represents the beginning of the service period for the line. | |
| <rb_new_end_date> | string | No | End date for the new line, in yyyy-mm-dd format. Must not be earlier than <rb_new_start_date>. Represents the end of the service period for the line. | |
| <rb_new_credit_reason_cd> | long | 22 | No | Reason code for a service credit line. Required when <rb_new_amount> is negative and the line represents a service credit. Alternative field: <rb_new_coupon_cd> |
| <rb_new_credit_comments> | string | 300 | No | Comments associated with the service credit line. Provides additional context for the credit being applied. |
| <rb_new_coupon_cd> | string | 30 | No | Coupon code to apply to the new line as a discount. Required when <rb_new_amount> is negative and the line represents a discount. Alternative field: <rb_new_credit_reason_cd> |
| <rb_new_credit_or_discount_apply_new_line_seq_no> | long | 22 | No | The <rb_new_line_seq_no> of a new line to which this credit or discount should be applied. Alternative field: <rb_new_credit_or_discount_apply_existing_line_no> |
| <rb_new_credit_or_discount_apply_existing_line_no> | long | 22 | No | The line number of an existing original invoice line to which this credit or discount should be applied. Alternative field: <rb_new_credit_or_discount_apply_new_line_seq_no> |
| <rb_new_item_no> | long | 22 | No | Aria-assigned unique inventory item number for a new order line. Required for order lines. Alternative field: <rb_new_client_sku> |
| <rb_new_client_sku> | string | 100 | No | Client-defined SKU for the inventory item on a new order line. Required for order lines. Alternative field: <rb_new_item_no> |
| <rb_new_order_commentsv | string | 3000 | No | Comments associated with the order line item. Provides additional context visible on the order. |
| <rb_new_client_order_id> | string | 100 | No | Client-defined unique identifier for the order associated with the new line. Must be unique among active orders if the client parameter "Enforce Unique Client Order ID" is enabled. |
| <rb_new_line_comments> | string | 3000 | No | Explanatory text for the new line. Displayed as a comment on the invoice line. |
| <rb_new_surcharge_no> | long | 22 | No | Aria-assigned unique surcharge number for a new surcharge line. Required for surcharge lines. The surcharge must be assigned to the account, the specified master plan instance, or its plan. Alternative field: <rb_new_client_surcharge_id> |
| <rb_new_client_surcharge_id> | string | 100 | No | Client-defined unique surcharge identifier for a new surcharge line. Required for surcharge lines. The surcharge must be assigned to the account, the specified master plan instance, or its plan. Alternative field: <rb_new_surcharge_no> |
| <rb_new_bill_from_location_no> | long | 22 | No | Aria-assigned location number representing the Bill From address for the new line. Used by tax engines, such as Avalara, Vertex, or Sovos, to determine the origin address for tax calculation. Alternative field: <rb_new_bill_from_client_location_id> |
| <rb_new_bill_from_client_location_id> | string | 100 | No | Client-defined location ID representing the Bill From address for the new line. Used by tax engines to determine the origin address for tax calculation. Alternative field: <rb_new_bill_from_location_no> |
| <rb_new_bill_to_address_seq> | long | 22 | No | Sequence number of the Bill To address on the account to use for the new line. Used by tax engines to determine the destination billing address for tax calculation. |
| <rb_new_ship_from_location_no> | long | 22 | No | Aria-assigned location number representing the Ship From address for the new line. Used by tax engines to determine the shipping origin address for tax calculation. Alternative field: <rb_new_ship_from_client_location_id> |
| <rb_new_ship_from_client_location_id> | string | 100 | No | Client-defined location ID representing the Ship From address for the new line. Used by tax engines to determine the shipping origin address for tax calculation. Alternative field: <rb_new_ship_from_location_no> |
| <rb_new_ship_to_address_seq> | long | 22 | No | Sequence number of the Ship To address on the account to use for the new line. Used by tax engines to determine the shipping destination address for tax calculation. |
Two New APIs Added for Aria Internal e-invoicing—Phase 2 (DEV-12719)
Aria has added the following two APIs for the latest phase of Aria Internal e-invoicing:
- gen_einvoice_m—This API generates, sends, or resends the e-invoice document for a single invoice. This allows you to resend an e-invoice to your customer's email address in the event of an initial “send” failure. You can identify the invoice with the <invoice_no> or supply the <einvoice_seq_no> to act on a specific previously generated document for that invoice.
- get_einvoice_statement_m—This API returns the latest generated e-invoice XML for a given invoice, along with the statement's e-invoicing status, and, if the last attempt failed, its error code and message. You can identify the invoice by <invoice_no>
or supply the <einvoice_seq_no> to act on a specific previously generated document for that e-invoice document without re-deriving it from raw billing data
Added Details to get_acct_statement_all_m API (DEV-12780)
Aria enhanced the get_acct_statement_all_m API so client applications can retrieve more detail about parent-pay invoices.
When Aria transfers a customer's child account invoice balance to a parent account, the API now returns the transfer details, including the originating account, the invoice number, the transfer amount, and the plan instances involved. The API also returns a custom status label, a custom status description, and any client notes recorded against an invoice. This information helps you build more informative invoice views in customer relationship management systems and self-service portals. Retrieving these details is optional, so it does not affect existing integrations that do not request them.
New and altered fields
| Name | Direction | Type | Required | Description |
|---|---|---|---|---|
| <include_balance_transfer_details> | Input | long (1) | No | Determines whether the <balance_transfer_details> array is included in the return. Default is 0. |
| <custom_status_label> | Output | string | No | Client-specific custom invoice status. |
| <custom_status_desc> | Output | string | No | Description of the client-specific custom invoice status. |
| <client_notes> | Output | string | No | Free-text notes recorded against the invoice. |
| <balance_transfer_details> | Output | array | No | Invoice-related balance transfers (parent-pay), both inbound and outbound, associated with this statement. See the fields below. |
The <balance_transfer_details> array includes the following fields:
| Field | Type | Required | Description |
|---|---|---|---|
| <transfer_no> | long | No | Aria-assigned balance transfer number. |
| <transaction_type> | long | No | Aria-assigned identifier for the transaction type (balance transfer to account, voided balance transfer to account, balance transfer from account, or voided balance transfer from account). |
| <from_acct_no> | long | No | Account number the balance was transferred from. |
| <to_acct_no> | long | No | Account number the balance was transferred to. |
| <from_master_plan_instance_no> | long | No | Master plan instance number of the account the balance was transferred from. |
| <to_master_plan_instance_no> | long | No | Master plan instance number of the account the balance was transferred to. |
| <amount> | double | No | Amount of the balance transfer. |
| <invoice_no> | long | No | Invoice number associated with the balance transfer. |
| <invoice_date> | string | No | Date of the invoice associated with the balance transfer. |
API Fixes
None
WSDL File Locations
Stage Current
Stage Future
Production
Object Query WSDL Files
Stage Current
Stage Future
Production