Home > Aria6 User Documentation > Aria6 core api > assign_supp_plan_multi

assign_supp_plan_multi

Assigns multiple supplemental plans to a specified account.

Input Arguments

Req Field Name Field Type Max Length Description
Asterisk_0807a.jpg client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
Asterisk_0807a.jpg auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
Asterisk_0807a.jpg 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.
Asterisk_0807a.jpg supp_plans_to_assign array    
Asterisk_0807a.jpg Subarray_0807a.jpgsupp_plan_no long   Supplemental plan number to assign
  OR      
  Subarray_0807a.jpgclient_supp_plan_id string 100 Client-defined supplemental plan ID.
  Subarray_0807a.jpgalt_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      
  Subarray_0807a.jpgclient_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.
  Subarray_0807a.jpgnum_plan_units long 38 The number of plan units to assign for this supplemental plan
  Subarray_0807a.jpgcontract_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
  Subarray_0807a.jpgcontract_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.
  Subarray_0807a.jpgcontract_length_months long 4 Length of contract in months
  OR      
  Subarray_0807a.jpgcontract_end_date string   Allows the caller to set a specific end date when creating or modifying plan contracts.
  Subarray_0807a.jpgcontract_cancel_fee double 38 Contract cancellation fee.
  Subarray_0807a.jpgcontract_comments string 300 Free-form comments about this contract
  Subarray_0807a.jpgcontract_start_date string   The date, in yyyy-mm-dd format, that the contract goes into effect
  Subarray_0807a.jpgoffset_months long 8 For plan recurring intervals of longer than one month, the number of months to offset proration and first bill date
  Subarray_0807a.jpgauto_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)
  Subarray_0807a.jpgoffset_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.
  Subarray_0807a.jpgcoupon_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    
  Subarray_0807a.jpgsurcharge_no long   The Surcharge number to be attached to the plan
  Subarray_0807a.jpgrate_schedule_no long   The Schedule number for this surcharge
  Subarray_0807a.jpgsurcharge_supp_plan_no long   The Plan number for assign the surcharge
  new_acct_custom_rates array    
  Subarray_0807a.jpgcustom_rate_plan_no long   Plan number for the new custom rate
  OR      
  Subarray_0807a.jpgclient_custom_rate_plan_id string 100 Unique client-defined identifier for the custom rate plan number.
  Subarray_0807a.jpgcustom_rate_service_no long   Service number for the new custom rate
  OR      
  Subarray_0807a.jpgclient_custom_rate_service_id string 100 Unique client-defined identifier for the custom rate service number.
  Subarray_0807a.jpgcustom_rate_seq_no long   Sequence number for this line of the rate schedule
  Subarray_0807a.jpgcustom_rate_from_unit long   Tiered pricing, "FROM" unit
  Subarray_0807a.jpgcustom_rate_to_unit long   Tiered pricing, "TO" unit
  Subarray_0807a.jpgcustom_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.
   Subarray_0807a.jpgqualifier_name string 100 Name of the field you want to associate with this API call.
   Subarray_0807a.jpgqualifier_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.
 

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.
proration_result_amount double The currency amount of any resulting proration action performed as a result of the requested plan change. For plan assignments with an assignment directive of '1' (perform on anniversary date), or '2' (honor client default proration action) when the default configuration is to not do proration, or '3' (force no proration), the value returned in this field will always be '0'. When proration is performed the value returned in this field will either be a positive currency value (indicating a resulting charge to the account) or a negative currency value (indicating a credit to the account). If the value passed in field do_write is false then any positive or negative value returned in this field is notational only, demonstrating what proration effect would be applied to the account if the requested plan assignment/de-assignment were to be actually performed.
invoice_no long The unique identifier of a given invoice.
multi_sp_invoice_line_items hash  
 Subarray_0807a.jpgline_no long Specifies the sequential line number of this line item. Initial record value is always 1.
 Subarray_0807a.jpgline_type long Specifies the type of charge or credit associated with this line item.
Values Description
1 Recurring Charge
2 Tax Charge
3 Service Credit
4 Coupon Credit
5 Activation Charge
6 Usage Charge
7 Recurring Arrears
8 Order Charge
9 Surcharge
 Subarray_0807a.jpgservice_no long Specifies the Aria-assigned unique service identifier.
 Subarray_0807a.jpgservice_name string Specifies the name corresponding to this line item's service code.
 Subarray_0807a.jpgline_units double Specifies the number of units of this service code billed on this line item. On a prorated invoice, line_units = line_base_units X proration_factor.
 Subarray_0807a.jpgrate_per_unit double Specifies the rate per unit billed.
 Subarray_0807a.jpgline_amount double Specifies the total charge associated with this line item.
 Subarray_0807a.jpgline_base_units double Specifies the full, non-prorated number of units of the service code.
 Subarray_0807a.jpgproration_factor double Specifies the percentage of the line_base_units billed.
 Subarray_0807a.jpgdescription string Specifies the description of this line item.
 Subarray_0807a.jpgdate_range_start string Specifies the start date of the date range covered by this line item in yyyy-mm-dd format.
 Subarray_0807a.jpgdate_range_end string Specifies the end date of the date range covered by this line item in yyyy-mm-dd format.
 Subarray_0807a.jpgcredit_coupon_code string Specifies the coupon code applied to the invoice.
 Subarray_0807a.jpgplan_no long Specifies the Aria-assigned service plan number under which this line item was billed.
 Subarray_0807a.jpgplan_name string Specifies the name of the service plan associated with the plan_no.
 Subarray_0807a.jpgclient_service_id string A multidimensional array of client-defined Service ID for this plan.
 Subarray_0807a.jpgclient_plan_id string Client-defined Plan ID for which to query available child plans
collection_error_code long If a collection is attempted, returns the error code associated with the collection.
collection_error_msg string The error message associated with collection_error_code.
statement_error_code long The error code generated when attempting to create the statement resulting from this call, if any
statement_error_msg string The text message associated with 'statement_error_code'
proc_cvv_response string The processor return code from CVV validation.
proc_avs_response string Processor return code from address validation
proc_cavv_response string The processors return code for security validation.
proc_status_code string The processor status code
proc_status_text string The processors status description
proc_payment_id string The processor payment ID
proc_auth_code string Authorization code provided by the issuing bank
proc_merch_comments string Additional information passed to payment processor
total_charges_before_tax double Total amount to be charged to the account before taxes have been calculated.
total_tax_charges double Total taxes as calculated for the amount of the transaction.
total_charges_after_tax double Total amount to be charged to the account after taxes have been calculated.
total_credit double The total amount of the credit to be applied to the account
total_tax_credit double The tax amount of the credit to be applies
total_credit_before_tax double The credit to be applied before tax is taken into account
total double The grand total of this invoice
expectd_activation_fee double The predicted activation fee based on activation fee charges on supplemental plans on this invoice
expectd_mthly_recurring_cost double The predicted monthly recurring cost of the items and plans on this invoice
expectd_annu_recurring_cost double The predicted annual recurring cost of the items and plans on this invoice
third_party_errors hash Errors from third-party systems like taxation engines are returned here. Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return.
 Subarray_0807a.jpgerror_class string Type of error code being represented, such as taxation
 Subarray_0807a.jpgerror_code string Aria-assigned error identifier. 0 indicates no error.
 Subarray_0807a.jpgerror_msg string Description of any error that occurred. "OK" if there was no error.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®