assign_custom_acct_plan_rates_m
Summary
| API Name | assign_custom_acct_plan_rates_m |
|---|---|
| Class | account_services_m |
| Update Version | 64 |
Description
Applies custom rates to a particular plan instance and service assigned to a specified account.
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 | Yes |
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 |
Unique plan instance number for each custom rates. Alternative required field: client_plan_instance_id |
||||||
| client_plan_instance_id | string | 100 | Yes |
Unique client-defined ID for each custom rates. Alternative required field: plan_instance_no |
||||||
| service_no | long | 22 | No |
Aria-assigned unique service identifier Alternative field: client_service_id |
||||||
| client_service_id | string | 100 | No |
A multidimensional array of Client-defined Service ID for this plan. Alternative field: service_no |
||||||
| custom_acct_rates | object | Yes |
This is a multidimensional array containing elements with the attributes rate_seq_no, rate_per_unit, from_unit, to_unit. |
|||||||
| plan_scope | string | 1 | No |
This determines whether or not the rate changes are applicable to a current plan or a queued plan. Allowed values:
|
||||||
| plan_queue_id | long | 22 | No |
Unique identifier associated with a specific queued plan change |
||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||
| custom_rates_directive | long | 1 | No |
Governs whether to remove the existing custom rates when assigning new custom rates. The default value is '1' and leaves the existing custom rates in place. A value of '2' will remove the custom rates and honor the custom rates passed. Allowed values:
|
custom_acct_rates fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| rate_seq_no | long | 22 | Yes |
The Aria-assigned rate sequence number for this rate schedule |
| rate_per_unit | double | 22 | No |
The rate per unit value for this rate schedule |
| from_unit | double | 22 | No |
The beginning of the rate tier volume of units for this rate_per_unit |
| to_unit | double | 22 | No |
The end of the rate tier volume of units to relevant to this rate_per_unit |
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. |