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

 

Home > Aria Crescendo core api > replace_acct_plan_m

replace_acct_plan_m

Assigns a new master or supplemental plan to the 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 plan instance (can be either a master or supplemental plan) on which the plan will be replaced.
OR
client_plan_instance_id string 100 The client-defined identifier of the plan instance (can be either a master or supplemental plan) on which the plan will be replaced.
new_plan_no long 22 The unique identifier of the new plan replacing the existing plan on the instance.
OR
new_client_plan_id string 100 The client-defined identifier of the new plan replacing the existing plan on the instance.
new_client_plan_instance_id string 100 The new client-defined identifier for the plan 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.
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
plan_status long 2 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 rule to be applied to this assignment request, governing the proration rule is applied. Default behavior is to make the plan change (assign/deassign a plan to an account, change units on an existing plan, etc.) 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 5 Boolean indicator that specifies whether to actually perform the requested operation. If 'false' is passed in this field, Aria calculates, if applicable, any potential effects 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 want to present the user with a 'confirmation page' informing them of the potential 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
offset_months long 4 Number of months to add to the prorated period.
alt_proration_start_date string 10 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.
auto_offset_months_option long 1 Automatically set the offset for the billing anniversary month.   Allowable Values
alt_client_acct_group_id string 100 One-time collections account group to use for this specific call. Default collections group on the account is not changed.
custom_rates array An array of custom rates for the specified account number
custom_rate_service_no long 22 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 22 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 22 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 22 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 22 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 10 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 4 If assigning a change on an anniversary day, the number of billing periods by which to delay that change. If the new plan is different from the old plan, and this value is greater than 0, then the billing date continues to be the annniversary date.
invoice_unbilled_usage string 5 Specifies whether to invoice the unbilled usage if a plan is terminated in the middle of a billing period.   Allowable Values
force_supp_bill_date_reset long 1 Deprecated(Deprecated) This input is not operational. Use 'force_master_bill_date_reset' to perform this input's activity.
force_master_bill_date_reset long 1 Overrides the "Sync_mstr_bill_dates_on_1st_supp" client-level setting that determines whether or not no-charge master plan billing dates should be reset when assigning a new supplemental plan or when the supplemental plan instance status is updated to a billable status. If this value is left empty, the client-level setting will take effect.   Allowable Values
usage_accumulation_reset_months long 4 The number of reset months for each plan
usage_pooling string 5 Indicates whether usage pooling is enabled for this plan instance. Allowable values are 'true' and 'false'.   Allowable Values
usage_threshold_applicability string 2 Usage tracking options on the plans in the account   Allowable Values
proration_invoice_timing long 1 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 22 The Aria-assigned unique identifier for the service associated with the plan instance. Either this field or client_service_id is required to map plan services to the plan instance.
OR
client_service_id string 100 The client-defined identifier for the service associated with the plan instance.
svc_location_no long 22 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 100 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 22 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.
force_bill_date_reset long 1 When a master plan's status changes from non-billable to billable, this input will determine what the billing dates of the specific master plan and all associated supplemental plans anniversary date will be.   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.
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 Aria-assigned 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
service_no long The services for this plan
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 total pro-rated credit amount
proration_credit_amount double The non-tax pro-rated credit amount
proration_tax_amount double The pro-rated tax credit amount
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.
error_class string Type of error code being represented, such as taxation
error_code string Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.

You must to post a comment.
Last modified
12:52, 12 Oct 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.