Home > Aria Crescendo Documentation > Aria API List
Aria API List
Aria API List
Table of contents
- Account Transaction Retrieval
- Account Transaction Creation
- Account Transaction Modification
- Account Modification
- Account Creation
- Account Communication Creation
- Account Data Retrieval
- Implementation Configuration Retrieval
- Account Communication Retrieval
- Implementation Configuration Modification
- Other / Special
- Account Unbilled Usage Summary Information
- TM Forum Open API
Aria provides a comprehensive suite of APIs, grouped into logical categories, based on their method. Click a method to view the detailed description of that method. For more information on Aria APIs, including endpoint URLs, refer to Aria APIs User Documentation.
Please see the Aria Developer’s Guide for key information needed to get started with Aria’s APIs and implement use cases with APIs.
Account Transaction Retrieval
- get_acct_service_outage_credit_m
- get_acct_writeoff_or_disputes_m
- get_cm_details_m
- get_cm_list_m
- get_extended_transaction_info_m
- get_family_trans_history_m
- get_invoice_details_m
- get_invoices_to_writeoff_or_dispute_m
- get_order_m
- get_payment_application_dtls_m
- get_payment_applications_m
- get_payments_on_invoice_m
- get_paypal_avs_status_m
- get_pending_invoice_no_m
- get_refund_details_m
- get_refundable_payments_m
- get_reversible_authorizations_m
- get_reversible_invs_by_payment_m
- get_supp_plans_by_promo_code_all_m
- get_unapplied_credits_payments_m
- get_unapplied_payments_m
- get_unapplied_service_credits_m
- get_writeoff_details_m
- issue_refund_to_acct_m
- reverse_authorized_electronic_payment_m
- update_refund_check_no_m
- validate_acct_fraud_scoring_m
- validate_payment_information_m
Account Transaction Creation
- authorize_3dsecure_m
- authorize_electronic_payment_m
- bulk_record_usage_m
- collect_from_account_m
- create_acct_billing_group_m
- create_acct_dunning_group_m
- create_cm_m
- create_order_m
- create_order_with_plan_m
- gen_invoice_m
- gen_rb_m
- init_paypal_bill_agreement_m
- manage_pending_invoice_m
- record_external_payment_m
- record_mandate_approval_m
- record_out_going_payment_m
- record_usage_m
- settle_account_balance_m
- settle_account_balance_bulk_m
- update_order_m
- void_credit_memo_m
- void_invoice_m
Account Transaction Modification
- apply_cash_credit_m
- apply_cm_m
- apply_coupon_to_acct_m
- apply_service_credit_m
- assign_custom_acct_plan_rates_m
- bulk_cancel_order_m
- calc_credit_reference_line_m
- cancel_acct_universal_contract_m
- cancel_instance_contract_m
- cancel_order_m
- cancel_queued_acct_plan_change_m (Deprecated)
- cancel_recurring_credits_m
- cancel_unapplied_service_credits_m
- cancel_unconsumed_credit_m
- create_advanced_service_credit_m
- create_writeoff_or_dispute_m
- discard_usage_m
- move_payment_m
- reinstate_transaction_m
- save_paypal_bill_agreement_m
- settle_dispute_hold_m
- transfer_account_balance_m
- unapply_cm_m
- update_acct_invoice_m
- void_transaction_m
Account Modification
- acct_plan_install_complete_m
- adjust_acct_plan_billing_dates_m
- assign_acct_plan_m
- assign_collections_acct_group_m
- assign_functional_acct_group_m
- ban_acct_m
- cancel_acct_plan_m
- copy_acct_payment_method_m
- create_acct_universal_contract_m
- create_instance_contract_m
- delete_acct_coupon_m
- delete_acct_data_m
- edit_acct_plan_queued_changes_m
- get_country_from_ip_m
- modify_acct_plan_unit_instances_m
- modify_acct_supp_fields_m
- modify_acct_universal_contract_m
- modify_instance_contract_m
- remove_acct_from_group_m
- remove_acct_payment_method_m
- remove_acct_plan_custom_rates_m
- replace_acct_plan_m
- send_acct_statement_email_m
- set_acct_notify_override_m
- set_acct_notify_tmplt_grp_m
- set_monetary_usg_threshold_m (Deprecated)
- set_payment_responsibility_m
- update_acct_billing_group_m
- update_acct_complete_m
- update_acct_credentials_m
- update_acct_dunning_group_m
- update_acct_notify_method_m
- update_acct_plan_multi_m
- update_acct_plan_unit_instance_m
- update_acct_status_m
- update_acct_supp_fields_m (Deprecated)
- update_contact_m
- update_payment_method_m
Account Creation
Account Communication Creation
Account Data Retrieval
- compare_against_cc_blacklist_m
- get_acct_balance_m
- get_acct_comments_m
- get_acct_contacts_m
- get_acct_credits_m
- get_acct_details_all_m
- get_acct_dunning_group_details_m
- get_acct_groups_by_acct_m
- get_acct_hierarchy_details_m
- get_acct_no_from_user_id_m
- get_acct_notification_details_m
- get_acct_notify_method_m
- get_acct_open_charges_m
- get_acct_payment_history_m
- get_acct_plan_balance_m
- get_acct_plan_queued_changes_m
- get_acct_plan_unit_instance_all_m
- get_acct_plans_all_m
- get_acct_plans_m
- get_acct_preview_next_bill_m
- get_acct_supp_fields_m
- get_acct_surcharges_m
- get_acct_trans_history_m
- get_acct_universal_contract_m
- get_acct_uuids_m
- get_accts_with_existing_pay_method_m
- get_all_acct_contracts_m
- get_aria_xml_statement_m
- get_avail_plans_for_acct_all_m
- get_avail_plans_for_acct_m
- get_cc_uuid_m
- get_cc_velocity_info_m
- get_child_accts_m
- get_credit_details_m
- get_instance_contract_m
- get_invoice_cm_details_m
- get_order_items_m
- get_pmt_uuid_m
- get_queued_acct_plans_m (Deprecated)
- get_recurring_credit_info_m
- get_supp_field_values_m
- get_unbilled_usage_summary_m
- get_usage_history_m
- get_usage_summary_by_type_m
- get_user_id_from_acct_no_m
- get_userid_has_ordered_sku_m
- update_cc_blacklist_m
- userid_exists_m
- userid_is_available_m
Implementation Configuration Retrieval
- clear_reg_uss_config_params_m
- clear_reg_uss_params_m
- client_has_event_class_m
- delete_reg_uss_config_params_m
- delete_reg_uss_params_m
- get_acct_billing_group_details_m
- get_acct_coupon_details_m
- get_acct_groups_by_client_m
- get_acct_payment_methods_and_terms_m
- get_acct_payment_methods_m (Deprecated)
- get_auf_status_m
- get_cash_credits_details_m
- get_catalog_hierarchy_m
- get_child_for_item_class_m
- get_client_countries_m
- get_client_currencies_m
- get_client_item_classes_m
- get_client_item_images_m
- get_client_item_prices_m
- get_client_item_supp_fields_m
- get_client_items_all_m
- get_client_items_basic_m
- get_client_plan_service_rates_m
- get_client_plan_services_m
- get_client_plans_all_m
- get_client_plans_basic_m
- get_credit_reason_codes_m (Deprecated)
- get_current_system_version_m
- get_daily_batch_status_m
- get_email_templates_m
- get_inv_no_from_bal_xfer_m
- get_items_by_class_m
- get_items_by_supp_field_m
- get_master_plans_by_supp_field_m
- get_parent_for_item_class_m
- get_plans_by_promo_code_all_m
- get_plans_by_promo_code_m
- get_rate_schedules_for_plan_m
- get_reg_uss_config_params_m
- get_reg_uss_params_m
- get_supp_plans_by_promo_code_m
- get_supp_plans_by_supp_field_m
- get_top_level_item_class_m
- get_virtual_datetime_m
- get_web_replacement_vals_m
- pre_calc_invoice_m (Deprecated)
- record_alternative_payment_m
- refresh_token_from_pmt_processor_m
- replace_reg_uss_config_params_m
- replace_reg_uss_params_m
- set_reg_uss_config_params_m
- set_reg_uss_params_m
- validate_session_m
Implementation Configuration Modification
- advance_virtual_datetime_m
- get_acct_nso_inclusion_list_m
- get_acct_tax_exempt_status_m
- get_client_items_m (Deprecated)
- keep_alive_m
- kill_session_m
- set_acct_tax_exempt_status_m
- set_prov_engine_m
- set_session_auth_m
- set_session_m
- subscribe_event_class_m
- subscribe_events_m
- unsubscribe_event_class_m
- unsubscribe_events_m
- update_acct_plan_m
- update_acct_plan_status_m
Account Unbilled Usage Summary Information
- set_monetary_usg_threshold_m (Deprecated)
- set_usg_mtd_ptd_bal_m
- set_usg_threshold_m (Deprecated)
- set_usage_threshold_m
- get_account_details_m
- get_account_plan_history_m
- get_account_status_history_m
- get_all_invoice_information_m
- get_coupon_history_m
- get_invoice_information_m
- get_invoice_summary_m
- get_order_details_m
- get_payment_details_m
- get_plan_instance_information_m
- get_refund_information_m
- get_transaction_information_m
- get_usage_history_information_m
- list_payment_methods_m
- list_payment_processors_m
- list_transaction_types_m
- add_coa_m
- add_rate_schedule_on_plan_m
- copy_plan_m
- create_channel_m
- create_coupon_m
- create_credit_template_m
- create_discount_bundle_m
- create_discount_rule_m
- create_inventory_item_m
- create_item_class_m
- create_legal_entity_m
- create_new_plan_m
- create_payment_terms_m
- create_plan_group_m
- create_product_field_category_m
- create_promo_plan_set_m
- create_promotion_m
- create_reason_code_m
- create_revrec_profile_m
- create_service_location_m
- create_service_m
- create_supp_field_m
- create_supp_obj_field_m
- create_surcharge_m
- create_usage_type_m
- delete_bundles_m
- delete_coupons_m
- delete_legal_entity_m
- delete_payment_terms_m
- delete_plan_group_m
- delete_plans_m
- delete_product_field_category_m
- delete_revrec_profile_m
- delete_rules_m
- delete_surcharge_m
- delete_templates_m
- edit_coa_m
- edit_item_class_m
- edit_plan_m
- edit_product_field_category_m
- edit_rate_schedule_on_plan_m
- edit_surcharge_m
- get_all_reason_codes_m
- get_client_payment_method_m
- get_coa_m
- get_company_profile_m
- get_coupon_details_m
- get_coupons_m
- get_discount_bundle_details_m
- get_discount_bundles_m
- get_discount_rule_details_m
- get_discount_rules_m
- get_dunning_processes_m
- get_gl_code_info_m
- get_inventory_item_details_m
- get_inventory_items_m
- get_legal_entity_m
- get_payment_terms_m
- get_plan_details_m
- get_plan_group_details_m
- get_plan_groups_m
- get_plan_service_details_m
- get_plans_m
- get_product_field_categories_m
- get_product_field_category_details_m
- get_promo_plan_set_details_m
- get_promo_plan_sets_m
- get_promotion_details_m
- get_promotions_m
- get_reason_code_m
- get_recurring_credit_template_details_m
- get_recurring_credit_templates_m
- get_revrec_profile_details_m
- get_revrec_profiles_m
- get_service_details_m
- get_service_types_m
- get_services_m
- get_supp_field_details_m
- get_supp_fields_m
- get_supp_obj_fields_m
- get_surcharge_details_m
- get_surcharges_m
- get_usage_type_details_m
- get_usage_types_m
- get_usage_unit_types_m
- list_coa_m
- list_promo_sets_m
- list_supp_obj_fields_m
- remove_gl_code_m
- set_company_profile_m
- set_gl_code_m
- update_coupon_m
- update_credit_template_m
- update_inventory_item_m
- update_legal_entity_m
- update_plan_group_m
- update_promo_plan_set_m
- update_promotion_m
- update_reason_code_m
- update_revrec_profile_m
- update_service_location_status_m
- update_service_m
- update_supp_field_m
- update_supp_obj_field_m
- update_usage_type_m
- validate_admin_session_m
TM Forum Open API
Aria has achieved Gold level conformance with the TM Forum Open APIs. The currently certified APIs are listed below, and others will be added to this page as they are certified.
Note: The precise functional behavior behind many of the TMF Open API specs requires a liberal amount of interpretation. The choices Aria has made in the initial conformance exercise may not align in the context of a specific implementation. Please contact Aria for more information regarding the use of these APIs.
For additional details on TM Forum Open APIs and (ODA) please read the related article.
Engagement Management
- None planned at this time
Party Management
- TMF632 Party Management API (Nov 2021)
- TMF629 Customer Management API (Nov 2021)
- TMF669 Party Role Management API (Jan 2022)
- TMF666 Account Management API (Nov 2021)
- TMF676 Payment Management API (Nov 2021)
- TMF678 Customer Bill Management API (Dec 2021)
Core Commerce Management
- TMF620 Product Catalog Management API (Dec 2021)
- TMF622 Product Ordering API (Nov 2021)
- TMF671 Promotion API (Jan 2022)
Production
- TMF641 Service Ordering Management API (Dec 2021)
- TMF635 Usage Management API (Nov 2021)
Intelligence Management
- None planned at this time
- © Copyright 2023 Aria Developer Central