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. |
all_acct_contracts_m |
hash |
|
contract_no |
long |
Aria-assigned unique contract identifier. |
client_contract_id |
string |
Client assigned unique contract identifier |
contract_scope |
string |
Specifies the scope of plan subscription coverage enforced by the contract. |
type_no |
long |
The type of contract end action to be enforced by this contract. Allowable Values
Values |
Description |
2 |
Continue existing service without contract |
3 |
Renew existing contract automatically |
6 |
Terminate service and billing |
7 |
Terminate service and billing and prorate final invoice |
8 |
Rollover to a different plan/rate/custom rates (applicable only for multi-plan contracts) |
|
length_months |
long |
The number of months, starting from start_date, that the given contract will be in effect. |
cancel_fee |
double |
Fee to be charged if the plan instance is canceled by the account holder. For a multi-plan contract, this will be applicable only when the last remaining plan instance is canceled prior to the contract's end date. |
create_comments |
string |
CSR or API-provided comments provided at time of contract creation. |
update_comments |
string |
Comments provided at time of last contract update. |
create_date |
string |
The date the contract was created. |
update_date |
string |
The date the contract was last modified. |
start_date |
string |
Specifies contract start date. The date is in the format yyyy-mm-dd. |
end_date |
string |
Contract end date. |
status_code |
long |
Status code of this contract. Allowable Values
Values |
Description |
-3 |
Contract no longer in scope, usually due to mid-contract plan change on account. |
-2 |
Terminated. Contract cancelled by client or system. |
-1 |
Cancelled. Contract cancelled by end user. |
0 |
Contract completed and renewed. New contract record refers to this contract record. |
1 |
In Effect. Contract is currently active. |
99 |
Completed. Contract is completed, no renewal. |
|
contract_plan_instance_info |
hash |
|
plan_instance_no |
long |
The unique numberic identifier of the plan instance.. |
plan_name |
string |
The name of the plan this line represents |
client_plan_instance_id |
string |
Unique client-defined ID for each assigned master plan. |
plan_instance_status_cd |
long |
The status code of the plan instance associated with this account. Allowable Values
Values |
Description |
1 |
Active |
2 |
Active Pending |
3 |
Terminate Pending |
-1 |
Terminated |
|
plan_instance_status_label |
string |
This is the status for each plan instance associated with the contract. (ex: Active, Terminated etc.). |
rollover_plan_no |
long |
Note that if the target rollover plan has a surcharge that has already been associated with this account, when the plan rollover occurs at the completion of this contract, the surcharge for this plan may be ignored (depending on the client parameter determining whether duplicate surcharges are permitted). The surcharge at the account level will remain in effect. |
rollover_client_plan_id |
string |
Note that if the target rollover plan has a surcharge that has already been associated with this account, when the plan rollover occurs at the completion of this contract, the surcharge for this plan may be ignored (depending on the client parameter determining whether duplicate surcharges are permitted). The surcharge at the account level will remain in effect. |
rollover_rate_sched_no |
long |
Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract |
rollover_client_rate_sched_id |
string |
Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract |
contract_rollover_custom_rate_info |
hash |
|
custom_rate_plan_instance_no |
long |
Plan instance for which the custom rates will be used at the completion of the contract. |
custom_rate_client_plan_instance_id |
string |
Client-defined ID of the plan instance for which the custom rates will be used at the completion of the contract. |
custom_rate_service_no |
long |
Service number for the new custom rate |
custom_client_rate_service_id |
string |
Unique client-defined identifier for the custom rate service number. |
custom_rate_seq_no |
string |
Sequence number for this line of the rate schedule. |
custom_rate_from_unit |
string |
Tiered pricing, "FROM" unit. |
custom_rate_to_unit |
string |
Tiered pricing, "TO" unit. |
custom_rate_per_unit |
string |
Rate to charge per unit on this tier. |
acct_locale_no |
long |
Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. DEPRECATED |
acct_locale_no_2 |
long |
Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. |
acct_locale_name |
string |
Name of the account level locale. |