Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_plans_all_m

get_acct_plans_all_m

Table of contents
  1. Input Arguments
    1. Allowable values for include_service_supp_fields:
    2. Allowable values for include_product_fields:
    3. Allowable values for include_plan_instance_fields:
    4. Allowable values for include_plan_services:
    5. Allowable values for include_surcharges:
    6. Allowable values for include_rate_schedule:
    7. Allowable values for include_contract_and_rollover_info:
    8. Allowable values for include_dunning_info:
  2. Output Arguments
    1. Allowable values for billing_ind:
    2. Allowable values for display_ind:
    3. Allowable values for initial_plan_status:
    4. Allowable values for rollover_plan_status:
    5. Allowable values for rollover_plan_status_uom_cd:
    6. Allowable values for init_free_period_uom_cd:
    7. Allowable values for rollover_plan_uom_cd:
    8. Allowable values for initial_plan_status_cd:
    9. Allowable values for rollover_plan_status_cd:
    10. Allowable values for default_notify_method:
    11. Allowable values for prepaid_ind:
    12. Allowable values for rate_sched_is_default_ind:
    13. Allowable values for supp_plan_ind:
    14. Allowable values for plan_instance_status_cd:
    15. Allowable values for plan_instance_status_label:
    16. Allowable values for dunning_state:
    17. Allowable values for proration_invoice_timing_cd:
    18. Allowable values for is_recurring_ind:
    19. Allowable values for is_usage_based_ind:
    20. Allowable values for taxable_ind:
    21. Allowable values for is_tax_ind:
    22. Allowable values for is_arrears_ind:
    23. Allowable values for is_setup_ind:
    24. Allowable values for is_misc_ind:
    25. Allowable values for is_donation_ind:
    26. Allowable values for is_order_based_ind:
    27. Allowable values for is_cancellation_ind:
    28. Allowable values for display_ind:
    29. Allowable values for tiered_pricing_rule:
    30. Allowable values for is_min_fee_ind:
    31. Allowable values for future_rate:
    32. Allowable values for apply_usage_rates_daily:
    33. Allowable values for is_recurring_ind:
    34. Allowable values for is_usage_based_ind:
    35. Allowable values for taxable_ind:
    36. Allowable values for is_tax_ind:
    37. Allowable values for is_arrears_ind:
    38. Allowable values for is_setup_ind:
    39. Allowable values for is_misc_ind:
    40. Allowable values for is_donation_ind:
    41. Allowable values for is_order_based_ind:
    42. Allowable values for is_cancellation_ind:
    43. Allowable values for display_ind:
    44. Allowable values for tiered_pricing_rule:
    45. Allowable values for is_min_fee_ind:
    46. Allowable values for apply_usage_rates_daily:
    47. Allowable values for tax_inclusive_ind:
    48. Allowable values for invoice_app_method:
    49. Allowable values for usage_accumulation_reset_months_ renewal_option:
Returns the plan, service, and rate schedule data for all master and supplemental plans assigned to a specified account.  For information on error messages generated by this API, see get_acct_plans_all_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      
  client_acct_id string 50 Client-defined account identifier.
  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 for include_service_supp_fields:

Values Description
true true
false false
  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 is unlimited. 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 for include_product_fields:

Values Description
true true
false false
  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 for include_plan_instance_fields:

Values Description
true true
false false
  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 for include_plan_services:

Values Description
true true
false false
  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 for include_surcharges:

Values Description
true true
false false
  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 for include_rate_schedule:

Values Description
true true
false false
  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 for include_contract_and_rollover_info:

Values Description
true true
false false
  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 for include_dunning_info:

Values Description
true true
false false
Start of product_catalog_plan_filter array
  product_catalog_plan_filter array   This array will support up to 10 individual inputs.
  Field Name Field Type Max Length Description
  brd_arrow.gifplan_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      
  brd_arrow.gifclient_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.
End of product_catalog_plan_filter array
 
Start of service_no_filter array
  service_no_filter array   This array will support up to 10 individual inputs.
  brd_arrow.gifservice_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      
  brd_arrow.gifclient_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.
End of service_no_filter array
 
Start of master_plan_instance_filter array
  master_plan_instance_filter array   This array will support up to 10 individual inputs.
  Field Name Field Type Max Length Description
  brd_arrow.gifmaster_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      
  brd_arrow.gifclient_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.
End of master_plan_instance_filter array
 
Start of supplemental_field_filter array
  supplemental_field_filter array   This array will support up to 10 individual inputs.
  Field Name Field Type Max Length Description
  brd_arrow.gifsupp_field_name string   Name of the supplemental field associated with a plan that will be used to filter results.
  brd_arrow.gifsupp_field_value string   Value for the supplemental field listed above that will be used to filter results.
End of supplemental_field_filter array
 
  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.
Start of optional_transaction_qualifiers array
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  Field Name Field Type Max Length Description
  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.
End of optional_transaction_qualifiers array
 

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  
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 for billing_ind:

Values Description
0 0
1 1
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 for display_ind:

Values Description
0 Not displayable
1 displayable
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 master plan cancellation. Not applicable to supplemental plans.
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 for initial_plan_status:

Values Description
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
0 Inactive
-1 Suspended
-2 Cancelled
-3 Terminated
brd_arrow.gif rollover_plan_status long Status used for the master plan instance at the completion of the rollover period.  

Allowable values for rollover_plan_status:

Values Description
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
0 Inactive
-1 Suspended
-2 Cancelled
-3 Terminated
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 for rollover_plan_status_uom_cd:

Values Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
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 for init_free_period_uom_cd:

Values Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
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 for rollover_plan_uom_cd:

Values Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
brd_arrow.gif initial_plan_status_cd long Default status used when master plan is initially assigned on an account.  

Allowable values for initial_plan_status_cd:

Values Description
1 ACTIVE
41 ACTIVE TRIAL
61 ACTIVE NON-BILLABLE
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 for rollover_plan_status_cd:

Values Description
1 ACTIVE
41 ACTIVE TRIAL
61 ACTIVE NON-BILLABLE
brd_arrow.gif billing_group_no long The billing group number.
brd_arrow.gif client_billing_group_id string Client-defined billing group ID.
brd_arrow.gif dunning_group_no long Dunning group number
brd_arrow.gif client_dunning_group_id string Client-defined unique identifier for dunning group
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 for default_notify_method:

Values Description
0 None
1 HTML Email
2 Text Email
3 Text Email w/link to HTML
4 Data export
5 Printable (no Email) w/Surcharge
6 Printable & Text Email
7 Printable & HTML Email w/Surcharge
8 Printable (no Email)
9 PDF (Printing required, no Email)
10 PDF (delivered by Email)
11 PDF (Printing req & Email)w/surcharge
12 PDF (Printing req, no Email)w/surcharge
13 XML Master File
14 PDF Master File
brd_arrow.gif prepaid_ind long Indicates whether or not this plan is prepaid  

Allowable values for prepaid_ind:

Values Description
0 0
1 1
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 for rate_sched_is_default_ind:

Values Description
0 Alternate rate schedule
1 Default rate schedule
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 for supp_plan_ind:

Values Description
0 Master plan
1 Supplemental plan
brd_arrow.gif plan_instance_status_cd long Current status code of the plan instance.  

Allowable values for plan_instance_status_cd:

Values Description
-3 Terminated
-2 Cancelled
-1 Suspended
0 Inactive
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
brd_arrow.gif plan_instance_status_label string Current status of the plan instance.  

Allowable values for plan_instance_status_label:

Values Description
Terminated Terminated
Cancelled Cancelled
Suspended Suspended
Inactive Inactive
Active Active
Pending Cancellation Pending Cancellation
Pending Termination Pending Termination
Pending Installation Pending Installation
Pending Activation Pending Activation
Trial Trial
Active Non-billable Active Non-billable
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 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 for dunning_state:

Values Description
0 None
1 In Progress
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 The API receipt ID used while creating this plan instance.
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 CDID of the plan to be assigned 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 for proration_invoice_timing_cd:

Values Description
I Indicates to generate the invoice immediately for the pro-rated charges.
A Indicates to generate the invoice to the next anniversary date for the pro-rated charges.
brd_arrow.gif product_fields hash  
brd_arrow.gif field_name string Name of the product field associated with the plan in the product catalog.
brd_arrow.gif field_value string Value associated with the product field as defined in the product catalog.
brd_arrow.gif plan_instance_fields_detail hash  
brd_arrow.gif field_name string Name of the plan instance field
brd_arrow.gif field_value string Value associated with the plan instance field
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 plan_services hash Deprecated A multidimensional array of Services for this plan
brd_arrow.gif service_no long The services for this plan
brd_arrow.gif service_desc string Description of this service
brd_arrow.gif is_recurring_ind long Indicates whether or not this service is a recurring service  

Allowable values for is_recurring_ind:

Values Description
0 Service is not recurring-based.
1 Service is recurring-based.
brd_arrow.gif is_usage_based_ind long Indicates whether or not this service is a usage-based service  

Allowable values for is_usage_based_ind:

Values Description
0 Service is not usage-based.
1 Service is usage-based.
brd_arrow.gif usage_type long The usage type supported by this usage based service
brd_arrow.gif taxable_ind long Indicates whether or not this service is taxable  

Allowable values for taxable_ind:

Values Description
0 Service is not taxable.
1 Service is taxable.
brd_arrow.gif is_tax_ind long Indicates whether or not this service is a tax-based service  

Allowable values for is_tax_ind:

Values Description
0 Service is not a tax-based service.
1 Service is a tax-based service.
brd_arrow.gif is_arrears_ind long Indicates whether or not this service is an arrears-based service  

Allowable values for is_arrears_ind:

Values Description
0 Service is not arrears-based.
1 Service is arrears-based.
brd_arrow.gif is_setup_ind long Indicates whether or not this service is a setup-based service  

Allowable values for is_setup_ind:

Values Description
0 Service is not setup-based.
1 Service is setup-based.
brd_arrow.gif is_misc_ind long Indicates whether or not this service is a miscellaneous service  

Allowable values for is_misc_ind:

Values Description
0 Service is not miscellaneous.
1 Service is miscellaneous.
brd_arrow.gif is_donation_ind long Indicates whether or not this service is a donation-based service  

Allowable values for is_donation_ind:

Values Description
0 Service is not donation-based.
1 Service is donation-based.
brd_arrow.gif is_order_based_ind long Indicates whether or not this service is an order-based service  

Allowable values for is_order_based_ind:

Values Description
0 Service is not order-based.
1 Service is order-based.
brd_arrow.gif is_cancellation_ind long Indicates whether or not this service is a cancellation- based service  

Allowable values for is_cancellation_ind:

Values Description
0 Service is not cancellation-based.
1 Service is cancellation-based.
brd_arrow.gif coa_id string Chart of accounts ID
brd_arrow.gif ledger_code string This field is deprecated in favor of coa_id
brd_arrow.gif client_coa_code string The client-defined override for coa_id
brd_arrow.gif display_ind long Indicates if this service is displayable or not  

Allowable values for display_ind:

Values Description
0 Service is not displayable.
1 Service is displayable.
brd_arrow.gif tiered_pricing_rule long The Tiered Pricing Rule  

Allowable values for tiered_pricing_rule:

Values Description
1 Standard
2 Volume Discount
3 Flat Rate Per Tier
brd_arrow.gif is_min_fee_ind long Indicates whether or not this service is a minimum fee.  

Allowable values for is_min_fee_ind:

Values Description
0 Service is not a minimum fee.
1 Service is a minimum fee.
brd_arrow.gif client_service_id string The client-defined Service ID for this plan.
brd_arrow.gif usage_type_cd string Denotes which usage type to record.
brd_arrow.gif all_service_supp_fields hash  
brd_arrow.gif field_name string The machine-readable name of this field
brd_arrow.gif field_desc string The human-readable name of this field
brd_arrow.gif field_order_no long The sort order of this field
brd_arrow.gif field_value string The value stored in this field
brd_arrow.gif fulfillment_based_ind long Indicates if the service is Fulfillment Based or not.
brd_arrow.gif svc_location_no long The Aria-assigned unique identifier for the origin location for the service.
brd_arrow.gif client_svc_location_id string The client-defined location identifier for the origin location for the service.
brd_arrow.gif svc_location_name string The name of the origin location for the service.
brd_arrow.gif svc_location_company_name string Company name of the service location.
brd_arrow.gif svc_location_address1 string First address line of the service location.
brd_arrow.gif 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.
brd_arrow.gif svc_location_address3 string Third address line of the service location.
brd_arrow.gif svc_location_city string City of the service location.
brd_arrow.gif svc_location_locality string Locality of the service location.
brd_arrow.gif 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.
brd_arrow.gif svc_location_country string Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif svc_location_postal_cd string Postal/Zip code for the service location address.
brd_arrow.gif plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
brd_arrow.gif rate_seq_no long Sequential number in the rate schedule for dertermining tiers
brd_arrow.gif from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
brd_arrow.gif to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
brd_arrow.gif rate_per_unit double The cost per unit of this service over the time period the plan is billed for
brd_arrow.gif future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
brd_arrow.gif monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
brd_arrow.gif weekly_fee double If the plan interval is more than one week, this field will rate per unit per week
brd_arrow.gif daily_fee double If the plan interval is more than one week, this field will rate per unit per week
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif rate_tier_description string Rate Tier Description
brd_arrow.gif all_plan_service_rates hash All rates for all rate schedules and currencies for this plan
brd_arrow.gif schedule_no long Rate schedule number
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif future_rate long Indicates whether future rates are captured or not.  

Allowable values for future_rate:

Values Description
0 false, i.e., no future rate.
1 True, i.e., future rates are captured.
  null, i.e., no future rate.
brd_arrow.gif future_change_date string Future Change Date of the rates.
brd_arrow.gif followup_rs_no long Aria internal ID of follow-up default rate schedule
brd_arrow.gif client_followup_rs_id string Client-defined ID of followup rate schedule
brd_arrow.gif plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
brd_arrow.gif rate_seq_no long Sequential number in the rate schedule for dertermining tiers
brd_arrow.gif from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
brd_arrow.gif to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
brd_arrow.gif rate_per_unit double The cost per unit of this service over the time period the plan is billed for
brd_arrow.gif future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
brd_arrow.gif monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif rate_tier_description string Rate Tier Description
brd_arrow.gif usage_type_name string The human-readable name of this usage type
brd_arrow.gif usage_type_desc string The long description of this usage type
brd_arrow.gif usage_type_code string Client-assigned identifier for the type of usage being recorded.
brd_arrow.gif usage_unit_label string The display-level description of the units this usage represents.
brd_arrow.gif apply_usage_rates_daily long Indicates whether or not this usage-based service is rated on a daily basis.  

Allowable values for apply_usage_rates_daily:

Values Description
0 usage shall be rated based on the entire billing period
1 usage shall be rated based on one day periods individually.
brd_arrow.gif plan_instance_services hash A multidimensional array of Services for this plan
brd_arrow.gif service_no long The services for this plan
brd_arrow.gif service_desc string Description of this service
brd_arrow.gif is_recurring_ind long Indicates whether or not this service is a recurring service  

Allowable values for is_recurring_ind:

Values Description
0 0
1 1
brd_arrow.gif is_usage_based_ind long Indicates whether or not this service is a usage based service  

Allowable values for is_usage_based_ind:

Values Description
0 0
1 1
brd_arrow.gif usage_type long The usage type supported by this usage based service
brd_arrow.gif taxable_ind long Indicates whether or not this service is taxable  

Allowable values for taxable_ind:

Values Description
0 0
1 1
brd_arrow.gif is_tax_ind long Indicates whether or not this service is a tax based service  

Allowable values for is_tax_ind:

Values Description
0 0
1 1
brd_arrow.gif is_arrears_ind long Indicates whether or not this service is an arrears based service  

Allowable values for is_arrears_ind:

Values Description
0 0
1 1
brd_arrow.gif is_setup_ind long Indicates whether or not this service is a setup bases service  

Allowable values for is_setup_ind:

Values Description
0 0
1 1
brd_arrow.gif is_misc_ind long Indicates whether or not this service is a miscellaneous service  

Allowable values for is_misc_ind:

Values Description
0 0
1 1
brd_arrow.gif is_donation_ind long Indicates whether or not this service is a donation based service  

Allowable values for is_donation_ind:

Values Description
0 0
1 1
brd_arrow.gif is_order_based_ind long Indicates whether or not this service is an order based service  

Allowable values for is_order_based_ind:

Values Description
0 0
1 1
brd_arrow.gif is_cancellation_ind long Indicates whether or not this service is a cancellation based service  

Allowable values for is_cancellation_ind:

Values Description
0 0
1 1
brd_arrow.gif coa_id string Chart of accounts ID
brd_arrow.gif ledger_code string This field is deprecated in favor of coa_id
brd_arrow.gif client_coa_code string The client-defined override for coa_id
brd_arrow.gif display_ind long Indicates if this service is displayable or not  

Allowable values for display_ind:

Values Description
0 0
1 1
brd_arrow.gif tiered_pricing_rule long The Tiered Pricing Rule  

Allowable values for tiered_pricing_rule:

Values Description
1 Standard
2 Volume Discount
3 Flat Rate Per Tier
brd_arrow.gif is_min_fee_ind long Indicates whether or not this service is a minimum fee.  

Allowable values for is_min_fee_ind:

Values Description
0 0
1 1
brd_arrow.gif client_service_id string The client-defined Service ID for this plan.
brd_arrow.gif usage_type_cd string Denotes which usage type to record.
brd_arrow.gif all_service_supp_fields hash  
brd_arrow.gif field_name string The machine-readable name of this field
brd_arrow.gif field_desc string The human-readable name of this field
brd_arrow.gif field_order_no long The sort order of this field
brd_arrow.gif field_value string The value stored in this field
brd_arrow.gif fulfillment_based_ind long Indicates if the service is Fulfillment Based or not.
brd_arrow.gif plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan DEPRECATED in favor of plan_instance_service_rates
brd_arrow.gif rate_seq_no long Sequential number in the rate schedule for determining tiers
brd_arrow.gif from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
brd_arrow.gif to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
brd_arrow.gif rate_per_unit double The cost per unit of this service over the time period the plan is billed for
brd_arrow.gif future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
brd_arrow.gif monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif rate_tier_description string Rate Tier Description
brd_arrow.gif usage_type_name string The human-readable name of this usage type
brd_arrow.gif usage_type_desc string The long description of this usage type
brd_arrow.gif usage_type_code string Client-assigned identifier for the type of usage being recorded.
brd_arrow.gif usage_unit_label string The display-level description of the units this usage represents.
brd_arrow.gif apply_usage_rates_daily long Indicates whether or not this usage-based service is rated on a daily basis.  

Allowable values for apply_usage_rates_daily:

Values Description
0 usage shall be rated based on the entire billing period
1 usage shall be rated based on one day periods individually.
brd_arrow.gif 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.
brd_arrow.gif 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.
brd_arrow.gif svc_location_name string The name of the origin location for the service.
brd_arrow.gif svc_location_company_name string Company name of the service location.
brd_arrow.gif svc_location_address1 string First address line of the service location.
brd_arrow.gif 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.
brd_arrow.gif svc_location_address3 string Third address line of the service location.
brd_arrow.gif svc_location_city string City of the service location.
brd_arrow.gif svc_location_locality string Locality of the service location.
brd_arrow.gif 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.
brd_arrow.gif svc_location_country string Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif svc_location_postal_cd string Postal/Zip code for the service location address.
brd_arrow.gif 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.
brd_arrow.gif tax_inclusive_ind long

Indicator that states whether a taxable service is tax-inclusive or tax-exclusive. 

Allowable values for tax_inclusive_ind:

Values Description
0 The service is tax-exclusive.
1 The service is tax-inclusive.
brd_arrow.gif plan_instance_service_rates   Represents the rates for the plan instance
brd_arrow.gif rate_seq_no long Sequential number in the rate schedule for determining tiers
brd_arrow.gif from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
brd_arrow.gif to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
brd_arrow.gif rate_per_unit double The cost per unit of this service over the time period the plan is billed for
brd_arrow.gif future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
brd_arrow.gif monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
brd_arrow.gif weekly_fee double If the plan interval is more than one week, this field will rate per unit per week
brd_arrow.gif daily_fee double If the plan interval is more than one day, this field will rate per unit per day
brd_arrow.gif rate_tier_description string Rate Tier Description
brd_arrow.gif custom_rate_ind long Identifies whether this is a custom rate. A value of 1 indicates that it is a custom rate.  A value of 0 indicates that it is a standard rate.
brd_arrow.gif surcharges_all hash A multidimensional array of Surcharges for this plan'
brd_arrow.gif surcharge_no long Surcharge number for this plan
brd_arrow.gif surcharge_name string Surcharge name for this plan
brd_arrow.gif client_surcharge_id string Client-defined surcharge ID.
brd_arrow.gif description string description for surcharge.
brd_arrow.gif ext_description string External Description for surcharge.
brd_arrow.gif surcharge_type string Surcharge type for the plan.
brd_arrow.gif currency string Currency for this surcharge plan
brd_arrow.gif tax_group string If taxable, the tax group this item belongs to
brd_arrow.gif invoice_app_method string Invoice application method of this plan surcharge  

Allowable values for invoice_app_method:

Values Description
I Inline
O Offset
brd_arrow.gif rev_gl_code string Revenue Account GL Code for this plan surcharge
brd_arrow.gif ar_gl_code string Accounts Recievable GL Code for this plan surcharge
brd_arrow.gif surcharge_rate hash A multidimensional array of Surcharges Rate for this plan'
brd_arrow.gif rate_seq_no long Aria-assigned unique rate sequence number
brd_arrow.gif from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
brd_arrow.gif to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
brd_arrow.gif rate_per_unit double This is the rate for the tiered units specified by from and to unit values above.
brd_arrow.gif include_zero long This indicator indicates whether the rate schedule has includes zero or not.
brd_arrow.gif rate_sched_is_assigned_ind long This indicator indicates the assigned rate schedule for the surcharge.
brd_arrow.gif rate_tier_description string Rate Tier Description
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 for usage_accumulation_reset_months_ renewal_option:

Values Description
NULL or 1 Recurring / Auto Renew.(Default)
2 Single Use.
 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 unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. DEPRECATED
acct_locale_no_2 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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®