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

 

Home > Aria Crescendo core api > edit_acct_plan_queued_changes_m

edit_acct_plan_queued_changes_m

Modifies an existing queued plan change for a given plan instance. Supported actions include immediately executing a queued plan change, deleting a queued plan change, or modifying the effective date of a queued plan change.

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.
  OR      
  client_acct_id string 50 Client-defined account identifier.
edit_queued_changes array    
  queue_id long   Unique identifier associated with a specific queued plan change
  OR      
  plan_instance_no long   The unique identifier of the plan instance.
  OR      
  client_plan_instance_id string 100 The client-defined identifier of the plan instance. If no queue_id is provided, then the modifications submitted for the specified plan instance will be applied to all existing queued plan changes for that plan instance. If no queue_id or plan instance is provided, then the modifications submitted for the specified account will be applied to all existing queued plan changes for all plan instances on that account.
queue_edit_directive long 8 Determines what edit action to perform on an existing queued plan change.   Allowable Values
  new_effective_date string 100 Modifies the effective date of a queued plan change. Valid only when queue_edit_directive = 2, otherwise this input will be ignored.
  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
  offset_months long 4 Number of months to add to the prorated period.
  alt_proration_start_date string 14 Applicable only for master plan replacement, same as current for update_master_plan.
  auto_offset_months_option long 1 Applicable only for supplemental plan replacement, otherwise same as current.
  offset_interval long 4 Applicable only for supplemental plan replacement, otherwise same as current. 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 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. For supplemental plan replacement: If left blank, use the new client parameter 'Automatically Reset Plan Billing Dates on 1st Paid Supplemental Plan Change' to determine which reset billing date option to apply. Ignore if submitted for master plan replacement.   Allowable Values
  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
  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
  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 Description of any error that occurred. "OK" if there was no error.
queued_changes hash  
queue_id long Unique identifier associated with a specific queued plan change.
plan_instance_no long The unique identifier of the plan instance.
client_plan_instance_id string The client-defined identifier of the plan instance.
edit_queued_change_status_cd long The status of the modification submitted for each queued plan change.   Allowable Values
edit_queued_change_status_label string The status of the modification submitted for each queued plan change.
invoice_info hash  
invoice_no long The unique identifier of the invoice, if any, created automatically by Aria in conjunction with this call.
billing_group_no long The billing group number mapped against each master plan.
client_billing_group_id string Client-defined billing group ID.
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_charges_before_tax double Charges before tax on the initial invoice for this account
invoice_tax_charges double Tax charges on the initial invoice for this account
invoice_charges_after_tax double The sum of invoice_charges_before_tax and invoice_tax_charges
invoice_credit_amount double The amount of credit on the initial invoice for this account
invoice_total_amount double The total owed on the initial invoice for this account
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 applied.
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_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 fulfillment based plan unit instance were to be actually assigned.
expected_monthly_rec_cost double The predicted monthly recurring cost of the items and plans on this invoice.
expected_annual_rec_cost double The predicted annual recurring cost of the items and plans on this invoice.
invoice_items hash  
invoice_line_no long The line number on the initial invoice
plan_no long The unique ID plan this line represents
client_plan_id string The client-defined unique ID for plan this line represents
plan_instance_no long Unique plan instance number for each assigned master plan.
client_plan_instance_id string Unique client-defined ID for each assigned master plan.
plan_name string The name of the plan this line represents
service_no long The unique ID for the service this line represents
client_service_id string The client-defined unique ID for the service this line represents
service_name string The name of the service this line represents
service_coa_id long The Chart of Accounts ID for the service this line represents
client_service_coa_code string The client-defined Chart of Accounts code for the service this line represents
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 The subtotal amount of this line
line_description string The long description of this line, used when printing or otherwise displaying invoices
start_date_range string The starting date range for the item or plan on this line
end_date_range string If any, the ending date range for the item or plan on this line.
line_type long Specifies the type of charge or credit associated with this line item.
base_plan_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.
proration_text string Specifies the prorated days in total days.
proration_remaining_days long Prorated days of period in this invoice
proration_description string Prorated invoice description.
credit_coupon_code string Specifies the coupon code applied to the invoice.
client_sku string The client-defined item identifier.
order_no long The unique identifier for an order in the context of an client_no and account_no.
item_no long The unique ID of the item being retrieved.
client_item_id string The unique client-defined item ID being retrieved.
adv_billing_period_total_days long Total days of period in this invoice.
rate_schedule_no long Aria-assigned unique rate schedule number.
rate_schedule_tier_no long Sequential number in the rate schedule for determining tiers.
proration_details hash  
plan_instance_no long The unique identifier of the plan instance.
client_plan_instance_id string The client-defined identifier of the plan instance.
proration_result_total_amount double Plan proration total amount
proration_amount double Plan proration amount
proration_tax_amount double Plan proration tax amount
proration_surcharge_amount double Plan proration surcharge amount
proration_credit_amount double Plan proration credit amount
billing_errors hash  
invoicing_error_code long Aria-defined error code specific to any error encountered during any invoicing/billing processes performed inline as a result of this method call.
invoicing_error_msg string The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code".
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'
billing_group_no long The billing group number mapped against each master plan.
client_billing_group_id string Client-defined billing group ID

You must to post a comment.
Last modified
10:41, 9 May 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.