Home > Aria6 User Documentation > Aria6 core api > update_acct_plan_unit_instance


Updates a specific plan unit instance.

Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria generated unique identifier for the account
required-icon.png client_acct_id string 50 This is the client-assigned identifier for the account.
required-icon.png plan_unit_inst_no long 22 Aria unique Plan Unit Instance Number.
required-icon.png client_plan_unit_inst_id string 22 Client-assigned identifier for the plan unit instance.
  new_client_plan_unit_inst_id string 22 New client-assigned identifier for the plan unit instance, which will replace the existing client-assigned identifier currently on the plan unit instance.'
  plan_unit_inst_services array   This return value of array of plan unit instance.
  brd_arrow.gif service_no long   Aria service number (only for fulfillment based service) for which the fulfillment information needs to be modified.
  brd_arrow.gif client_service_id string 100 Client-assigned identifier for the service.
  brd_arrow.gif service_fulfillment_date string   It is a Fulfillment completion date. It can be in past, today or future date.
  brd_arrow.gif fulfillment_directive long 8 This derives whether the fulfillment date should be assigned/modified or removed from the fulfillment based service on then plan unit instance.  
Values Description
1 Complete fulfillment with immediate affect (Default option). This would be accomplished by specifying fulfillment date in past or today or without any fulfillment date.
2 Complete fulfillment with effective date specified in future. A user must specify service_fulfillment_date with this directive.
3 Remove the already assigned fulfillment date.
  plan_unit_inst_fields array   Array of client-defined plan unit instance fields.
  brd_arrow.gif field_name string   Field name of plan unit instance field
  brd_arrow.gif field_value string   The value stored under this field
  brd_arrow.gif plan_unit_inst_directive long 8 The directive is mandatory if field name/value pair are specified.  
Values Description
1 Add Value
2 Replace Value
3 Remove Value
  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.  
Values Description
true true
false false
  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.
   brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
   brd_arrow.gif 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.

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.
out_acct_no long Aria generated unique identifier for the account
out_client_acct_id string This is the client-assigned identifier for the account.
out_plan_unit_inst_no long Aria unique Plan Unit Instance Number.
out_client_plan_unit_inst_id string Client-assigned identifier for the plan unit instance.
proration_result_amount double The currency amount of any resulting proration action performed as a result of the fulfillment based service unit assignment. When proration is performed the value returned in this field will be a positive currency value (indicating a resulting charge to the account). If the value passed in field do_write is false then any positive value returned in this field is notational only, demonstrating what proration effect would be applied to the account if the requested fulfillement based plan unit instance were to be actually assigned.
invoice_no long The unique identifier of a given invoice.
invoice_line_items hash  
 brd_arrow.gif line_no long Specifies the sequential line number of this line item. Initial record value is always 1.
 brd_arrow.gif line_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
 brd_arrow.gif service_no long Specifies the Aria assigned unique service identifier.
 brd_arrow.gif service_name string Specifies the name corresponding to this line item's service code.
 brd_arrow.gif 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.
 brd_arrow.gif rate_per_unit double Specifies the rate per unit billed.
 brd_arrow.gif amount double Specifies the total charge associated with this line item.
 brd_arrow.gif base_plan_units double Specifies the full, non-prorated number of units of the service code.
 brd_arrow.gif proration_factor double Specifies the percentage of the line_base_units billed.
 brd_arrow.gif description string Specifies the description of this line item.
 brd_arrow.gif date_range_start string Specifies the start date of the date range covered by this line item in yyyy-mm-dd format.
 brd_arrow.gif date_range_end string Specifies the end date of the date range covered by this line item in yyyy-mm-dd format.
 brd_arrow.gif credit_coupon_code string Specifies the coupon code applied to the invoice.
 brd_arrow.gif plan_no long Specifies the Aria assigned service plan number under which this line item was billed.
 brd_arrow.gif plan_name string Specifies the name of the service plan associated with the plan_no.
 brd_arrow.gif client_service_id string A client defiend Service id for this plan.
 brd_arrow.gif client_plan_id string Client defined Plan ID
 brd_arrow.gif usage_type_no long The usage type code associated with this line item
 brd_arrow.gif credit_reason_code_description string The long description of the credit reason code which was applied, if any
 brd_arrow.gif csr_comments string The manually-entered CSR comments, if any
 brd_arrow.gif client_sku string The client-defined item identifier
 brd_arrow.gif order_no long The unique identifier for an order in the context of an client_no and account_no.
 brd_arrow.gif item_no long The unique ID of the item being retrieved
 brd_arrow.gif usage_type_cd string An array containing usage_type_cd(s) to denote which usage type(s) to record.
 brd_arrow.gif proration_text string Specifies the prorated days in total days.
 brd_arrow.gif adv_billing_period_total_days long Total days of period in this invoice.
 brd_arrow.gif proration_remaining_days long Prorated days of period in this invoice.
 brd_arrow.gif proration_description string Prorated invoice description.
 brd_arrow.gif rate_schedule_no long Aria-assigned unique rate schedule number
 brd_arrow.gif rate_schedule_tier_no long Sequential number in the rate schedule for dertermining tiers
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_monthly_rec_cost double The predicted monthly recurring cost of the items and plans on this invoice
expectd_annual_rec_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.
 brd_arrow.gif error_class string Type of error code, such as taxation.
 brd_arrow.gif error_code string Error code returned by the third-party system.
 brd_arrow.gif error_msg string Error message returned by the third party system.
Last modified


This page has no custom tags.


This page has no classifications.