Skip to main content
Aria Knowledge Central

get_rate_schedules_for_plan_m Guide

Returns a list of rate schedules associated with a specified plan. The plan's default rate schedule will always be the first rate schedule returned and the remaining rate schedules will be sorted by schedule number.

API Specification: get_rate_schedules_for_plan_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <plan_no> or <client_plan_id>

Error Codes:

Error Code/Description Associated Inputs

1001: unexpected error


 

1004: authentication error

Associated Inputs: auth_key, client_id, client_no


<auth_key>, <client_id>, <client_no>

1033:  a parameter that represents a true or false value contains invalid input

Associated Inputs: alt_collect_on_approve, alt_send_statement_on_approve, cancel_orders_on_discard, cascade_action, do_auto_discard, do_collect, change_status_after_coll, reset_dates_after_status, disable_existing_on_update, do_write, exclude_terminated_plan_inst, include_all_rate_schedules, include_plan_hierarchy, retrieve_bundled_nso, retrieve_included_nso, include_translations, include_inactive_items, include_invoice_activity_eligibility, include_rs_summary, include_translations, include_service_supp_fields/include_product_fields/, include_plan_instance_fields/include_plan_services/, include_surcharges, include_void_transactions, include_voided, invoice_unbilled_usage, is_unlinked_refund, record_cc_on_auth_failure, retrieve_excluded_usage, send_email, usage_pooling, do_write


<alt_collect_on_approve>, <alt_send_statement_on_approve>, <cancel_orders_on_discard>, <cascade_action>, <do_auto_discard>, <do_collect>, <change_status_after_coll>, <reset_dates_after_status>, <disable_existing_on_update>, <do_write>, <exclude_terminated_plan_inst>, <include_all_rate_schedules>, <include_plan_hierarchy>, <retrieve_bundled_nso, retrieve_included_nso>, <include_translations>, <include_inactive_items>, <include_invoice_activity_eligibility>, <include_rs_summary, <include_translations>, <include_service_supp_fields>/<include_product_fields>/, <include_plan_instance_fields>/<include_plan_services>/, <include_surcharges>, <include_void_transactions>, <include_voided>, <invoice_unbilled_usage>, <is_unlinked_refund>, <record_cc_on_auth_failure>, <retrieve_excluded_usage>, <send_email>, <usage_pooling>, <do_write>

1066: Locale name does not exist in the system.

Associated Inputs: locale_name


<locale_name>

1067: Locale no does not exist in the system.

Associated Inputs: locale_no, master_plan_instance_no


<locale_name>, <master_plan_instance_no>

14004: Invalid_plan_no

Associated Inputs: new_plan_no, rollover_plan_no


<new_plan_no>, <rollover_plan_no>

14035: Invalid client Plan id

Associated Inputs: client_plan_id, custom_rate_client_plan_instance_id


<client_plan_id>, <custom_rate_client_plan_instance_id>

Additional Guidance 

Input Fields 
Field Name Notes
<include_translations>
Allowable values
Values Description
true true
false false
Output Fields 
Field Name Notes
<default_ind>
Allowable values
Values Description
0 0
1 1
<display_ind>
Allowable values
Values Description
0 Rate schedule is not displayable.
1 Rate schedule is displayable.
<default_ind_curr>
Allowable values
Values Description
0 Rate schedule is not default for specified currency.
1 Rate schedule is default for specified currency.

 

  • Was this article helpful?