Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria6 core api > get_all_acct_contracts

get_all_acct_contracts

Returns an array of all status contracts associated with the given account. Also provide option to filter by status

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
filter_status_code long 1 The filter_status_code is the Aria code used to filter account contract for Inactive or Active (0 or 1).
exclude_terminated_plans string 300 This indicator determines if terminated plans should be excluded from the return. If True is passed, the API shall exclude (not return) any plans that have a status of Terminated.   Allowable Values
alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
optional_transaction_qualifiers array Array of additional values you can associate with this API call.
qualifier_name string 100 Name of the field you want to associate with this API call.
qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

Field Name Field Type Description
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 hash
contract_no long Aria-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.
length_months long The number of months, starting from start_date, that the given contract will be in effect.
cancel_fee double The cancellation fee to assess against the account based on early cancellation rules this contract.
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
plan_no long The list of all plan_no currently in effect for the given account.
client_plan_id string Client-defined Plan ID for which to query available child plans
plan_status_cd long The status code of the supplemental plan associated with this account.  Allowable Values
plan_status_label string This is the status for each plan associated with the contract. (ex: Active, Terminated etc.).

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.