 |
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. |
|
assignment_directive |
long |
2 |
Rule to apply to this assignment/de-assignment request, specifying: the date the assignment takes place (immediately or on the account's anniversary date), and the proration rule to apply (per client's default rules for proration, that is, prorate on plan assignment or force proration on or off for each request).
Allowable values for assignment_directive:
Values |
Description |
1 |
(Default) Perform the requested plan assignment/de-assignment on the account's next scheduled billing anniversary date. The account does not receive service under this plan (for plan assignments) or does not have it removed (for de-assignments) until that date. If a plan is being assigned, initial billing for a full period of the given plan is performed on the account's next scheduled anniversary date. No charge or credit proration effect. No new recurring charges or credits are generated when no proration occurs. |
2 |
Perform the requested plan assignment/de-assignment immediately, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan assignment or de-assignment. No new recurring charges or credits are generated if no proration occurs. |
3 |
Perform the requested plan assignment/de-assignment immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION. No new recurring charges or credits are generated when no proration occurs. |
4 |
Perform the requested plan assignment/de-assignment immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION. |
5 |
Perform the requested plan assignment/de-assignment immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY. NOTE: This value is not permitted when calling the cancel_supp_plan API. |
7 |
Perform the requested plan assignment/de-assignment on the specified effective_date, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan assignment or de-assignment. No new recurring charges or credits are generated when no proration occurs. |
8 |
Perform the requested plan assignment/de-assignment on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION. No new recurring charges or credits are generated when no proration occurs. |
9 |
Perform the requested plan assignment/de-assignment on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION. |
10 |
Perform the requested plan assignment/de-assignment on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY. NOTE: This value is not permitted when calling the cancel_supp_plan API. |
|
 |
supp_plans_to_assign |
array |
|
|
 |
supp_plan_no |
long |
|
Supplemental plan number to assign |
|
OR |
|
|
|
|
client_supp_plan_id |
string |
100 |
Client-defined supplemental plan ID. |
|
alt_rate_schedule_no |
long |
|
Alternate rate schedule number to assign (if any). If none is specified then the default rate schedule number will be used. |
|
OR |
|
|
|
|
client_alt_rate_schedule_id |
string |
100 |
Client-defined alternate rate schedule number to assign (if any). If none is specified, the default rate schedule number will be used. |
|
num_plan_units |
long |
38 |
The number of plan units to assign for this supplemental plan |
|
contract_type_no |
long |
|
The contract type for this supplemental plan assignment
Allowable values for contract_type_no:
Values |
Description |
1 |
Suspend service and billing |
2 |
Continue existing service without contract |
3 |
Renew existing contract automatically |
4 |
Continue service without contract w/standard rates |
5 |
Suspend service and billing - prorate final invoice |
|
|
contract_alt_recur_fee |
double |
12 |
This amount will be billed each month instead of the current recurring service rate. If there are multiple recurring services related to this plan, the rate associated with the current recurring service that has the lowest service_no will be replaced. This alternate recurring fee will go into effect starting on the new contract's effective date. |
|
contract_length_months |
long |
4 |
Length of contract in months |
|
OR |
|
|
|
|
contract_end_date |
string |
|
Allows the caller to set a specific end date when creating or modifying plan contracts. |
|
contract_cancel_fee |
double |
38 |
Contract cancellation fee. |
|
contract_comments |
string |
300 |
Free-form comments about this contract |
|
contract_start_date |
string |
|
The date, in yyyy-mm-dd format, that the contract goes into effect |
|
offset_months |
long |
8 |
For plan recurring intervals of longer than one month, the number of months to offset proration and first bill date |
|
auto_offset_months_option |
long |
1 |
Automatically set the offset for the billing anniversary month.
Allowable values for auto_offset_months_option:
Values |
Description |
1 |
sync to master plan recurring bill thru date |
2 |
sync to old supplemental plan recurring bill thru date (only applies to replace_supp_plan API) |
|
|
offset_interval |
long |
1000 |
If assigning a change on an anniversary day, the number of billing periods by which to delay that change |
|
do_write |
string |
5 |
Boolean indicator informing Aria whether or not to actually perform the requested plan assignment/de-assignment. If 'false' is passed in this field Aria will, if applicable, calculate any potential proration effect that would result from this call and return that value in the output field 'proration_result_amount' described below without actually performing the requested operation or charging/crediting the account. This is useful to interfaces that wish to present the user with a 'confirmation page' informing of the would-be effects of the requested operation prior to actually performing it.
Allowable values for do_write:
Values |
Description |
true |
true |
false |
false |
|
|
comments |
string |
3000 |
Additional explanatory text relating to this API call. |
|
client_receipt_id |
string |
50 |
Client-defined unique identifier used to track related system actions |
|
alt_proration_start_date |
string |
14 |
The date, in yyyy-mm-dd format, from which the proration calculations begin. If this field is NULL, then the proration calculations begin from the current date. This date cannot be before the beginning of the current billing period. |
|
coupon_codes |
string array |
30 |
Array of pre-defined strings, particular to this client_no, that point to a templated credit rule. |
|
effective_date |
string |
|
If the assignment directive is for a future date assignment, this is the date, in yyyy-mm-dd format, on which the plan change will be executed. If this field is NULL, then the plan change will not happen until it is manually executed or until the effective_date is updated. |
|
sync_mstr_bill_dates_override |
long |
4 |
Overrides the client-level setting that determines whether or not master plan billing dates should be reset when assigning a new supplemental plan. If this value is left empty, the client-level setting will take effect.
Allowable values for sync_mstr_bill_dates_override:
Values |
Description |
1 |
Do not reset master plan billing dates. |
2 |
Reset master plan billing dates if master plan is "free", the account has no "billable" supplemental plans, and the newly-assigned supplemental plan is "billable". |
3 |
Reset master plan billing dates if master plan is "free" and the account has no active supplemental plans. |
|
If this value is left empty, the client-level setting will take effect. |
|
|
supp_plan_surcharges |
array |
|
|
|
surcharge_no |
long |
|
The Surcharge number to be attached to the plan |
|
rate_schedule_no |
long |
|
The Schedule number for this surcharge |
|
surcharge_supp_plan_no |
long |
|
The Plan number for assign the surcharge |
|
new_acct_custom_rates |
array |
|
|
|
custom_rate_plan_no |
long |
|
Plan number for the new custom rate |
|
OR |
|
|
|
|
client_custom_rate_plan_id |
string |
100 |
Unique client-defined identifier for the custom rate plan number. |
|
custom_rate_service_no |
long |
|
Service number for the new custom rate |
|
OR |
|
|
|
|
client_custom_rate_service_id |
string |
100 |
Unique client-defined identifier for the custom rate service number. |
|
custom_rate_seq_no |
long |
|
Sequence number for this line of the rate schedule |
|
custom_rate_from_unit |
long |
|
Tiered pricing, "FROM" unit |
|
custom_rate_to_unit |
long |
|
Tiered pricing, "TO" unit |
|
custom_rate_per_unit |
double |
|
Rate to charge per unit on this tier |
|
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. |
|
application_id |
string |
300 |
The application identifier in which the API is being used in. (Example: “Sales Force”) |
|
application_date |
string |
300 |
The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. |