Home > Aria6 User Documentation > Aria6 core api > modify_acct_plan_unit_instances

modify_acct_plan_unit_instances

Enables adding and removing specific plan unit instances associated with the 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.
  plan_units array   Array of plan units associated with the account
  Subarray_0807a.jpgplan_no long 22 Plan for which additional unit(s) will be assigned on the account.
  OR      
  Subarray_0807a.jpgclient_plan_id string 100 Client-defined id of the plan for which additional unit(s) will be assigned on the account.
  Subarray_0807a.jpgplan_unit_inst_no long 22 The unique identifier of the plan unit instance to be removed.
  OR      
  Subarray_0807a.jpgclient_plan_unit_inst_id string 100 The client-defined identifier of the plan unit instance to be removed.
Subarray_0807a.jpgassignment_directive long 8 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
  Subarray_0807a.jpgnew_plan_units double   Number of additional units of the specified plan to be assigned to the account
  Subarray_0807a.jpgnew_client_plan_unit_inst_id string array 100 Client-defined id to be used for a given plan unit being assigned to the account.
  do_write string   Boolean indicator indicating whether the system should actually perform the fulfillment change. If 'false' is passed in this field then 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
  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.  Allowable Values
invoice_no long The unique identifier of a given invoice.
supp_plan_line_items hash Array of invoice line items resulting from the plan modification.
 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 defiend Service id for this plan.
 Subarray_0807a.jpgclient_plan_id string Client defined Plan ID for which to query available child plans
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
proration_credit_result_amount double The pro-rated credit amount for this invoice
proration_credit_amount double The pro-rated credit amount for this invoice
proration_tax_amount double The pro-rated tax credit amount for 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 ®