get_acct_universal_contract_m
Summary
| API Name | get_acct_universal_contract_m |
|---|---|
| Class | account_services_m |
| Update Version | 3.5 |
Description
Returns any universal contract currently associated with 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 |
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
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. |
|||||||||||||||
| type_no | long | No |
The type of contract "end action" to be enforced by this contract. Allowed values:
|
|||||||||||||||
| length_months | long | No |
Note: This field is deprecated. Aria no longer supports length_months. |
|||||||||||||||
| create_comments | string | No |
CSR or API-provided comments provided at time of contract creation. |
|||||||||||||||
| update_comments | string | No |
Comments provided at time of last contract update. |
|||||||||||||||
| create_date | string | No |
The date the contract was created. |
|||||||||||||||
| update_date | string | No |
The date the contract was last modified. |
|||||||||||||||
| start_date | string | No |
Specifies contract start date. The date is in the format yyyy-mm-dd |
|||||||||||||||
| end_date | string | No |
Contract end date |
|||||||||||||||
| status_code | long | No |
Note: This field is deprecated. Aria no longer supports status_code. |
|||||||||||||||
| contract_no | long | 22 | No |
Aria-assigned unique contract identifier |
||||||||||||||
| client_contract_id | string | 100 | No |
Client assigned unique contract identifier |
||||||||||||||
| status_code_2 | long | No |
Status code of this contract. Allowed values:
|
|||||||||||||||
| duration_type | long | 1 | No |
Indicator which determines whether the contract duration in length is based on months, weeks or days. Allowed values:
|
||||||||||||||
| duration_length | long | No |
The contract duration in length that the given contract will be in effect from the start date. |
|||||||||||||||
| renewal_duration_type | long | 1 | No |
Indicator which determines whether the contract renewal duration in length is based on months, weeks or days. Allowed values:
|
||||||||||||||
| renewal_duration_length | long | No |
The contract renewal duration in length that the given contract will be in effect from the renewal start date. |
|||||||||||||||
| renewal_end_date | string | No |
Date on which the renewal contract ends. Date format is YYYY-MM-DD. For the new contract type '9-Renew contract with different duration', it is mandatory to pass the either the renewal_end_date or the renewal_duration_type and renewal_duration_length. If both are passed, renewal_duration_length will take the precedence over the renewal_end_date. |