 |
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. |
|
plan_no |
string |
100 |
Specifies Plan Number |
| |
OR |
|
|
|
| |
client_plan_id |
string |
100 |
Client defined unique identifier |
| |
plan_name |
string |
100 |
Specifies Plan Name. For edit_directives 1 and 2 plan_name is mandatory. Translatable. |
| |
plan_description |
string |
3000 |
Specifies plan description. Translatable. |
| |
plan_group |
int array |
3 |
Plan Group Number.REST input arrays should be passed in the following format: plan_group[]=2&plan_group[]=3&plan_group[]=4 |
| |
plan_group_id |
string array |
100 |
Plan Group Id Number.REST input arrays should be passed in the following format: plan_group_id[]=2&plan_group_id[]=3&plan_group_id[]=4 |
| |
plan_type |
int |
|
Specifies Plan Type. Valid values are [ 'Master Recurring Plan', 'Master Pre-paid Plan', 'Master Free Plan', 'Supplemental Recurring Plan', 'Supplemental Free Plan'].
Allowable Values:
| Values |
Description |
| Master Recurring Plan |
This type creates a Master Recurring Plan |
| Master Pre-paid Plan |
This type creates a Master Pre-paid Plan |
| Master Free Plan |
This type creates a Master Free Plan |
| Supplemental Recurring Plan |
This type creates a Supplemental Recurring Plan |
| Supplemental Free Plan |
This type creates a Supplemental Free Plan |
|
| |
active |
int |
1 |
Specifies Plan Status.Valid values are "1" or "0" 1 - Active 0 - Inactive.
Allowable Values:
| Values |
Description |
| 0 |
Inactive |
| 1 |
Active |
|
| |
currency |
string |
3 |
Specifies the currency code. For edit_directives 1 and 2 currency is mandatory |
| |
template_no |
int |
8 |
Specifies invoice template class associated with master plan |
| |
OR |
|
|
|
| |
client_email_template_id |
string |
100 |
Client defined unique identifier. |
| |
rollover_plan_duration |
int |
|
Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd). |
| |
rollover_plan_uom_cd |
int |
|
Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration).
Allowable Values:
| Values |
Description |
| 1 |
Day |
| 2 |
Week |
| 3 |
Month |
| 4 |
Quarter |
| 5 |
Year |
|
| |
rollover_plan_no |
int |
100 |
Rollover Plan number. Rollover information is required for Pre-paid plans |
| |
OR |
|
|
|
| |
rollover_client_plan_id |
string |
100 |
Client defined unique identifier |
| |
init_free_period_duration |
int |
|
Duration of the initial free period (used in conjunction with init_free_period_uom_cd). |
| |
init_free_period_uom_cd |
int |
|
Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).
Allowable Values:
| Values |
Description |
| 1 |
Day |
| 2 |
Week |
| 3 |
Month |
| 4 |
Quarter |
| 5 |
Year |
|
| |
initial_plan_status_cd |
int |
|
Default status used when master plan is initially assigned on an account. |
| |
rollover_plan_status_duration |
int |
|
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 |
int |
|
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:
| Values |
Description |
| 1 |
Day |
| 2 |
Week |
| 3 |
Month |
| 4 |
Quarter |
| 5 |
Year |
|
| |
rollover_plan_status_cd |
int |
|
Status used for the master plan instance at the completion of the plan status rollover period. |
| |
dunning_plan_no |
int |
100 |
Specifies dunning plan associated with this plan |
| |
OR |
|
|
|
| |
dunning_client_plan_id |
string |
100 |
Client defined unique identifier |
| |
allow_child_accts |
int |
3 |
Specifies whether a plan can have child accounts or not. Valid values are "1" or "0" 1 - Yes 0 - No. The parameter has been depreciated. Value will be overrided to 1 |
| |
apply_cancellation |
string |
|
Specifies whether to apply cancellation or not. Valid values: Yes or No. If marked as 'Yes' then should also provide at least one cancellation service.Apply cancellation is set when the plan is created and cannot be modified except for the min terms(months)
Allowable Values:
| Values |
Description |
| Yes |
If set as Yes, minimum cancellation service can be added |
| No |
If set as No, minimum cancellation service cannot be added |
|
| |
plan_cancel_min_month |
int |
4 |
Specifies the minimum term months for cancellation service |
| |
apply_minimum_fee |
string |
|
Specifies whether to apply minimum fee or not. Valid values: Yes or No. If marked as 'Yes' then should also provide at least one minimum fee service.
Allowable Values:
| Values |
Description |
| Yes |
If set as Yes, minimum fee service can be added |
| No |
If set as No, minimum fee service cannot be added |
|
| |
how_to_apply_min_fee |
int |
|
Specifies when to apply min fee. Valid values are 0 which means 'All Invoices' and 1 which means 'After first invoice'.
Allowable Values:
| Values |
Description |
| 0 |
All Invoices |
| 1 |
After first invoice |
|
| |
schedule |
array |
|
For edit_directives 1 schedule is mandatory |
| |
 schedule_no |
int |
20 |
Specifies the schedule number whose details is going to be edited. This can be nullable for new services.REST input arrays should passed in the following format: schedule[0][schedule_no]=1212121&schedule[1][schedule_no]=4234232 etc where schedule[0] specifies first schedule and schedule[1] specifies the second schedule and so on |
| |
OR |
|
|
|
| |
client_rate_schedule_id |
string |
100 |
Client defined unique id |
|
schedule_name |
string |
100 |
Name for the schedules to be created. REST input arrays should passed in the following format: schedule[0][schedule_name]=firstSchedule&schedule[1][schedule_name]= secondSchedule etc where schedule[0] specifies first schedule and schedule[1] specifies the second schedule and so on. Translatable. |
|
currency_cd |
string |
100 |
Currency for the schedules to be created. REST input arrays should passed in the following format: schedule[0][currency_cd]=usd&schedule[1][currency_cd]=gbp |
|
is_default |
int |
1 |
Specifies which currency should be the default as the user can add the same currency multiple times. Accepted values are 1(default) and 0. Alternate boolean values are accepted (e.g., true/false, yes/no, t/f, y/n).
Allowable Values:
| Values |
Description |
| 1, true/TRUE/t, yes/y |
Yes, this currency is the default. |
| 0, false/FALSE/f, no/n |
No, this currency is not the default. |
|
| |
recurring_billing_interval |
int |
100 |
If a null/no value is provided then recurring_billing_interval should default to 1, i.e., monthly interval. Recurring Billing Interval [ can be either of 1, 3, 6 or 12, ) 1 – Monthly, 3 – Quarterly, 6 - Semi-Annually, 12 – Annually, Custom - |
| |
recurring_billing_period_type |
int |
100 |
If a null/no value is provided then recurring_billing_period_type should default to 3, i.e., monthly period type. Recurring Billing Period Type [ can be either of 1, 2, 3 ] 1 – Daily, 2 – Weekly, 3 - Monthly |
| |
usage_billing_interval |
int |
100 |
If null/no value is provided then usage_billing_interval should default to 1, i.e., monthly interval. Usage Billing Interval [ can be either of 1, 3, 6 or 12, ) 1 – Monthly, 3 – Quarterly, 6 - Semi-Annually, 12 – Annually, Custom - |
| |
usage_billing_period_type |
int |
100 |
If a null/no value is provided then usage_billing_period_type should default to 3, i.e., monthly period type. Usage Billing Period Type [ can be either of 1, 2, 3 ] 1 – Daily, 2 – Weekly, 3 - Monthly |
| |
available_from_dt |
string |
10 |
Date from which the rate schedule will be available for the assignment. The date format must be yyyy-mm-dd |
| |
available_to_dt |
string |
10 |
Date after which the rate schedule will not be available for the assignment. The date format must be yyyy-mm-dd |
| |
future_rate |
boolean |
1 |
Indicator whether future rates should be supported or not. Alternate boolean values are accepted (e.g., true/false, yes/no, t/f, y/n).
Allowable Values:
| Values |
Description |
| 1, true/TRUE/t, yes/y |
Yes, future rates are supported.. |
| 0, false/FALSE/f, no/n |
No, future rates are not supported. |
|
| |
future_change_dt |
string |
10 |
Date after which the future rates should be assigned. The date format must be yyyy-mm-dd |
| |
followup_rs_no |
long |
100 |
Aria internal id of follow-up default rate schedule |
| |
OR |
|
|
|
| |
client_followup_rs_id |
string |
100 |
Client defined id of followup rate schedule. One of the values, i.e., either followup_rs_no or client_followup_rs_id should be provided if a followup rate schedule information should be provided. |
| |
service |
array |
|
For edit_directives 1 service is mandatory |
| |
service_no |
int |
100 |
Existing service to be associated with the plan. To create a new service, leave this field blank. REST input arrays should be passed in the following format: service[0][service_no]=125&service[1][service_no]=102 etc where service[0] specifies the first service and service[1] specifies the second service |
| |
OR |
|
|
|
| |
client_service_id |
string |
100 |
Client defined unique id |
| |
name |
string |
100 |
Name of the new service to be associated with the plan. This field cannot be null if service_no is null. REST input arrays should be passed in the following format: service[0][name]=test. Translatable. |
|
service_type |
string |
|
Specifies the service type. Valid values : 'Activation', 'Recurring', 'Cancellation', 'Minimum Fee' and 'Usage-Based' REST input arrays should passed in the following format: service[0][service_type]=Recurring&service[1][service_type]=...
Allowable Values:
| Values |
Description |
| Usage Based |
Creates a Usage Based service |
| Recurring |
Creates a Recurring service |
| Activation |
Creates a Activation service |
| Order-Based |
Creates a Order-Based service |
| Cancellation |
Creates a Cancellation service |
| Minimum Fee |
Creates a Minimum Fee service |
| Recurring Arrears |
Creates a Recurring Arrears service |
|
| |
gl_cd |
string |
30 |
Specifies the chart of account code of the new service. REST input arrays should be passed in the following format: service[0][gl_cd]=gl123 |
| |
taxable_ind |
string |
1 |
Indicates If The service has tax associated with it [can be 0 or 1]; 1 indicates taxable and 0 indicates non taxable.REST input arrays should be passed in the following format: service[0][taxable_ind]=1 |
| |
tax_group |
string |
1 |
Specifies the tax group associated with the new service. This field cannot be null if taxable_ind is not null.REST input arrays should be passed in the following format: service[0][tax_group]=4 |
| |
usage_type |
int |
38 |
Specifies usage type associated with the new service. Applicable only if service_type is "Usage-Based". This field cannot be null if service_no is null and service_type is "Usage-Based".REST input arrays should be passed in the following format: service[0][usage_type]=1232& |
| |
commodity_cd |
string |
20 |
Commodity Code |
| |
rate_type |
string |
|
Specifies the rate type of the service.valid values are: 'Flat Rate' and 'Tiered Pricing'.REST input arrays should be passed in the following format: service[0][rate_type]=Flat Rate&service[1][rate_type]=...
Allowable Values:
| Values |
Description |
| Flat Rate |
Applies Flat Rate type pricing to the rate schedule |
| Tiered Pricing |
Applies Tiered Pricing to the rate schedule |
|
| |
pricing_rule |
string |
|
Specifies the pricing rule. Valid values are: 'Standard', 'Volume Discount' and 'Flat Rate Per Tier'.REST input arrays should be passed in the following format:service[0][pricing_rule]=Standard&...
Allowable Values:
| Values |
Description |
| Standard |
Standard Pricing |
| Volume Discount |
Volume Discount Pricing |
| Flat Rate Per Tier |
Flat Rate Per Tier Pricing |
|
| |
high_water |
int |
|
Specifies the high water indicator. Valid values: 0 and 1.It is mandatory for Usage-Based services.REST input arrays should be passed in the following format: service[0][high_water]=1&service[1][high_water]=0
Allowable Values:
| Values |
Description |
| 1 |
Enables high water indicator for the particular service |
| 0 |
Doesn't enable high water indicator for the particular service |
|
| |
billing_option |
int |
3 |
Specifies the two advanced billing options. This is only given for Usage-Based services only. Valid values: '1' => pool items, '2' =>usage tier multiplier and '0' for none. If you do no provide this information it will default to none. REST input arrays should passed in the following format: service[0][billing_option]=1&service[1][billing_option]=2 |
| |
threshold |
int |
9 |
Specifies the pool threshold. This is mandatory only if you choose ervice[0][billing_option]=1. This is only given for Usage-Based services only. If you do not provide any value it will default to 0. REST input arrays should passed in the following format: service[0][threshold]=123&service[1][threshold]=42 |
| |
tax_inclusive_ind |
boolean |
1 |
This flag denotes if a rate is inclusive of the taxes. Value of 1 means tax inclusive rates and a value of 0 (default) means tax exclusive rates. Alternate boolean values are accepted (e.g., true/false, yes/no, t/f, y/n).
Allowable Values:
| Values |
Description |
| 0, false/FALSE/f, no/n |
No, applied rate does not include taxes. |
| 1, true/TRUE/t, yes/y |
Yes, applied rate includes taxes. |
|
| |
usage_threshold |
array |
|
Threshold units at the usage type level |
| |
notice_dest_type |
string |
|
Notice Destination type. Acceptable values are S, C. Parameter is case insensitive.
Allowable Values:
| Values |
Description |
| S |
Master Plan Instance level threshold |
| C |
Client level threshold |
|
| |
notice_balance_type |
string |
|
Notice Balance type. Acceptable values are MTD, PTD. Parameter is case insensitive
Allowable Values:
| Values |
Description |
| MTD |
Month-To-Date balance type |
| PTD |
Period-To-Date balance type |
|
| |
notifications |
array |
|
|
| |
units |
int |
9 |
Threshold units |
| |
values |
array |
|
The key of the array represents the level and the value represents the value of the array represent the notification value. Valid key values are from 1 to 4
Allowable Values:
| Values |
Description |
| 1 |
1 |
| 2 |
2 |
| 3 |
3 |
| 4 |
4 |
|
| |
tier |
array |
|
Tier is required for edit_directives 1 for the provided services? |
| |
from |
int |
10 |
Tiered Pricing Rule that specifies from units.REST input arrays should be passed in the Following format: service[0][tier][0][from]=1&service[0][tier][1][from]=1 etc. where Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on. |
| |
to |
int |
10 |
Tiered Pricing Rule that specifies to units.REST input arrays should be passed in the following format: service[0][tier][0][to]=3&service[0][tier][1][to]=7 etc. Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on. |
| |
description |
string |
50 |
This field is used to display custom rate tier description. REST input arrays should be passed in the following format: service[0][tier][0][description]=Custom description&service[0][tier][1][description]=custom description etc. Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on. Translatable. |
| |
schedule |
array |
|
|
| |
from |
int |
10 |
Tiered Pricing Rule that specifies from units at schedule level. This will override the rate tier's from units at service level. REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][from]=1&service[0][tier][0] [schedule][1][from]=1 etc. Index [tier][0][schedule][0] specifies the first tier of first schedule and [tier][0][schedule][1] specifies the first tier of second schedule and so on. |
| |
to |
int |
10 |
Tiered Pricing Rule that specifies to units at schedule level. This will override the rate tier's to units at service level. To indicate no upper limit, value should be left blank. REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][to]=3&service[0][tier][0][schedule][1][to]=7 etc. Index [tier][0][schedule][0] specifies the first tier of first schedule and [tier][0][schedule][1] specifies the first tier of second schedule and so on. |
| |
description |
string |
50 |
This field is used to display custom rate tier description. This will override the rate tier's description at service level. REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][description]=Custom description &service[0][tier][0][schedule][1][description]=custom description etc. Index [tier][0][schedule][0] specifies the first tier of first schedule and [tier][0][schedule][1] specifies the first tier of second schedule and so on. |
|
amount |
float |
11 |
Tiered Pricing Rule that specifies rate per unit.REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][amount]=3&service[0][tier][0][ schedule][1] [amount]=4 etc where [schedule][0][amount] specifies price from first schedule and [schedule][1][amount] specifies price for second schedule and so on. |
| |
future_amount |
float |
11 |
Future Rate Per Unit for the tier. future_amount should be specified only if future_rate=1 and future_change_dt is specified. REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][future_amount]=3&service[0][tier][0][schedule][1] [future_amount]=4 etc |
| |
fulfillment_based_ind |
int |
1 |
Indicates if the service is “Fulfillment Based” or not.
Allowable Values:
| Values |
Description |
| 0 |
Not a fulfillment based service |
| 1 |
Fulfillment based service |
|
| |
usage_rating_time_ind |
int |
1 |
Rating Time Indicator governs the time when usage is rated: during invoicing process or during usage loading to the platform.
Allowable Values:
| Values |
Description |
| 0 |
Refers to the setting you have on client parameter "Automatically Rate Un-rated Usage Records at Load Time" |
| 1 |
At Loading Time |
| 2 |
At Invoicing Time |
|
| |
usage_record_rating_level_ind |
int |
1 |
Indicates whether the usage rating to be done at individial record level or aggregated records level.
Allowable Values
| Values |
Description |
| 0 |
Aggregated Records |
| 1 |
Individual Records |
|
| |
usage_record_taxation_level_ind |
int |
1 |
Indicates whether the usage taxation to be done at individual record level or aggregated records level.
Allowable Values
| Values |
Description |
| 0 |
Aggregated Records |
| 1 |
Individual Records |
|
| |
resource |
array |
|
|
| |
resource_no |
int |
|
Specifies the resource no of the resource to be added to a plan. REST input arrays should passed in the following format: resource[0][resource_no]=123&resource[1][resource_no]=232 etc where resource[0] specifies first resource and resource[1] specifies the second resource and so on. |
| |
resource_name |
string |
100 |
Specifies the name of the resource to be created and assigned to this plan. REST input arrays should passed in the following format: resource[0][resource_name]=resource1&resource[1][resource_name]=test&... |
| |
resource_description |
string |
|
Specifies the description of the resource to be created and assigned to this plan.REST input arrays should passed in the following format: resource[0][resource_description]=resource1&... |
| |
flat_threshold |
int |
11 |
Specifies the name of the resource to be created and assigned to this plan. REST input arrays should passed in the following format: resource[0][flat_threshold]=11&resource[1][flat_threshold]=3&... |
| |
resource_units |
int |
11 |
Specifies the number of units of the resource to be allocated.REST input arrays should passed in the following format: resource[0][resource_units]=23&resource[1][resource_units]=4&... |
| |
expire_on_paid_through |
string |
|
Specifies whether or not the resource will expire on paid through date. REST input arrays should passed in the following format: resource[0][expire_on_paid_through]=1&resource[1][expire_on_paid_through]=0&...
Allowable Values:
| Values |
Description |
| 0 |
No |
| 1 |
Yes |
|
| |
additional_days |
int |
11 |
Specifies the number of days added to the paid_through_date if expire_on_paid_through is set if not then to the date when the plan is paid on. REST input arrays should passed in the following format: resource[0][additional_days]=2&resource[1][additional_days]=3&... |
| |
reset_on_update |
string |
|
Resets the number of units after each paid through date.REST input arrays should passed in the following format: resource[0][reset_on_update]=1&resource[1][reset_on_update]=0&...
Allowable Values:
| Values |
Description |
| 0 |
No |
| 1 |
Yes |
|
| |
arc_service_no |
int |
100 |
Specifies one of the recurring service for the plan to which the resource is being applied |
| |
parent_plans |
int array |
12 |
Specifies the parent plans to associate with. This is only applicable for supplemental plans.REST input arrays should be passed in the following format: parent_plans[]=1002&parent_plan[]=1003&parent_plan[]=1004&... |
| |
parent_client_plan_ids |
string array |
100 |
Specifies the parent plans to associate with. This is only applicable for supplemental plans.REST input arrays should be passed in the following format: parent_client_plan_ids[]=1002&parent_client_plan_ids[]=1003&parent_client_plan_ids[]=1004&... |
| |
exclusion_plans |
int array |
12 |
Specifies the exclusion plans. This is only applicable for supplemental plans. REST input arrays should be passed in the following format: exclusion_plans[]=2&exclusion_plans[]=3&exclusion_plans[]=4&... |
| |
supplemental_obj_field |
array |
|
Specifies the supplemental object fields to be added for this usage type. This field is required only if the associated product fields are marked as required |
| |
field_no |
int |
100 |
the field no |
| |
OR |
|
|
|
| |
field_name |
string |
100 |
the field name |
| |
field_value |
string array |
|
the field value |
| |
child_plans |
string array |
|
If the Plan has child plans, they can be passed in this array. Child plans must be created prior to their use here. Input arrays should be passed in the following format: child_plans[]. New parameter - eligible_child_plans has been added with more fields. This parameter would be deprecate soon. |
| |
eligible_child_plans |
array |
|
If the Plan has child plans, they can be passed in this array. Child plans must be created prior to their use here. |
| |
plan_no |
string |
12 |
Aria generated unique of the plan |
| |
OR |
|
|
|
| |
client_plan_id |
string |
|
Client defined unique id for the plan |
| |
is_mandatory |
int |
1 |
Determines if this child plan must be purchased along with the parent plan.
Allowable Values:
| Values |
Description |
| 0 |
Non Mandatory |
| 1 |
Mandatory |
|
| |
include_default |
int |
1 |
Determines if this child plan should be added to the purchase plan list in the UI.
Allowable Values:
| Values |
Description |
| 0 |
No |
| 1 |
Yes |
|
| |
min_units |
int |
2 |
Determines the minimum number of units that must be purchased. |
| |
max_units |
int |
2 |
Determines the maximum number of units that can be purchased. |
| |
enforcement_level |
int |
1 |
Determines the level at which the minimum and maximum values are enforced
Allowable Values:
| Values |
Description |
| 0 |
For each parent plan unit or Instance individually (default) |
| 1 |
In aggregate across all units and instances of this parent plan on the Account |
|
| |
notification_template_group_no |
string |
|
This field is used to associate an existing notification template group to the plan. |
| |
credit_note_template_no |
string |
|
This field is used to associate an existing credit note template to the plan. |
| |
credit_memo_template_no |
int |
|
This field is used to associate an existing credit memo template to the plan. |
| |
rebill_template_no |
int |
|
This field is used to associate an existing rebill template to the plan. |
| |
surcharge_no |
int array |
12 |
Specifies the surcharge to associate with this plan. REST input arrays should be passed in the following format: surcharge_no[0]=1002&surcharge_no[1]=1003 |
| |
client_surcharge_id |
string array |
100 |
Specifies the client defined id for surcharge to associate with this plan.REST input arrays should be passed in the following format: client_surcharge_id[]=1002&client_surcharge_id[]=1003 |
| |
proration_invoice_timing_cd |
string |
1 |
Determines whether to create a separate invoice for prorated charges immediately, or defer to the next anniversary date.
Allowable Values:
| Values |
Description |
| I |
Immediate |
| A |
Next anniversary date |
|
| |
plan_instance_status_cd |
int |
2 |
Specifies the status of an account when the plan is assigned to a plan instance.
Allowable Values:
| Values |
Description |
| 1 |
Active |
| 61 |
Active Non Billable |
| 41 |
Active trial |
| 31 |
Installation Pending |
|
| |
assign_field_categories |
array |
|
An array of either field_category_no OR field_category_name. field_category_name will take precedence if both the values are passed |
| |
field_category_no |
int |
100 |
This field is used as Primary id for field category number |
| |
OR |
|
|
|
| |
field_category_name |
string |
100 |
This field is used as client defined ID |
| |
field_category_directive |
int |
1 |
A directive that indicates the action to be taken
Allowable Values:
| Values |
Description |
| 1 |
Adds a field_category to the plan |
| 2 |
Deletes the field_category from the plan |
|
| |
edit_directives |
int |
|
A directive that indicates the action to be taken. This new parameter applies to the child_plans, parent_plans, exclusion_plans, plan_group, schedule, service, template_no, rollover_plan_no, dunning_plan_no, notification_template_group_no, supplemental_obj_field in the API
Allowable Values:
| Values |
Description |
| 1 |
Delete data that is not passed in the request (default) |
| 2 |
Insert or update data passed but DO NOT delete data not passed |
| 3 |
Delete everything that is passed. |
|
| |
contract_rollover_plan_no |
int |
100 |
Pre-defined plan to be used as the rollover plan at the completion of the contract |
| |
OR |
|
|
|
| |
contract_rollover_client_plan_id |
string |
100 |
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 |
array |
|
|
| |
current_rate_sched_no |
int |
100 |
Current rate schedule for which the rollover rate schedule is being defined |
| |
OR |
|
|
|
| |
current_client_rate_sched_id |
string |
100 |
Client-defined id of the current rate schedule for which the rollover rate schedule is being defined |
| |
rollover_rate_sched_no |
int |
100 |
Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract |
| |
OR |
|
|
|
| |
rollover_client_rate_sched_id |
string |
100 |
Client-defined id of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract |
| |
nso_incl_list_scope |
int |
1 |
Scope of additional NSO as part of inclusion list
Allowable Values:
| Values |
Description |
| 0 |
All non-restricted inventory items (default). |
| 1 |
Existing bundled and non-restricted inventory items. |
| 2 |
Existing bundled inventory items only. |
| 3 |
Selected and non-restricted inventory items. |
| 4 |
Selected specific inventory items. |
|
| |
nso_incl_list_array |
int array |
37 |
Specifies the Inventory item number. Mandatory inside array for nso_incl_list_scope is 3 or 4. |
| |
nso_group_array |
array |
|
Non-Subscription Offerings that are part of NSO group and is bundled with the plan. |
| |
item_no |
int |
100 |
Specifies the Inventory item number for adding into NSO group. |
| |
nso_group_price_override |
array |
|
|
| |
rate_schedule_no |
int |
100 |
The internal Id of the rate schedule for which the NSO price is being defined. |
| |
OR |
|
|
|
| |
client_rate_schedule_id |
string |
100 |
Client-defined id of the current rate schedule for which the NSO price is being defined. |
| |
override_price |
string |
100 |
Specifies the overridden price for Inventory item for currencies. If there is no override price defined for NSO then list price is considered during plan assignment. |
| |
bundle_nso_rate_schedule_no |
|
|
Aria-assigned unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan. |
| |
OR |
|
|
|
| |
bundle_client_nso_rate_schedule_id |
|
|
Client-defined unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with the specified plan. If neither is specified, the default rate schedule for the account's currency will be used. |
| |
nso_group_min_qty |
string |
100 |
Minimum NSO quantity needed per NSO group during plan purchase. This value should be null when NSO scope is Exact Plan Units. |
| |
nso_group_max_qty |
string |
100 |
Maximum NSO quantity needed for NSO group during plan purchase. This value should be null when NSO scope is Exact Plan Units or Up to Plan Units. |
| |
nso_group_item_scope |
string |
1 |
Scope of bundled NSO group during plan purchase. Mandatory if item_no is specified otherwise optional.
Allowable Values:
| Values |
Description |
| U |
Up to Plan Units (default). |
| M |
Match Plan Units. |
| A |
Any Units. |
|
| |
nso_items_array |
array |
|
Non-Subscription Offerings that are bundled with the plan. |
| |
item_no |
int |
100 |
Specifies the Inventory Item number. |
| |
nso_item_min_qty |
string |
100 |
Minimum NSO quantity needed during plan purchase. This value should be null when NSO scope is Match Plan Units. |
| |
nso_item_max_qty |
string |
100 |
Maximum NSO quantity needed during plan purchase. This value should be null when NSO scope is Match Plan Units or Up to Plan Units. |
| |
item_scope |
string |
1 |
Scope of bundled NSO during plan purchase. Mandatory if item_no is specified otherwise optional.
Allowable Values:
| Values |
Description |
| U |
Up to Plan Units (default). |
| M |
Match Plan Units. |
| A |
Any Units. |
|
| |
nso_items_price_override |
array |
|
|
| |
rate_schedule_no |
int |
100 |
The internal Id of the plan rate schedule for which the NSO price is being defined. Mandatory if override_price is specified |
| |
OR |
|
|
|
| |
client_rate_schedule_id |
string |
100 |
Client-defined id of the plan rate schedule for which the NSO price is being defined. Mandatory if override_price is specified |
| |
override_price |
string |
100 |
Specifies the overridden price for Inventory item for currencies. If there is no override price defined for NSO then list price is considered during plan assignment. |
| |
service_change |
array |
|
Mandatory when editing a plan that is in-use i.e. assigned to an account |
| |
subscription_type |
string |
1 |
Type of subscription on which the service changes are applicable. Allowable Values are - ‘N' for New subscription and 'E’ for existing subscription
Allowable Values:
| Values |
Description |
| N |
New Subscription |
| E |
Existing Subscription |
|
| |
effective_date |
string |
|
Date on which the service change will be effective on the given subscription_type. Either the effective_date or the effective_directive is mandatory. |
| |
effective_directive |
string |
1 |
A directive that indicates when the service changes are effective on the given subscription_type. Either the effective_date or the effective_directive is mandatory.
Allowable Values:
| Values |
Description |
| N |
Effective Prior to Next Batch Billing Run |
| A |
On Account Billing Anniversary Date |
|
| |
locale_name |
string |
32 |
Name of the locale to which the translations belong. |
| |
OR |
|
|
|
| |
locale_no |
int |
38 |
Aria-assigned unique identifier of the locale used for translations. |
