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



 

Home > Aria Crescendo Documentation > Aria Crescendo core api > update_acct_plan_status_m

update_acct_plan_status_m

Sets the status of a master or supplemental plan for a given account and optionally indicates the number of days or date in the future on which the status change should go into effect. This call can also reset the billing dates on the status change date for master plans changing from a non-billable to a billable status.

For information on error messages generated by this API, see update_acct_plan_status_m error messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
required-icon.png client_acct_id string 50 Client-defined account identifier.
required-icon.png plan_instance_no long 22 The unique identifier of the plan instance (can be either a master or supplemental plan).
  OR      
  client_plan_instance_id string 100 The client-defined identifier of the plan instance (can be either a master or supplemental plan).
  status_cd long  

The status of the plan instance.

If you are updating a master plan instance, you must enter a value either in this field or in the <dunning_state> field.

If you are updating a supplemental plan, this field is required.

If you previously queued (scheduled)  custom rates to be applied to the plan instance and you do not set the status code to active (1), then the custom rates will not be applied when you call this API. However, the scheduled custom rates will remain queued on the plan instance and they will be applied when the account is switched to the provisioned (active) status in the future.  

  Allowable Values
  dunning_state long 1

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. If you are updating a master plan, you must enter a value either in this field or in the <status_cd> field.  Note that master plans cannot be canceled via update_acct_plan_status_m when dunning is in progress.

If you set this field to 1 (in progress), then you can specify one or more of the following dunning options available in these fields:

  • <degrade_date>;
  • <new_dunning_step>;
  • <config_dunning_late_fee_option>; and/or
  • <config_dunning_email_option>.

Note:

  • When you change the <dunning_state> to 0 (none), you should also pass in your chosen  <status_cd> for the MPI (master plan instance).

    Example: you may want to change the MPI's status from
    -1 (suspended) to 1 (active).
  • If you set this field to 1 (in progress) but the MPI does not have a balance due, then Aria will move the MPI out of dunning on the date on which the next dunning step begins.This applies to MPIs associated with either payment type: net terms or electronic.

 

 Allowable Values

  degrade_date string 10

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. Enter a value in this field only if the dunning_state is set to 1. Specific date for the dunning degrade date change to occur in yyyy-mm-dd format.

Applicable only for master plans, and only if the <dunning_state> is set to 1.

For more information about available dunning options, please see the <dunning state> field.

  queue_days long 12 Days to queue before the status change occurs.
  queue_date string   Specific date for the status change to occur
  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
  comments string 500 Additional explanatory text relating to this API call.
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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.
  new_dunning_step long 2

Pass in the step in the dunning process that the MPI should move to. 

Applicable only for master plans, and only if the <dunning_state> is set to 1.

For more information about available dunning options, please see the <dunning state> field.

  config_dunning_late_fee_option long 1

If the dunning step that you passed into the <new_dunning_step> field includes a late fee, specify whether to charge or suppress it.

Applicable only for master plans, and only if the <dunning_state> is set to 1.

For more information about available dunning options, please see the <dunning state> field.

Note: If you set this field to 1, Aria will immediately charge the customer the late fee.

  Allowable Values

 
config_dunning_email_option
long 1

If the dunning step that you passed into the <new_dunning_step> field includes an email notification, specify whether to send or suppress it.

Applicable only for master plans, and only if the <dunning_state> is set to 1.

For more information about available dunning options, please see the <dunning state> field.

Note: If you set this field to 1, Aria will immediately email the notification to the customer.

  Allowable Values

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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.