Home > Aria Crescendo Documentation > Aria Crescendo core api > edit_acct_plan_queued_changes_m
edit_acct_plan_queued_changes_m
edit_acct_plan_queued_changes_m
Table of contents
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 an account. Supported actions include immediately executing a queued plans(s) change, deleting a queued plan)s) change, or modifying the effective date of a queued plan(s) change.
For error messages generated by this API, see edit_acct_plan_queued_changes_m Error Messages.
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. | |||||||||||||
| Start of edit_queued_changes array | ||||||||||||||||
| edit_queued_changes | array | |||||||||||||||
| Field Name | Field Type | Max Length | Description | |||||||||||||
 queue_id |
long | 22 | 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_no> 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. | |||||||||||||
| OR | ||||||||||||||||
| plan_instance_no |
long | 22 | 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_no> 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. | |||||||||||||
| 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 | 1 |
Determines what edit action to perform on an existing queued plan change. This applies to a plan with a daily, weekly, monthly, or any other billing interval. Allowable values for queue_edit_directive:
|
|||||||||||||
| new_effective_date |
string | 10 | 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 |
The rule to be applied to this assignment request, governing the proration rule is applied. This applies to a plan with a daily, weekly, monthly, or any other billing interval. 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. Not honored when queue_edit_directive = 0 (delete queue), or 1 (execute immediate) Allowable values for assignment_directive:
|
|||||||||||||
| offset_months |
long | 4 | 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 | 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 | 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 | 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 for account-level processing. | |||||||||||||
| invoice_unbilled_usage |
string | 5 | 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.
Allowable values for invoice_unbilled_usage:
|
|||||||||||||
| 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 for force_master_bill_date_reset:
|
|||||||||||||
| 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 for force_bill_date_reset:
|
|||||||||||||
| End of edit_queued_changes array | ||||||||||||||||
| 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 for do_write:
|
|||||||||||||
| 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. | |||||||||||||
| Start of optional_transaction_qualifiers array | ||||||||||||||||
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||||||||
| Field Name | Field Type | Max Length | Description | |||||||||||||
| 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. | |||||||||||||
| End of optional_transaction_qualifiers array | ||||||||||||||||
| 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 for edit_queued_change_status_cd:
|
||||||||||||||
| edit_queued_change_status_label |
string | The status of the modification submitted for each queued plan change. | ||||||||||||||
| invoice_info |
hash | |||||||||||||||
| invoice_no |
long | The Aria-assigned unique identifier of a given invoice. | ||||||||||||||
| 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 | Processors status description. | ||||||||||||||
| proc_payment_id |
string | The processors status description. | ||||||||||||||
| proc_auth_code |
string | Authorization code provided by the issuing bank. | ||||||||||||||
| proc_merch_comments |
string | Additional information passed to payment processor. | ||||||||||||||
| proc_initial_auth_txn_id |
string | Transaction ID from payment processor. If received as part of an auth request, it must be retained for future settlement and match the value from the auth response. It should also be used for future recurring transaction auths/settlement. | ||||||||||||||
| 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.
Allowable values for line_type:
|
||||||||||||||
| base_plan_units |
double | 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 | Client SKU of the NSO/Inventory item. | ||||||||||||||
| 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. | ||||||||||||||
| 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 (non-subscription offering - 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 returns 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 returns the Aria-assigned unique identifier of the contact on | ||||||||||||||
| custom_rate_ind |
long | Identifies whether this is a custom rate. A value of 1 indicates that it is a custom rate. A value of 0 indicates that it is a standard rate. | ||||||||||||||
|
|
hash | |||||||||||||||
| tax_detail_line |
long | Line number associated with each tax detail record. | ||||||||||||||
| seq_no |
long | Tax line on the invoice whih includes the tax amount associated with this tax_detail_line. | ||||||||||||||
| taxed_seq_num |
long | Invoice line item for which the tax for this tax_detail_line was calculated. | ||||||||||||||
| debit |
double | Amount of tax applied for the given tax type. | ||||||||||||||
| tax_authority_level |
long | "Tax jurisdiction code: 0 = Federal, 1 = State/Province". | ||||||||||||||
| tax_rate |
double | Rate at which tax is calculated for the tax type used by the tax engine. | ||||||||||||||
| orig_was_tax_inclusive |
long | Indicates whether the invoice line amount was tax inclusive. | ||||||||||||||
| tax_srv_tax_type_id |
string | Identifier of the tax type returned by the tax engine. | ||||||||||||||
| tax_srv_tax_type_desc |
string | Description of the tax type returned by the tax engine. | ||||||||||||||
| tax_srv_cat_text |
string | Category of the tax type returned by the tax engine. | ||||||||||||||
| tax_srv_juris_nm |
string | Jurisdiction name returned by the tax engine. | ||||||||||||||
| tax_srv_tax_sum_text |
string | Invoice summary text returned by the tax engine. | ||||||||||||||
| unrounded_tax_amount |
double | The amount multiplied by tax rate before rounding precision. Also referred to as raw tax amount. *Note: Aria internal tax rounding method set to invoice. | ||||||||||||||
| carryover_from_prev_amt |
double | The amount that is a carryover from previous unrounded tax amt. It is remainder and value can be positive or negative based on the previous remainder. *Note: Aria internal tax rounding method set to invoice. | ||||||||||||||
| before_round_adjusted_tax_amt |
double | The amount adjusted Tax before rounding precision. i.e. Sum of unrounded_tax_amt, and carryover_from_prev_amt. *Note: Aria internal tax rounding method set to invoice. |
||||||||||||||
| carryover_from_current_amt |
double | The amount that is a carryover from current unrounded tax amt. It is remainder and value can be positive or negative based on the previous remainder. *Note: Aria internal tax rounding method set to invoice. | ||||||||||||||
| bg_proc_fraud filtering_info |
hash | Fraud Filtering Response returned from Payment Processor. | ||||||||||||||
| proc_fraud_country_status |
string | Fraud country status provided by the Payment Processor. | ||||||||||||||
| proc_fraud_country_code |
string | Fraud country code provided by the Payment Processor. | ||||||||||||||
| 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 |
- © Copyright 2023 Aria Developer Central