get_all_acct_contracts_m Guide

Last updated
Save as PDF

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

API Specification:	get_all_acct_contracts_m
Required Fields:	<client_no> <auth_key> <account_no> or <client_acct_id>

Error Codes:

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error Associated Inputs: auth_key, client_id, client_no	<auth_key>, <client_id>, <client_no>
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id) Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no	<acct_no>, <account_no>, <client_acct_id>, <user_id>, <userid>, <parent_acct_no>
16001: contract does not exist Associated Inputs: contract_no, client_contract_id	<contract_no>, <client_contract_id>
16004: Invalid Filter_Status_Code. The Filter_Status_Code must be 0=Inactive, 1=Active or Blank/Null=(Default value for both Active and Inactive) Associated Input: filter_status_code	<filter_status_code>
1033: a parameter that represents a true or false value contains invalid input Associated Inputs: alt_collect_on_approve, alt_send_statement_on_approve, cancel_orders_on_discard, cascade_action, do_auto_discard, do_collect, change_status_after_coll, reset_dates_after_status, disable_existing_on_update, do_write, exclude_terminated_plan_inst, include_all_rate_schedules, include_plan_hierarchy, retrieve_bundled_nso, retrieve_included_nso, include_translations, include_inactive_items, include_invoice_activity_eligibility, include_rs_summary, include_translations, include_service_supp_fields/include_product_fields/, include_plan_instance_fields/include_plan_services/, include_surcharges, include_void_transactions, include_voided, invoice_unbilled_usage, is_unlinked_refund, record_cc_on_auth_failure, retrieve_excluded_usage, send_email, usage_pooling, do_write	<alt_collect_on_approve>, <alt_send_statement_on_approve>, <cancel_orders_on_discard>, <cascade_action>, <do_auto_discard>, <do_collect>, <change_status_after_coll>, <reset_dates_after_status>, <disable_existing_on_update>, <do_write>, <exclude_terminated_plan_inst>, <include_all_rate_schedules>, <include_plan_hierarchy>, <retrieve_bundled_nso, retrieve_included_nso>, <include_translations>, <include_inactive_items>, <include_invoice_activity_eligibility>, <include_rs_summary, <include_translations>, <include_service_supp_fields>/<include_product_fields>/, <include_plan_instance_fields>/<include_plan_services>/, <include_surcharges>, <include_void_transactions>, <include_voided>, <invoice_unbilled_usage>, <is_unlinked_refund>, <record_cc_on_auth_failure>, <retrieve_excluded_usage>, <send_email>, <usage_pooling>, <do_write>
1066: Locale name does not exist in the system. Associated Inputs: locale_name	<locale_name>
1067: Locale no does not exist in the system. Associated Inputs: locale_no, master_plan_instance_no	<locale_name>, <master_plan_instance_no>
5067: limit must be between 1 and 999. Associated Input: limit, record_limit, contract_limit	<limit>, <record_limit>, <contract_limit>
5068: offset must be greater than or equal to zero. Associated Input: offset, contract_offset	<offset>, <contract_offset>

Additional Guidance:

Input Fields

Field Name

Notes

<contract_limit>

The contracts will be returned in ascending order by <contract_no>.

Example: You have an account that has 4 contracts numbered: 123, 234, 456, and 567. If you pass 2 into this field, only contracts 123 and 234 will be returned.

If you don't pass a value into this field, then all contracts that match your input values will be returned.

Note: For better performance, it is recommended that you pass 50 into the <contract_limit> filed.

<contract_offset>

Specifies the number of contracts to skip.

The contracts will be skipped in ascending order by <contract_no>.

Example: You have an account that has 4 contracts numbered: 123, 234, 456, and 567. If you pass 2 into this field, only contracts 456 and 567 will be returned.

If you don't pass a value into this field, then it will default to 0.

<filter_status_code>

Allowable values for filter_status_code:

Values	Description
0	Inactive
1	Active
	Do not filter by status (default)

<exclude_terminated_plan_inst>

Allowable values for exclude_terminated_plan_inst:

Values	Description
false	Plan instances with Terminated status will be returned. (default)
true	No plan instances with Terminated status will be returned.

<include_contract_billing_installment>

Allowable values for include_contract_billing_installment:

Values	Description
0	do not return contract billing values(default)
1	return contract billing values

Output Fields

Field Name

Notes

<type_no>

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)

<status_code>

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.

<plan_instance_status_cd>

Allowable values

Values	Description
1	Active
2	Pending Cancellation
3	Pending Termination
31	Pending Installation
32	Pending Activation
41	Trial
61	Active Non-billable
0	Inactive
-1	Suspended
-2	Cancelled
-3	Terminated