Aria Billing Cloud API Concepts
Learn prerequisites for working with Aria's API, including how to format API calls and test use cases before starting to code.
- APIs That Generate Invoices
- This article serves as a quick-reference guide for developers integrating with Aria's billing platform. Among other uses, understanding this guide can help avoid unintentionally generating an invoice. It can also help you select API methods to use for managing your customers' full billing lifecycle. Several configurable Aria instance-wide parameters define when to attempt a collection against a customer account—important to consider, because collections occur after Aria creates invoices.
- API Index
- Here is a complete listing of the Core, Object Query, and Admintools APIs.
- API Live
- API Live allows you to execute APIs from within the Aria UI.
- Aria API Error Messages Unabridged List
- Below is a listing of all known API Error Codes.
- Aria API Glossary of Abbreviations (Core, AdminTools, ObjectQuery)
- This article is a comprehensive reference glossary that maps the abbreviated shorthand used in Aria's Core, AdminTools, and ObjectQuery API method and field names to their full English equivalents. For developers integrating with or building on the Aria Billing Cloud API, this glossary is an invaluable time-saver that eliminates guesswork when reading or writing API calls, reducing errors and speeding up development.
- Aria IP Ranges
- All third-party providers, including Aria client servers or tax/payment gateways, must have these outbound addresses whitelisted if the provider's feature is integrated with Aria. To whitelist these IP addresses for third-party providers, you must either use the administrative interface of that provider, or contact their Support team.
- Direct Post Handler and REST API Methods
- You make REST calls to Aria's API using the POST method, sent to a single base URL. Unlike SOAP, REST calls represent multidimensional input arrays as separate pipe-delimited, single-dimensional arrays.
- Forming JSON API Calls
- Aria Core and Object Query API calls accept well-formed JSON input that is compliant with Aria's API schema.
- Invoice-Related API Usage Guide
- This article lists all available invoice-related APIs and helps choose which one to use based on its purpose. These APIs include get_statement_for_invoice_m, get_invoice_cm_details_m, gen_invoice_m, manage_pending_invoice_m, void_invoice_m, update_acct_invoice_m, get_invoice_details_m, get_invoices_to_writeoff_or_dispute_m, get_payments_on_invoice_m, get_pending_invoice_no_m, get_invoices_to_writeoff_or_dispute_m, and get_payments_on_invoice_m.
- Making API Calls
- Each API request is authenticated using a combination of the <client_no> and <auth_key> parameters. In lieu of the <auth_key>, you can also use a client certificate for authentication.
- Payment Method References in Aria Core API Methods
- Aria Core API methods identify a payment method type with a numeric value, but different methods carry it under different field names. This article gives the full reference table for these values and lists where individual API methods use a different or restricted set.
- TM Forum Open APIs and Open Digital Architecture
- Aria, a member of TM Forum since 2020, has publicly committed to the TM Forum’s Open API & Open Digital Architecture (ODA) Manifesto in support of the telecommunication industry’s move to cloud-native monetization solutions.
- Web Service API Prerequisites
- To make API calls to Aria, you must whitelist the IP addresses from which you make API calls. If you make an API call from an IP address that is not whitelisted, you encounter an authentication error.