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



 

Home > Aria6 core api > get_acct_plans_all

get_acct_plans_all

Returns the plan, service, and rate schedule data for all master and supplemental plans assigned to a specified account.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
 

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
all_acct_plans hash  
plan_no long Aria-assigned unique plan identifier
plan_name string Plan Name
plan_desc string Text description of this plan
plan_date string Date on which the account was assigned to their current plan.
plan_units long Number of plan units the account is billed for.
queued_plan_units long Number of plan units the account is queued to change to on "units_change_date".
units_change_date string The date queued units are effective
last_bill_date string The date the account was last billed
next_bill_date string Date the account will be evaluated for invoicing, whether or not it results in any actual charges.
bill_thru_date string Date the accounts forward charges have been billed through.
bill_day long Day of month the account is billed on.
billing_interval long Number of months between billing cycles
billing_ind long Indicates whether or not this plan is billable  Allowable Values
display_ind long Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable.  Allowable Values
rollover_months long Number of months in which the account will change from the current plan to the pre-defined rollover plan.
rollover_plan_no long Pre-defined plan to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined rollover plan.
early_cancel_fee double Fee charged for early cancellations.
early_cancel_min_months long Number of months during which early cancellation fees would apply on plan cancellation.
suspension_period long Pre-defined period in days in which an account will degrade to Suspended status (-1) if action is not taken such as a plan or status change.
new_acct_status long The status of new accounts subscribing to this plan  Allowable Values
rollover_acct_status long Default status for new accounts created on this plan.  Allowable Values
rollover_acct_status_days long Number of days in which an account will change from the initial status code to the pre-defined rollover status code.
init_free_months long Initial free months.
plan_2_assign_on_susp long Plan to assign when an account on this plan is suspended.
default_notify_method long Default notification method given to an account that is assigned to this plan.  Allowable Values
prepaid_ind long Indicates whether or not this plan is prepaid  Allowable Values
currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
rate_schedule_no long Aria-assigned unique rate schedule number
rate_schedule_name string Name of the rate schedule
rate_sched_is_default_ind long Indicates whether or not the account is using the plans default rate schedule. 0 means the account is using an alternate rate schedule. 1 means the account is using the default rate schedule.  Allowable Values
supp_plan_ind long Indicates whether or not the plan is a supplemental plan. If it is "1", then the plan is a supplemental plan and if it is "0", then the plan is a master plan.  Allowable Values
supp_plan_status_cd long The status code of the supplemental plan associated with this account.  Allowable Values
supp_plan_status_label string The status code of the supplemental plan returned by the API method.  Allowable Values
supp_plan_status_date string The most recent date of the status change due to the supplemental plan
supp_plan_activate_date string The activation date of this supplemental plan
supp_plan_terminate_date string The termination date, if any, of this supplemental plan
client_receipt_id string Client-defined unique identifier used to track related system actions
client_plan_id string Client-defined Plan ID for which to query available child plans
client_rollover_plan_id string Pre-defined plan to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined client rollover plan ID.
client_plan_2_assign_on_susp string Client-defined Plan identifier to assign when an account on this plan is suspended.
client_rate_schedule_id string Client assigned unique rate schedule number
proration_invoice_timing_cd string Indicates whether to defer the pro-rated charges to the next anniversary date or to create a separate invoice immediately.  Allowable Values
 usage_accumulation_reset_months long for each plan specified, the number of months to accumulate before being reset.
usage_accumulation_reset_months_renewal_option long Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at the end of the current period.   Allowable Values
 usage_accumulation_reset_counter long Number of months since last reset. Once this value reaches the <usage_accumulation_reset_months> value, it will reset to 0 (zero).
plan_services hash A multidimensional array of Services for this plan
service_no long A multidimensional array of Services for this plan
service_desc string Description of this service
is_recurring_ind long Indicates whether or not this service is a recurring service  Allowable Values
is_usage_based_ind long Indicates whether or not this service is a usage based service  Allowable Values
usage_type long The usage type supported by this usage based service
taxable_ind long Indicates whether or not this service is taxable  Allowable Values
is_tax_ind long Indicates whether or not this service is a tax based service  Allowable Values
is_arrears_ind long Indicates whether or not this service is an arrears based service  Allowable Values
is_setup_ind long Indicates whether or not this service is a setup bases service  Allowable Values
is_misc_ind long Indicates whether or not this service is a miscellaneous service  Allowable Values
is_donation_ind long Indicates whether or not this service is a donation based service  Allowable Values
is_order_based_ind long Indicates whether or not this service is an order based service  Allowable Values
is_cancellation_ind long Indicates whether or not this service is a cancellation based service  Allowable Values
coa_id string Chart of accounts ID
ledger_code string This field is deprecated in favor of coa_id
client_coa_code string The client-defined override for coa_id
display_ind long Indicates if this service is displayable or not  Allowable Values
tiered_pricing_rule long The Tiered Pricing Rule  Allowable Values
is_min_fee_ind long Indicates whether or not this service is a minimum fee.  Allowable Values
client_service_id string A multidimensional array of client-defined Service ID for this plan.
usage_type_cd string An array containing usage_type_cd(s) to denote which usage type(s) to record.
all_service_supp_fields hash  
field_name string The machine-readable name of this field
field_desc string The human-readable name of this field
field_order_no long The sort order of this field
field_value string The value stored in this field
fulfillment_based_ind long Indicates if the service is Fulfillment Based or not.
plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
rate_seq_no long Sequential number in the rate schedule for dertermining tiers
from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
rate_per_unit double The cost per unit of this service over the time period the plan is billed for
future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
client_rate_schedule_id string Client assigned unique rate schedule number
rate_tier_description string Rate Tier Description
all_plan_service_rates hash All rates for all rate schedules and currencies for this plan
schedule_no long Rate schedule number
client_rate_schedule_id string Client assigned unique rate schedule number
future_rate long Indicates whether future rates are captured or not.  Allowable Values
future_change_date string Future Change Date of the rates.
followup_rs_no long Aria internal id of follow-up default rate schedule
client_followup_rs_id string Client defined id of followup rate schedule
plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
rate_seq_no long Sequential number in the rate schedule for dertermining tiers
from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
rate_per_unit double The cost per unit of this service over the time period the plan is billed for
future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
client_rate_schedule_id string Client assigned unique rate schedule number
rate_tier_description string Rate Tier Description
usage_type_name string The human-readable name of this usage type
usage_type_desc string The long description of this usage type
usage_type_code string Client-assigned identifier for the type of usage being recorded.
usage_unit_label string The display-level description of the units this usage represents.
apply_usage_rates_daily long Indicates whether or not this usage-based service is rated on a daily basis.  Allowable Values
surcharges_all hash A multidimensional array of Surcharges for this plan'
surcharge_no long Surcharge number for this plan
surcharge_name string Surcharge name for this plan
client_surcharge_id string Client-defined surcharge ID.
description string description for surcharge.
ext_description string External Description for surcharge.
surcharge_type string Surcharge type for the plan.
currency string Currency for this surcharge plan
tax_group string If taxable, the tax group this item belongs to
invoice_app_method string Invoice application method of this plan surcharge
rev_gl_code string Revenue Account GL Code for this plan surcharge
ar_gl_code string Accounts Recievable GL Code for this plan surcharge
surcharge_rate hash A multidimensional array of Surcharges Rate for this plan'
rate_seq_no long Aria-assigned unique rate sequence number
from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
rate_per_unit double This is the rate for the tiered units specified by from and to unit values above.
include_zero long This indicator indicates whether the rate schedule has includes zero or not.
rate_sched_is_assigned_ind long This indicator indicates the assigned rate schedule for the surcharge.
rate_tier_description string Rate Tier Description
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.