Skip to main content
Aria Knowledge Central

edit_acct_plan_queued_changes_m

  1. Last updated
  2. Save as PDF

Summary

API Name edit_acct_plan_queued_changes_m
Class account_services_m
Update Version 56

Description

Use this API to modify all existing queued plan changes for an account, or to modify queued plan changes for a specific plan instance. If a plan instance or queue id is not specified, then the API will process all queued plan changes for the account. Supported actions include immediately executing a queued plan(s) change, deleting a queued plan(s) change, or modifying the effective date of a queued plan(s) change.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 No

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
edit_queued_changes object   Yes

See fields below
do_write string 5 No

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'

Allowed values:

Value Description
True  
False  

edit_queued_changes fields

Name Type Length Required Description
queue_id long 22 No

The unique identifier associated with a specific queued plan change. If no queue_id is provided, then the edit action 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 edit action submitted for the specified account will be applied to all existing queued plan changes for all plan instances on that account.

Alternative field: plan_instance_no or client_plan_instance_id
plan_instance_no long   No

The unique identifier of the plan instance. If no queue_id is provided, then the edit action 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 edit action submitted for the specified account will be applied to all existing queued plan changes for all plan instances on that account.

Alternative field: queue_id or client_plan_instance_id
client_plan_instance_id string 100 No

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.

Alternative field: queue_id or plan_instance_no
queue_edit_directive long 1 Yes

Determines what edit action to perform on an existing queued plan change.

Allowed values:

Value Description
0 Delete queued plan change
1 Execute queued plan change immediately
2 Change the effective date of the queued plan change
new_effective_date string 10 No

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 2 No

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.

Allowed values:

Value Description
1 Perform the requested plan change on the account's next scheduled billing anniversary date. The account does receive service under this plan (for plan assignments) or have it removed (for de-assignments) until that date. If a plan is being assigned, initial billing for a full period of the given plan is performed on the account's next scheduled anniversary date. No charge or credit proration effect. No new invoice/charges are generated when no proration occurs.
2 Perform the requested plan change immediately, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan assignment or de-assignment. No new invoice/charges are generated when no proration occurs. (default)
3 Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION. No new invoice/charges are generated when no proration occurs.
4 Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION.
5 Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY. NOTE: This value is not permitted when cancelling supplemental plans.
6 Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY. NOTE: This value is not permitted when assigning supplemental plans.
7 Perform the requested plan change on the specified effective_date, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan assignment or de-assignment. No new invoice/charges are generated when no proration occurs.
8 Perform the requested plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION. No new invoice/charges are generated when no proration occurs.
9 Perform the requested plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION.
10 Perform the requested plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY. NOTE: This value is not permitted when cancelling a supplemental plan.
11 Perform the requested plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY. NOTE: This value is not permitted when assigning a supplemental plan.
offset_months long 4 No

Number of months to add to the prorated period. This override will not be honored for account-level processing (meaning all plan queued changes in the account.)
alt_proration_start_date string 10 No

Applicable only for master plan replacement/cancellation, supplemental plan assignment/replacement/cancellation scenarios. For rest of the cases the previously saved value will be used. This override will not be honored for account-level processing.
auto_offset_months_option long 1 No

Applicable only for supplemental plan replacement, supplemental plan assignment scenarios. For rest of the cases the previously saved value will be used. This override will not be honored for account level processing.
offset_interval long 4 No

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 anniversary date. Also applicable for supplemental plan assignment scenario. This override will not be honored for account-level processing.
invoice_unbilled_usage string 5 No

Specifies whether to invoice the unbilled usage if a plan is terminated in the middle of a billing period. This override will not be honored for account level processing.

Allowed values:

Value Description
False Do not allow invoicing the unbilled usage during mid-term plan termination.
True Allow invoicing the unbilled usage during mid-term plan termination.
force_supp_bill_date_reset long 1 No

Note: This field is deprecated. Aria no longer supports force_supp_bill_date_reset.
force_master_bill_date_reset long 1 No

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.

Allowed values:

Value Description
Null If this value is left empty, the client-level setting (Sync_mstr_bill_dates_on_1st_supp) will take effect.
1 Do not reset master plan billing dates.
2 Reset master plan billing dates if master plan is "free", the account has no "billable" supplemental plans, and the newly-assigned supplemental plan is "billable.
3 Reset master plan billing dates if master plan is "free" and the account has no active supplemental plans.
force_bill_date_reset long 1 No

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.

Allowed values:

Value Description
Null Reset the billing dates when the status changes from non-billable to billable depending on client parameter 'AUTO_RESET_MASTER_PLAN_BILLING_DATES_ON_NON_BILLABLE_TO_BILLABLE_MASTER_PLAN_STATUS_CHANGE' setting.
0 Do not reset the billing dates for this plan.
1 Reset the billing anniversary date to coincide with the status change date.
2 Reset the billing anniversary date to coincide with the current anniversary date.
3 Reset the billing anniversary date to coincide with next future anniversary date by offsetting with its billing interval.

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
queued_changes object   No

See fields below
invoice_info object   No

See fields below
proration_details object   No

See fields below
billing_errors object   No

See fields below
installments_updated object   No

Array of results of installment updates.

See fields below

queued_changes fields

Name Type Length Required Description
queue_id long   No

Unique identifier associated with a specific queued plan change.
plan_instance_no long   No

The unique identifier of the plan instance.
client_plan_instance_id string   No

The client-defined identifier of the plan instance.
edit_queued_change_status_cd long 30 No

The status of the modification submitted for each queued plan change.

Allowed values:

Value Description
0 Deleted
1 Effective date modified
2 Executed successfully
3 Failed to execute
edit_queued_change_status_label string   No

The status of the modification submitted for each queued plan change.

invoice_info.bg_proc_fraud_filtering_info fields

Name Type Length Required Description
proc_fraud_filter_invoice_no     No  
proc_fraud_country_status     No  
proc_fraud_country_code     No  

invoice_info.proc_payment_response_field_list fields

Name Type Length Required Description
proc_pmt_resp_fld_invoice_no     No  

invoice_info.installment_schedule_info fields

Name Type Length Required Description
installment_no     No  

invoice_info fields

Name Type Length Required Description
bg_proc_fraud_filtering_info object   No

See fields below
proc_payment_response_field_list object   No

Payment response fields returned by the processor for further actions if any.

See fields below
installment_schedule_info object   No

Installment schedule info array.

See fields below

proration_details fields

Name Type Length Required Description
plan_instance_no long   No

The unique identifier of the plan instance.
client_plan_instance_id string   No

The client-defined identifier of the plan instance.
proration_result_total_amount double   No

Plan proration total amount
proration_amount double   No

Plan proration amount
proration_tax_amount double   No

Plan proration tax amount
proration_surcharge_amount double   No

Plan proration surcharge amount
proration_credit_amount double   No

Plan proration credit amount

billing_errors fields

Name Type Length Required Description
invoicing_error_code long   No

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   No

The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code".
collection_error_code long   No

If a collection is attempted, returns the error code associated with the collection.
collection_error_msg string   No

The error message associated with collection_error_code.
statement_error_code long   No

The error code if statement generation fails.
statement_error_msg string   No

The text message associated with 'statement_error_code'
billing_group_no long 22 No

The billing group number mapped against each master plan.
client_billing_group_id string 100 No

Client-defined billing group ID

installments_updated fields

Name Type Length Required Description
installment_no long   No

Aria assigned installment schedule no.
installment_operation string   No

Indicates what operation was performed on each installment.
installment_operation_detail string   No

Describes the operation detail done on each installment.
installment_collection_error_code long   No

If a collection for a cancelled installment is attempted, returns the error code associated with the collection.
installment_collection_error_msg string   No

The error message associated with installment_collection_error_code.
installment_collected_amount double   No

Collected amount upon cancelled installment.
installment_payment_transaction_id long   No

Payment transaction ID related to collected amount upon cancelled installment.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.