Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_plans_m

get_acct_plans_m

Returns the details of the master and supplemental plans assigned to a specified account.

For information on error messages generated by this API, see get_acct_plans_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
required-icon.png client_acct_id string 50 Client-defined account identifier.
  locale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
  OR      
  locale_name string 50 Name of the locale.
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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.
acct_plans_m hash  
brd_arrow.gif plan_no long Aria-assigned unique plan identifier
brd_arrow.gif plan_name string Plan Name
brd_arrow.gif plan_desc string Text description of this plan
brd_arrow.gif plan_instance_no long Unique plan instance number for each assigned master plan.
brd_arrow.gif client_plan_instance_id string Unique client-defined ID for each assigned master plan.
brd_arrow.gif plan_date string Date on which the account was assigned to their current plan.
brd_arrow.gif plan_units long Number of plan units the account is billed for.
brd_arrow.gif last_bill_date string The date the account was last billed
brd_arrow.gif next_bill_date string Date the account will be evaluated for invoicing, whether or not it results in any actual charges.
brd_arrow.gif bill_thru_date string Date the accounts forward charges have been billed through.
brd_arrow.gif bill_day long Day of the month that the account is billed.
brd_arrow.gif recurring_billing_interval long Number of months between billing cycles
brd_arrow.gif usage_billing_interval long Number of months between billing cycles
brd_arrow.gif billing_ind long Indicates whether or not this plan is billable   Allowable Values
brd_arrow.gif display_ind long Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable.   Allowable Values
brd_arrow.gif rollover_months long Number of months in which the account will change from the current plan to the pre-defined rollover plan.
brd_arrow.gif 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.
brd_arrow.gif early_cancel_fee double Fee charged for early cancellations.
brd_arrow.gif early_cancel_min_months long Number of months during which early cancellation fees would apply on plan cancellation.
brd_arrow.gif 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.
brd_arrow.gif initial_plan_status long Default status used when master plan is initially assigned on an account.   Allowable Values
brd_arrow.gif rollover_plan_status long Status used for the master plan instance at the completion of the rollover period.   Allowable Values
brd_arrow.gif rollover_plan_status_duration long Duration of the plan status rollover period, after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjuction with rollover_plan_status_uom_cd).
brd_arrow.gif rollover_plan_status_uom_cd long Units associated with the duration of the plan status rollover period after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status. (used in conjunction with rollover_plan_status_duration).   Allowable Values
brd_arrow.gif init_free_period_duration long Duration of the initial free period (used in conjunction with init_free_period_uom_cd).
brd_arrow.gif init_free_period_uom_cd long Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).   Allowable Values
brd_arrow.gif rollover_plan_duration long Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd).
brd_arrow.gif rollover_plan_uom_cd long Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration).   Allowable Values
brd_arrow.gif initial_plan_status_cd long Default status used when master plan is initially assigned on an account.   Allowable Values
brd_arrow.gif rollover_plan_status_cd long Status used for the master plan instance at the completion of the plan status rollover period.   Allowable Values
brd_arrow.gif plan_2_assign_on_susp long Plan to assign when an account on this plan is suspended.
brd_arrow.gif default_notify_method long Default notification method given to an account that is assigned to this plan.   Allowable Values
brd_arrow.gif prepaid_ind long Indicates whether or not this plan is prepaid   Allowable Values
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
brd_arrow.gif rate_schedule_no long Aria-assigned unique rate schedule number
brd_arrow.gif rate_schedule_name string Name of the rate schedule
brd_arrow.gif 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
brd_arrow.gif 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
brd_arrow.gif plan_instance_status_cd long Current status code of the plan instance.   Allowable Values
brd_arrow.gif plan_instance_status_label string Current status of the plan instance.   Allowable Values
brd_arrow.gif plan_instance_status_date string Most recent date on which the status of the plan instance changed.
brd_arrow.gif dunning_state long Current dunning state of the plan instance (applicable only for master plans).   Allowable Values
brd_arrow.gif dunning_step long Current dunning step of the plan instance (applicable only for master plans currently in dunning).
brd_arrow.gif dunning_degrade_date string Next future date on which the plan instance would advance to the next dunning step (applicable only for master plans currently in dunning).
brd_arrow.gif plan_assignment_date string The date on which the current plan was assigned on this plan instance.
brd_arrow.gif plan_deprovisioned_date string The date on which the current plan on this plan instance was suspended, cancelled or terminated.
brd_arrow.gif client_receipt_id string Client-defined unique identifier used to track related system actions
brd_arrow.gif client_plan_id string Client-defined Plan ID for which to query available child plans
brd_arrow.gif 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.
brd_arrow.gif client_plan_2_assign_on_susp string Client-defined Plan identifier to assign when an account on this plan is suspended.
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif proration_invoice_timing_cd string Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately.   Allowable Values
brd_arrow.gif master_plan_instance_no long Master plan instance number for each supplemental plan.
brd_arrow.gif client_master_plan_instance_id string Client master plan instance ID for each supplemental plan.
brd_arrow.gif parent_plan_instance_no long Parent plan instance number to identify each supplemental plan and child supplemental plan heirarchy.
brd_arrow.gif client_parent_plan_instance_id string Client parent plan instance ID to identify each supplemental plan and child supplemental plan heirarchy.
brd_arrow.gif contract_rollover_plan_no long Pre-defined plan to be used as the rollover plan at the completion of the contract.
brd_arrow.gif contract_rollover_client_plan_id string Client-defined ID of the pre-defined plan to be used as the rollover plan at the completion of a contract.
brd_arrow.gif contract_rollover_rate_sched_no long Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
brd_arrow.gif contract_rollover_client_rate_sched_id string Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
brd_arrow.gif po_num string Purchase order number assigned to the plan instance.
brd_arrow.gif available_from_dt string Start date of assigned rate schedule
brd_arrow.gif available_to_dt string End date of assigned rate schedule
brd_arrow.gif followup_rs_no long Aria internal ID of follow-up default rate schedule for the assigned rate schedule
brd_arrow.gif client_followup_rs_id string Client-defined ID of followup rate schedule for the assigned rate schedule
 brd_arrow.gif usage_accumulation_reset_months long The number of reset months for each plan.

 brd_arrow.gif 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
 brd_arrow.gif 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).
 brd_arrow.gif bill_lag_days long

Bill lag days refer to the number of days prior to (negative) or after (positive) an account billing date at which you specified that an invoice should be generated for a master plan instance. 

Examples:

  • -14 means that an invoice is generated 14 days before the billing date.
  • 10 means that an invoice is generated 10 days after the billing date.
acct_locale_no long Aria-assigned Locale identifier. This value is unique across all Aria-managed accounts. DEPRECATED
acct_locale_no_2 long Aria-assigned Locale identifier. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®