get_supp_plans_by_supp_field_m
Summary
| API Name | get_supp_plans_by_supp_field_m |
|---|---|
| Class | system_services_m |
| Update Version | 6.45 |
Description
Returns a list of supplemental plans associated with a specified value for a supplemental object field.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||
| field_no | long | No |
The plan supplemental field number which is being searched against |
|||||||
| field_val | string | Yes |
The value of the supplemental field which all returned plans should possess |
|||||||
| field_name | string | No |
The optional name of this supplemental field, if the number is not known |
|||||||
| include_rs_summary | string | No |
If set to "true", will retrieve summary level rate schedule information for all the rate schedules that are associated with a particular plan. If left blank, will default to "false". Allowed values:
|
|||||||
| locale_no | long | 30 | No |
Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. Alternative field: locale_name |
||||||
| locale_name | string | 100 | No |
Name of the locale. Alternative field: locale_no |
||||||
| include_translations | string | No |
Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowed values:
|
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| supp_plans_dtl_by_supp_field | object | No |
supp_plans_dtl_by_supp_field.plan_rate_schedules_details fields
| Name | Type | Length | Required | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| schedule_no | long | No |
The ID of this rate schedule |
|||||||||||||
| client_rate_schedule_id | string | 100 | No |
Client assigned unique rate schedule number |
||||||||||||
| schedule_name | string | No |
The name of this rate schedule |
|||||||||||||
| schedule_currency | string | No |
The currency this rate schedule is linked to |
|||||||||||||
| recurring_billing_interval | long | No |
Number of months between billing cycles for recurring |
|||||||||||||
| usage_billing_interval | long | No |
Number of months between billing cycles for usage |
|||||||||||||
| recurring_billing_period_type | long | No |
Period type for billing cycles for recurring Allowed values:
|
|||||||||||||
| usage_billing_period_type | long | No |
Period type for billing cycles for usage Allowed values:
|
|||||||||||||
| default_ind | long | No |
If true, this is the default rate schedule for the default currency Allowed values:
|
|||||||||||||
| default_ind_curr | long | No |
If true, this is the default rate schedule for the specified currency Allowed values:
|
|||||||||||||
| schedule_display_ind | long | No |
Determines whether the rate schedule is displayable Allowed values:
|
|||||||||||||
| available_from_dt | string | 100 | No |
Start date of rate schedule |
||||||||||||
| available_to_dt | string | 100 | No |
End date of rate schedule |
||||||||||||
| followup_rs_no | long | 100 | No |
Aria internal ID of follow-up default rate schedule |
||||||||||||
| client_followup_rs_id | string | 100 | No |
Client-defined ID of followup rate schedule |
supp_plans_dtl_by_supp_field.contract_rollover_rate_sched fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| contract_current_rate_sched_no | long | No |
Current rate schedule for which the rollover rate schedule will be used at the completion of the contract |
|
| contract_current_client_rate_sched_id | string | No |
Client-defined ID of the current rate schedule for which the rollover rate schedule will be used at the completion of the contract |
|
| contract_rollover_rate_sched_no | long | No |
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 | No |
Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract |
supp_plans_dtl_by_supp_field.plan_translation_info fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_no | long | 22 | No |
Aria-assigned plan identifier. This value is unique across all Aria-managed accounts. |
supp_plans_dtl_by_supp_field fields
| Name | Type | Length | Required | Description | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| plan_no | long | 22 | No |
The unique ID of this plan |
||||||||||||||||||||||||||||||||
| plan_name | string | No |
The short name of this plan |
|||||||||||||||||||||||||||||||||
| plan_desc | string | No |
The long description of this plan |
|||||||||||||||||||||||||||||||||
| billing_ind | long | No |
Whether or not this plan is currently billable Allowed values:
|
|||||||||||||||||||||||||||||||||
| display_ind | long | No |
Whether or not this plan is to be displayed to the end-users Allowed values:
|
|||||||||||||||||||||||||||||||||
| rollover_months | long | No |
Number of months in which the account will change from the current plan to the pre-defined rollover plan. |
|||||||||||||||||||||||||||||||||
| rollover_plan_no | long | No |
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. |
|||||||||||||||||||||||||||||||||
| plan_2_assign_on_susp | long | No |
Plan to assign when an account on this plan is suspended. |
|||||||||||||||||||||||||||||||||
| default_notify_method | long | No |
Default notification method given to an account that is assigned to this plan. Allowed values:
|
|||||||||||||||||||||||||||||||||
| prepaid_ind | long | No |
Indicates whether or not this plan is prepaid Allowed values:
|
|||||||||||||||||||||||||||||||||
| currency_cd | string | No |
The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
|||||||||||||||||||||||||||||||||
| client_plan_id | string | 100 | No |
Client-defined Plan ID for which to query available child plans |
||||||||||||||||||||||||||||||||
| client_rollover_plan_id | string | 100 | No |
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_id_2_assign_on_susp | string | 100 | No |
Client-defined Plan ID to assign when an account on this plan is suspended. |
||||||||||||||||||||||||||||||||
| proration_invoice_timing_cd | string | 2 | No |
Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately. Allowed values:
|
||||||||||||||||||||||||||||||||
| rollover_plan_duration | long | No |
Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd). |
|||||||||||||||||||||||||||||||||
| rollover_plan_uom_cd | long | No |
Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration). Allowed values:
|
|||||||||||||||||||||||||||||||||
| init_free_period_duration | long | No |
Duration of the initial free period (used in conjunction with init_free_period_uom_cd). |
|||||||||||||||||||||||||||||||||
| init_free_period_uom_cd | long | No |
Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration). Allowed values:
|
|||||||||||||||||||||||||||||||||
| initial_plan_status_cd | long | No |
Default status used when master plan is initially assigned on an account. Allowed values:
|
|||||||||||||||||||||||||||||||||
| rollover_plan_status_duration | long | No |
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 | No |
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). Allowed values:
|
|||||||||||||||||||||||||||||||||
| rollover_plan_status_cd | long | No |
Status used for the master plan instance at the completion of the plan status rollover period. Allowed values:
|
|||||||||||||||||||||||||||||||||
| plan_rate_schedules_details | object | No |
An array of the rate schedules for the requested plan |
|||||||||||||||||||||||||||||||||
| contract_rollover_plan_no | long | No |
Pre-defined plan to be used as the rollover plan at the completion of the contract. |
|||||||||||||||||||||||||||||||||
| contract_rollover_client_plan_id | string | 100 | No |
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 | object | No | ||||||||||||||||||||||||||||||||||
| plan_translation_info | object | No |