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

 

Home > Aria Crescendo core api > get_acct_plans_all_m

get_acct_plans_all_m

Table of contents
  1. Input Arguments
  2. Allowable values for include_service_supp_fields
  3. Allowable values for include_product_fields
  4. Allowable values for include_plan_instance_fields
  5. Allowable values for include_plan_services
  6. Allowable values for include_surcharges
  7. Allowable values for include_rate_schedule
  8. Allowable values for include_contract_and_rollover_info
  9. Allowable values for include_dunning_info
  10. Output Arguments
  11. Allowable values for billing_ind
  12. Allowable values for display_ind
  13. Allowable values for initial_plan_status
  14. Allowable values for rollover_plan_status
  15. Allowable values for rollover_plan_status_uom_cd
  16. Allowable values for init_free_period_uom_cd
  17. Allowable values for rollover_plan_uom_cd
  18. Allowable values for initial_plan_status_cd
  19. Allowable values for rollover_plan_status_cd
  20. Allowable values for default_notify_method
  21. Allowable values for prepaid_ind
  22. Allowable values for rate_sched_is_default_ind
  23. Allowable values for supp_plan_ind
  24. Allowable values for plan_instance_status_cd
  25. Allowable values for plan_instance_status_label
  26. Allowable values for dunning_state
  27. Allowable values for proration_invoice_timing_cd
  28. Allowable values for is_recurring_ind
  29. Allowable values for is_usage_based_ind
  30. Allowable values for taxable_ind
  31. Allowable values for is_tax_ind
  32. Allowable values for is_arrears_ind
  33. Allowable values for is_setup_ind
  34. Allowable values for is_misc_ind
  35. Allowable values for is_donation_ind
  36. Allowable values for is_order_based_ind
  37. Allowable values for is_cancellation_ind
  38. Allowable values for display_ind
  39. Allowable values for tiered_pricing_rule
  40. Allowable values for is_min_fee_ind
  41. Allowable values for future_rate
  42. Allowable values for apply_usage_rates_daily
  43. Allowable values for is_recurring_ind
  44. Allowable values for is_usage_based_ind
  45. Allowable values for taxable_ind
  46. Allowable values for is_tax_ind
  47. Allowable values for is_arrears_ind
  48. Allowable values for is_setup_ind
  49. Allowable values for is_misc_ind
  50. Allowable values for is_donation_ind
  51. Allowable values for is_order_based_ind
  52. Allowable values for is_cancellation_ind
  53. Allowable values for display_ind
  54. Allowable values for tiered_pricing_rule
  55. Allowable values for is_min_fee_ind
  56. Allowable values for apply_usage_rates_daily
  57. Allowable values for invoice_app_method
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.
include_service_supp_fields string 5 Indicates whether to include the service supplemental fields array. If set to "true", will retrieve all of service supplemental fields If left blank, will default to "true".   Allowable Values
limit long 3 Limits the number of records returned in the all_acct_plans_m array. Min of 1 and Max 999. If no value specified, the default is 100.
offset long 3 The number of records to skip in the all_acct_plans_m array. Min of 0 and Max 998. If no value specified the default is 0.
include_product_fields string 5 Indicates whether to include the product fields array. If set to "true", will return the product fields array. If left blank, will default to "true".   Allowable Values
include_plan_instance_fields string 5 Indicates whether to include the plans instance fields array. If set to "true", will return array. If left blank, will default to "true".   Allowable Values
include_plan_services string 5 Indicates whether to include the plans services array. If set to "true", will return array. If left blank, will default to "true".   Allowable Values
include_surcharges string 5 Indicates whether to include the surcharges array. If set to "true", will return array. If left blank, will default to "true".   Allowable Values
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.
include_rate_schedule string If the include_rate_schedule parameter is set to True or left null, then all of the rate schedule information for each plan will be returned. If set to False, this information will be excluded from the response.   Allowable Values
include_contract_and_rollover_info string If the include_contract_and_rollover_info parameter is set to True or left null, then all of the contract and rollover information for each plan will be returned. If set to False, this information will be excluded from the response.   Allowable Values
include_dunning_info string If the include_dunning_info parameter is set to True or left null, then all of the dunning information for each plan will be returned. If set to False, this information will be excluded from the response.   Allowable Values
product_catalog_plan_filter array This array will support up to 10 individual inputs.
plan_no long The Aria-assigned unique plan identifier that will be used to filter the results for this API. If the plan instance doesn’t have this plan_no assigned, it will not be returned.
OR
client_plan_id string 100 The client-defined unique identifier for the plan that will be used to filter the results for this API. If the plan instance doesn’t have this plan name assigned, it will not be returned.
service_no_filter array This array will support up to 10 individual inputs.
service_no long 22 The Aria-assigned unique service identifier that will be used to filter the results for this API. If the plan instance doesn’t have this service_no assigned, it will not be returned.
OR
client_service_id string 100 The client-defined unique identifier for the service that will be used to filter the results for this API. If the plan instance doesn’t have the service with this description assigned, it will not be returned.
master_plan_instance_filter array This array will support up to 10 individual inputs.
master_plan_instance_no long The Aria-assigned unique identifier of the master plan that will be used to filter the results for this API. Results will only display for plans related to the master plan instance provided.
OR
client_master_plan_instance_id string The client-defined unique identifier of the master plan that will be used to filter the results for this API. Results will only display for plans related to the master plan instance provided.
supplemental_field_filter array This array will support up to 10 individual inputs.
supp_field_name string Name of the supplemental field associated with a plan that will be used to filter results.
supp_field_value string Value for the supplemental field listed above that will be used to filter results.
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.
record_count long Returns a total count of the number of records.
all_acct_plans_m hash
plan_no long Aria-assigned unique plan identifier
plan_name string Plan Name
plan_desc string Text description of this plan
plan_instance_no long Unique plan instance number for each assigned master plan.
client_plan_instance_id string Unique client-defined ID for each assigned master 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.
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 the month that the account is billed.
recurring_billing_interval long Number of months between billing cycles
usage_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 master plan cancellation. Not applicable to supplemental plans.
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.
initial_plan_status long Default status used when master plan is initially assigned on an account.   Allowable Values
rollover_plan_status long Status used for the master plan instance at the completion of the rollover period.   Allowable Values
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).
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
init_free_period_duration long Duration of the initial free period (used in conjunction with init_free_period_uom_cd).
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
rollover_plan_duration long Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd).
rollover_plan_uom_cd long Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration).   Allowable Values
initial_plan_status_cd long Default status used when master plan is initially assigned on an account.   Allowable Values
rollover_plan_status_cd long Status used for the master plan instance at the completion of the plan status rollover period.   Allowable Values
billing_group_no long The billing group number.
client_billing_group_id string Client-defined billing group ID.
dunning_group_no long Dunning group number
client_dunning_group_id string Client-defined unique identifier for dunning group
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
plan_instance_status_cd long Current status code of the plan instance.   Allowable Values
plan_instance_status_label string Current status of the plan instance.   Allowable Values
plan_instance_status_date string Most recent date on which the status of the plan instance changed.
dunning_state long Dunning state assigned to the master plan instance. In Progress indicates the master plan is in dunning. None indicates the master plan is not in dunning. Note that dunning state is applicable only for master plans and is set to Complete by the system once the dunning process is completed.   Allowable Values
dunning_step long Current dunning step of the plan instance (applicable only for master plans currently in dunning).
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).
plan_assignment_date string The date on which the current plan was assigned on this plan instance.
plan_deprovisioned_date string The date on which the current plan on this plan instance was suspended, cancelled or terminated.
client_receipt_id string The API receipt ID used while creating this plan instance.
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 CDID of the plan to be assigned 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 seperate invoice immediately.   Allowable Values
product_fields hash
field_name string Name of the product field associated with the plan in the product catalog.
field_value string Value associated with the product field as defined in the product catalog.
plan_instance_fields_detail hash
field_name string Name of the plan instance field
field_value string Value associated with the plan instance field
master_plan_instance_no long Master plan instance number for each supplemental plan.
client_master_plan_instance_id string Client master plan instance ID for each supplemental plan.
parent_plan_instance_no long Parent plan instance number to identify each supplemental plan and child supplemental plan heirarchy.
client_parent_plan_instance_id string Client parent plan instance ID to identify each supplemental plan and child supplemental plan heirarchy.
plan_services hash Deprecated A multidimensional array of Services for this plan
service_no long The 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-based 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 The client-defined Service ID for this plan.
usage_type_cd string Denotes which usage type 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.
svc_location_no long The Aria-assigned unique identifier for the origin location for the service.
client_svc_location_id string The client-defined location identifier for the origin location for the service.
svc_location_name string The name of the origin location for the service.
svc_location_company_name string Company name of the service location.
svc_location_address1 string First address line of the service location.
svc_location_address2 string Second address line of the service location. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
svc_location_address3 string Third address line of the service location.
svc_location_city string City of the service location.
svc_location_locality string Locality of the service location.
svc_location_state_prov string State or Province of the service location. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
svc_location_country string Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase.
svc_location_postal_cd string Postal/Zip code for the service location address.
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
plan_instance_services hash A multidimensional array of Services for this plan
service_no long The 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 The client-defined Service ID for this plan.
usage_type_cd string Denotes which usage type 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
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
svc_location_no long The Aria-assigned unique identifier for the origin location for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
client_svc_location_id string The client-defined unique identifier for the origin location for the service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
svc_location_name string The name of the origin location for the service.
svc_location_company_name string Company name of the service location.
svc_location_address1 string First address line of the service location.
svc_location_address2 string Second address line of the service location. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
svc_location_address3 string Third address line of the service location.
svc_location_city string City of the service location.
svc_location_locality string Locality of the service location.
svc_location_state_prov string State or Province of the service location. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
svc_location_country string Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase.
svc_location_postal_cd string Postal/Zip code for the service location address.
dest_contact_no long The Aria-assigned unique identifier for the destination contact for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
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   Allowable Values
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
contract_rollover_plan_no long Pre-defined plan to be used as the rollover plan at the completion of the contract.
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.
contract_rollover_rate_sched_no long Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
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
po_num string Purchase order number assigned to the plan instance.
available_from_dt string Start date of assigned rate schedule
available_to_dt string End date of assigned rate schedule
followup_rs_no long Aria internal ID of follow-up default rate schedule for the assigned rate schedule
client_followup_rs_id string Client-defined ID of followup rate schedule for the assigned rate schedule
acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.