Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > User Documentation > Aria6 Release Notes > Aria6 API Release Notes > Aria API Release 6.31

Aria API Release 6.31

Release Date

Production

3/5/2015

Aria6 System Requirements

Supported Browsers  

  • Internet Explorer 9, 10, 11
  • Firefox 32
  • Chrome 38

Java Settings

Java 7.0​​

Screen Resolution

1024 x 768 or higher

Aria API Features  

Ability to Manage Plan Unit Instances and Delay Billing of a Service API Changes (DEV-4374/4310)

The following API changes have been implemented to support the new ability to delay the billing of a service, per DEV-4082 in Aria6 Release 6.31.

New get_acct_plan_unit_instance_all, modify_acct_plan_unit_instances, and update_acct_plan_unit_instances APIs

Three new APIs have been implemented to support the ability to delay the billing of a service:

  • get_acct_plan_unit_instance_all
  • modify_acct_plan_unit_instances
  • update_acct_plan_unit_instances

The new get_acct_plan_unit_instance_all API has been implemented to get all the plan unit instance details of all the plans under the specified account and the new modify_acct_plan_unit_instances API has been implemented to add the new plan units with the existing plan units or for removing plan unit instances. Additionally, the new update_acct_plan_unit_instances API has been implemented to edit plan unit instance fields and fulfillment dates for a particular plan unit instance.

New <fulfillment_based_ind> Parameter

A new <fulfillment_based_ind> output parameter has been added as an enhancement to the following Core APIs:

  • get_avail_child_plans_for_plan_all
  • get_available_plans_all
  • get_client_plans_all
  • get_plans_by_promo_code_all
  • get_supp_plans_by_promo_code_all
  • get_acct_plans_all
  • get_avail_child_plans_for_acct_all

Additionally, the new <fulfillment_based_ind> parameter has been added to the below Admintools APIs:

  • create_new_plan
  • edit_plan
  • get_plan_service_details

For the above Admintools APIs, this new input parameter has been added under the service array for the create_new_plan and edit_plan APIs and indicates if the service is “Fulfillment Based” or not. The possible input values are "0" or "1." The <fulfillment_based_ind> parameter cannot be passed for a non-recurring service.

The <fulfillment_based_ind> parameter also displays as a new output parameter on the get_plan_service_details API with the following information: Type = String, Max length = 1.

Ability to Bill in Arrears for Recurring Charges (DEV-4316/4375)

The create_service and edit_service APIs have been enhanced to support the new ability to bill in arrears for recurring charges, per DEV-4159 in Aria6 Release 6.31.

To support the new ability to bill in arrears for recurring charges, the following API changes have additionally been implemented:

  • assign_supp_plan and assign_supp_plan_multi APIs - proration charges will be billed with a plan's anniversary invoice.
  • replace_supp_plan and update_master_plan APIs - the old plan's recurring arrear charges will be billed immediately, the new plan recurring arrear charges will be billed with the plan's anniversary invoice, and the recurring arrear service credits will be created immediately.
  • modify_supp_plan and update_master_plan - the recurring arrear service credits will be created immediately. The recurring arrear charged will be billed with the anniversary invoice.
  • cancel_supp_plan - the old plan's recurring arrear charges will be billed immediately and the recurring arrear service credits will be created immediately.

New Description Field Added to Rate Tiers API Changes (DEV-4319)

A new Description field has been added to the rate tiers of plans and surcharges, per DEV-4165 within Aria6 Release 6.31. The following APIs have been modified to accept this new Description field at the rate tier level:

  • create_new_plan
  • edit_plan
  • create_surcharge
  • edit_surcharge
  • update_master_plan
  • assign_supp_plan
  • replace_supp_plan

In addition, the following APIs have been modified to return the new Description field at the rate tier level:

  • get_client_plan_service_rates
  • get_client_plans_all

Ability to Preview Next Scheduled Invoice when Invoice is Pending (DEV-4153)

The get_acct_preview_statement API has been enhanced to allow a preview statement to be generated if there is a pending invoice. The next scheduled invoice can be previewed in the statement results by passing the <client_no>, <auth_key>, and <acct_no> parameters in the get_acct_preview API.

New Parameters Added to get_all_invoice_information API (DEV-4378)

The get_all_invoice_information API has been enhanced to support querying on the company name and payment method fields to improve your workflow when querying invoices. This feature involves enhancing the get_all_invoice_information API to:

  • Support three new query strings:
    • bill_company_name: The company name of the billing contact for the invoice.
    • pay_method_type: Integer values for the Aria supported payment method types. Allowable values: -1, 0, 1-19 and 26
    • pay_method_name: Human readable names for the Aria supported payment method types. Allowable values: External Payment, Other/None, Credit Card, Electronic Check (ACH), Pre-Paid, Net Terms 30, Net Terms 0, 10, 15, 25, 35, 45, 60, 75, 90, and 120, Click&Buy, PayByCash, PayPal Express Checkout, Tokenized Credit Card, Purchase Power, Direct Debit
  • Return the following three fields in the output:
    • bill_company_name: Type = String, Max length = 100
    • pay_method_type: Type = Long, Max length = 8
    • pay_method_name: Type = String, Max length = 100

New <bank_acct_type> Input Parameter Added to APIs (DEV-4342)

A new <bank_acct_type> input parameter has been added to the below APIs:

  • update_payment_method
  • create_acct_complete
  • update_acct_complete
  • set_pay_method_bank_draft
  • settle_account_balance
  • collect_from_account
  • authorize_electronic_payment
  • create_order_with_plans
  • create_order
  • manage_pending_invoice

This new <bank_acct_type> parameter only accepts “savings,” “checking,” or “business” as inputs when the pay method is given as 2.

Admintools APIs Now Supports Recurring and Usage Billing Intervals Longer than 36 Months (DEV-4169)

The below Admintools APIs now allow more than 36 months in the <billing_interval> and <usage_billing_interval> parameters:

  • create_new_plan
  • edit_plan

Aria API Fixes   

  • Error Message Not Displaying when modify_supp_plan API Called on Account Plan with Activation Date as Today and No Change to Plan Units or Rate (TICKET-4852)
  • create_order_with_plans API Call Displaying "Invalid Coupon Code" Error through SOAP UI and Coupon Code Not Being Passing as an Input (TICKET-5960)
You must to post a comment.
Last modified
20:39, 20 Jul 2015

Tags

This page has no custom tags.

Classifications

This page has no classifications.