Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo core api > update_acct_plan_m

update_acct_plan_m

Changes the rate schedule and/or the number of units of a plan assigned to a specified account.

Input Arguments

Req Field Name Field Type Max Length Description
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.
  plan_instance_no long 22 The unique identifier of the new plan replacing the existing plan on the instance.
  OR      
  client_plan_instance_id string 100 The client-defined identifier of the new plan replacing the existing plan on the instance.
  alt_rate_schedule_no long 8 Alternative Rate Schedule Number. The alt_rate_schedule_no is the unique identifier for an alternative rate schedule that can be assigned to the account holder in place of the default rate schedule. This is often done by CSR's to provide special compensation or discounts as incentives to account holders.
  OR      
  client_alt_rate_schedule_id string 100 Client-defined alternate rate schedule identifier to assign (if any). If none is specified, the default rate schedule number will be used.
  plan_units double   The units of the plan added at this change
  coupon_codes string array 30 The coupon codes to assign to this master plan instance, if any
  promo_cd string 30 This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans.
  plan_status long   Updates the plan status for the plan instance.   Allowable Values
  plan_instance_description string 1000 Updated the description for the plan instance.
  plan_instance_field_update array    
  plan_instance_field_name string 100 Required based on the definition of each plan instance field associated with the new plan.
  plan_instance_field_value string 100 Required based on the definition of each plan instance field associated with the new plan.
  plan_instance_field_directive long 8 Required for each plan instance field provided.   Allowable Values
  assignment_directive long 8 The scope rule to be applied to this immediate assignment request, governing the proration rule that should be applied. Default behavior is to assign plan to account or increment units on existing plan immediately based on client-defined default proration rule, resulting in appropriate prorated charge and credit.   Allowable Values
  comments string 500 Additional explanatory text relating to this API call.
  do_write string   Boolean indicator informing Aria whether or not to actually perform the requested operation. If 'false' is passed in this field Aria will, if applicable, calculate any potential effects stemming from this call such as proration, plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to 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. Do_write defaults to 'true'   Allowable Values
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  custom_rates array   An array of custom rates for the specified account number
  custom_rate_service_no long   The unique identifier for the service no, relative to the value provided in corresponding "custom_rate_plan_no", to which this custom rate is to be applied for this account.
  OR      
  custom_rate_client_service_id string 100 The unique identifier by client the service ID to determine which custom rate is to be applied for this account.
  custom_rate_seq_no long   The rate tier number, relative to the values provided in corresponding "custom_rate_plan_no" and "custom_rate_service_no", to which this custom rate is to be applied for this account.
  custom_rate_from_unit long   The unit starting point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  custom_rate_to_unit long   The unit ending point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  custom_rate_per_unit double   The custom rate per unit, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to be applied for this account.
  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.
  offset_interval long   If assigning a change on an anniversary day, the number of billing periods by which to delay that change
  force_master_bill_date_reset long 1 Determines whether to reset the billing dates to either the status change date or current anniversary date, reset the billing dates when the status changes from non-provisionable to provisionable depending on client parameter 'RESET_DATES_ON_REPROVISIONED_STATUS' setting, or not reset at all.   Allowable Values
  new_client_plan_inst_id string 100 identifier for a parent account master plan. Required if resp_level_cd is 2 or 3.
  dunning_state long 100 Dunning state assigned to the master plan instance. In Progress indicates the master plan is in dunning. None indicates the master plan is not in dunning. Note that dunning state is applicable only for master plans and is set to Complete by the system once the dunning process is completed.   Allowable Values
  degrade_date string 100 Date on which the Dunning Manager evaluates whether the master plan should be advanced to the next step of the dunning process. Applicable only for master plans, and only if the dunning_state is set to 1.
  resp_level_cd long 8 The responsibility level code. These are values 1 through 4 as described in the legend for this argument.   Allowable Values
  parent_acct_master_plan_inst_id string 100 Unique identifier of a plan in the plan instance hierarchy under which the new plan will be assigned.
  usage_accumulation_reset_months long   The number of reset months for each plan
  usage_pooling string 32 The client-defined plan ID on which to enable usage pooling
  usage_threshold_applicability string 100 Usage tracking options on the plans in the account   Allowable Values
  mp_surcharges array   Surcharge for master plan
  mp_surcharge_no long 22  
  mp_surcharge_directive long 1 The surcharge directive to assign/remove the surcharge from the master plan instance   Allowable Values
  mp_rate_schedule_no long 22  
  proration_invoice_timing long   Determines whether to create a separate invoice for prorated charges immediately, or defer to the next anniversary date. Note that this will override the Proration Invoice Timing configuration saved with the plan in the product catalog.   Allowable Values
  po_num string 100 Purchase order number assigned to the plan instance.
  plan_update_services array   List of services associated with the plan being assigned or updated on the account.
  service_no long   The Aria-assigned unique identifier for the service associated with the plan.
  OR      
  client_service_id string 100 The client-defined identifier for the service associated with the plan.
  svc_location_no long   The Aria-assigned unique identifier for the origin location for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.
  client_svc_location_id string   The client-defined unique identifier for the origin location for the service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.
  dest_contact_no long 1 The Aria-assigned unique identifier for the destination contact for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
  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.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Textual 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.
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 if statement generation fails.
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
invoice_no long The unique identifier of a given invoice.
expectd_activation_fee double The activation fee the account holder can expect based on the activation fees of the plans on this invoice
expectd_mthly_recurring_cost double Regardless of the billing interval on the account, the monthly recurring cost of this change
expectd_annu_recurring_cost double  
acct_plan_line_items hash  
line_no long The line number on the initial invoice
line_type long Specifies the type of charge or credit associated with this line item.   Allowable Values
service_no long The unique ID for the service this line represents
service_name string The name of the service this line represents
line_units double The number of units of the item or plan on this line
rate_per_unit double The charge per unit of the item or plan on this line
line_amount double Specifies the total charge associated with this line item.
line_base_units double Specifies the full, non-prorated number of units of the service code.
proration_factor double Specifies the percentage of the line_base_units billed.
description string The long description of this line, used when printing or otherwise displaying invoices
date_range_start string The starting date range for the item or plan on this line
date_range_end string If any, the ending date range for the item or plan on this line.
credit_coupon_code string Specifies the coupon code applied to the invoice.
plan_no long The unique ID plan this line represents
plan_name string The name of the plan this line represents
client_service_id string Client-defined unique service identifier.
client_plan_id string Client-defined unique Plan Identifier
po_num string Purchase order number assigned to the account or plan instance.
bill_from_address_no long Address sent as the bill-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item Note that service locations can be associated with a service for a given plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog.
ship_from_address_no long Address sent as the ship-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item Note that service locations can be associated with a service for a given plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog.
bill_to_address_no long Address sent as the bill-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the bill-to address for the invoice line item.
ship_to_address_no long Address sent as the ship-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the ship-to address for the invoice line item.
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_tax_amount double The pro-rated tax credit amount for 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

You must to post a comment.
Last modified
14:40, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.