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



 

Home > Aria Crescendo core api > get_all_acct_contracts_m

get_all_acct_contracts_m

This API returns an array of contracts associated with the given account, as well as contract details. You can optionally filter by contract status.

For information on error messages generated by this API, see get_all_acct_contracts_m error messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
  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). Value of "null" returns account contracts without filtering by status, and is the default.   Allowable Values
  exclude_terminated_plan_inst string 5 This indicator determines if terminated plan instances should be excluded from the return. If True is passed, the API shall exclude (not return) any plan instances that have a status of Terminated.   Allowable Values
  locale_no long 22 Aria-assigned Locale identifier. This value is unique across all Aria-managed accounts.
  OR      
  locale_name string 50 Name of the locale.
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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_m hash  
brd_arrow.gif contract_no long Aria-assigned unique contract identifier.
brd_arrow.gif client_contract_id string Client assigned unique contract identifier
brd_arrow.gif contract_scope string Specifies the scope of plan subscription coverage enforced by the contract.
brd_arrow.gif type_no long The type of contract end action to be enforced by this contract.   Allowable Values
brd_arrow.gif length_months long The number of months, starting from start_date, that the given contract will be in effect.
brd_arrow.gif 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.
brd_arrow.gif create_comments string CSR or API-provided comments provided at time of contract creation.
brd_arrow.gif update_comments string Comments provided at time of last contract update.
brd_arrow.gif create_date string The date the contract was created.
brd_arrow.gif update_date string The date the contract was last modified.
brd_arrow.gif start_date string Specifies contract start date. The date is in the format yyyy-mm-dd.
brd_arrow.gif end_date string Contract end date.
brd_arrow.gif status_code long Status code of this contract.   Allowable Values
brd_arrow.gif contract_plan_instance_info hash  
brd_arrow.gif plan_instance_no long The unique numberic identifier of the plan instance..
brd_arrow.gif plan_name string The name of the plan this line represents
brd_arrow.gif client_plan_instance_id string Unique client-defined ID for each assigned master plan.
brd_arrow.gif plan_instance_status_cd long The status code of the plan instance associated with this account.   Allowable Values
brd_arrow.gif plan_instance_status_label string This is the status for each plan instance associated with the contract. (ex: Active, Terminated etc.).
brd_arrow.gif 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.
brd_arrow.gif 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.
brd_arrow.gif rollover_rate_sched_no long Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
brd_arrow.gif 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
brd_arrow.gif contract_rollover_custom_rate_info hash  
brd_arrow.gif custom_rate_plan_instance_no long Plan instance for which the custom rates will be used at the completion of the contract.
brd_arrow.gif 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.
brd_arrow.gif custom_rate_service_no long Service number for the new custom rate
brd_arrow.gif custom_client_rate_service_id string Unique client-defined identifier for the custom rate service number.
brd_arrow.gif custom_rate_seq_no string Sequence number for this line of the rate schedule.
brd_arrow.gif custom_rate_from_unit string Tiered pricing, "FROM" unit.
brd_arrow.gif custom_rate_to_unit string Tiered pricing, "TO" unit.
brd_arrow.gif 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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.