update_acct_plan_status_m
Summary
| API Name | update_acct_plan_status_m |
|---|---|
| Class | account_services_m |
| Update Version | 6.35 |
Description
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.
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 |
||||||||||||||||||||||||
| plan_instance_no | long | 22 | Yes |
The unique identifier of the plan instance (can be either a master or supplemental plan). Alternative required field: client_plan_instance_id |
||||||||||||||||||||||||
| client_plan_instance_id | string | 100 | Yes |
The client-defined identifier of the plan instance (can be either a master or supplemental plan). Alternative required field: plan_instance_no |
||||||||||||||||||||||||
| status_cd | long | 8 | No |
The status of this 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 are using custom account rates that were previously queued and you are not setting the status code to Active, then the custom account rates will not be applied at the time of execution. However, the queued custom rates will remain queued on the plan instance itself and they will be applied when the user switches to the provisioned status in the future. Allowed values:
|
||||||||||||||||||||||||
| dunning_state | long | 1 | No |
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. Allowed values:
|
||||||||||||||||||||||||
| degrade_date | string | 10 | No |
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. |
||||||||||||||||||||||||
| queue_days | long | 12 | No |
Days to queue before the status change occurs. |
||||||||||||||||||||||||
| queue_date | string | 10 | No |
Specific date for the status change to occur |
||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||
| comments | string | 500 | No |
Additional explanatory text relating to this API call. |
||||||||||||||||||||||||
| client_receipt_id | string | 50 | No |
Client-defined unique identifier used to track related system actions |
||||||||||||||||||||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||||||||||||||||||||
| new_dunning_step | long | No |
Determines which dunning step to place the MPI into if you are placing this MPI into dunning or for moving the step of a MPI that is already in dunning. The default is 1 (step 1). |
|||||||||||||||||||||||||
| config_dunning_late_fee_option | long | 1 | No |
Determines whether or not to use the dunning configuration setting to charge a late fee applicable to that dunning step if you are placing this MPI/BG into dunning. The default is to use the configuration setting. Allowed values:
|
||||||||||||||||||||||||
| config_dunning_email_option | long | 1 | No |
Determines whether or not to use the dunning configuration setting to send an email applicable to that dunning step if you are placing this MPI/BG into dunning. The default is to use the configuration setting. Allowed values:
|
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. |