adjust_acct_plan_billing_dates_m
Summary
| API Name | adjust_acct_plan_billing_dates_m |
|---|---|
| Class | account_services_m |
| Update Version | 33 |
Description
Adjusts the billing date for a specified set of master plans under one or more accounts to date(s) in the future or in the past.
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 |
| billing_dates | object | No |
Array of master plan instances associated with the account to which billing data is to be modified |
|
| comments | string | No |
Additional explanatory text relating to this API call. |
|
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
billing_dates fields
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| master_plan_instance_no | long | 22 | Yes |
The unique identifier of the plan instance. Alternative required field: client_master_plan_instance_id |
||||||||
| client_master_plan_instance_id | string | 100 | Yes |
The client-defined identifier of the plan instance. Alternative required field: master_plan_instance_no |
||||||||
| action_directive | long | Yes |
Determines whether the billing date is adjusted forward or backward. Allowed values:
|
|||||||||
| adjustment_days | long | 4 | No |
Number of days to adjust the billing date. A value for this field is required when action_directive=1 or 2. Alternative field: adjustment_date |
||||||||
| adjustment_date | string | 10 | No |
The date to set the next billing date. The adjustment date cannot exceed 27 days before or after the current next billing date. This field is required when action_directive=3. Alternative field: adjustment_days |
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. |