Home > Aria Crescendo Documentation > Aria Crescendo object query api > get_plan_instance_information_m
get_plan_instance_information_m
get_plan_instance_information_m
Table of contents
Searches for stacks based on query-able fields. Returns "plan_instance_details"
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. |
|
query_string | string | 1000 | The criteria which all returned objects must match. Different objects have a different set of searchable criteria.Fields marked with "*Query" in the returns section can be used as part of the query_string. Valid operations for the query string include "=", "!=", "<", "<=", ">=", ">", "IS NULL", "IS NOT NULL", "LIKE", and "NOT LIKE". You must leave a space before and after each operation. The first operand must always be a field name, and the second operand must always be a value (except for "IS NULL" and "IS NOT NULL", where the second operand is implicitly "NULL"). If the second operand contains a space, less than, greater than, or equals sign, then it must be enclosed in double quotes. The second operand may not contain double quotes. Multiple conditions must be joined with either "AND" or "OR". Additionally, any queryable field can also be used to order the results, by appending "ORDER BY" to the query, followed by a field name and either "ASC" or "DESC". |
| username | string | 30 | DeprecatedThe login name of the user making this request. It is the same name that is used to log in to the Aria Administration and Configuration Tool. | |
| password | string | 1000 | DeprecatedThe password of the user making this request. It is the same password that is used to log in to the Aria Administration and Configuration Tool. | |
| limit | long | 12 | The maximum number of objects to be returned by this call. Note that Aria recommends a maximum limit of less than 1,000. Higher limits may take much longer to return data. If you do not specify a value, or specify a value of "0", this field defaults to 100. Specifying a value of "-1" returns a count of the number of matching records, but does not return any records. | |
| offset | long | 12 | The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records. |
Querystring Keys
| Key Name | Description |
|---|---|
| acct_no | The Aria assigned ID of the account |
| user_id | The client defined user_id for the account |
| client_acct_id | Client specified account identifier |
| plan_instance_no | The system defined ID of the plan instance |
| client_plan_instance_id | The client defined ID of the plan instance |
| product_field_name | The client defined ID of the plan instance field |
| product_field_value | The value that was assigned to this field on this plan instance |
| plan_no | The Aria assigned ID of the master plan for this account |
| client_plan_id | The client defined ID of the plan on this instance |
| last_bill_date | The last date on which the plan instance was billed |
| next_bill_date | The next date on which the plan instance is scheduled to be billed |
| bill_thru_date | The date through which the plan instance has been billed |
| status_cd | The status code of the plan instance |
| master_plan_instance_balance | The balance of this "master plan instance" |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria assigned error identifier. 0 indicates no error |
| error_msg | string | Textual description of any error that occurred. "OK" if there was no error. |
| starting_record | long | This indicates the number of objects that were (or would be) skipped before beginning output. |
| total_records | long | This is the total number of objects that matched the provided criteria. |
| plan_instance_details | hash | |
 acct_no |
long | The Aria assigned ID of the account |
| user_id |
string | The client defined user_id for the account |
| client_acct_id |
string | Client specified account identifier |
| plan_instance_no |
string | The system defined ID of the plan instance |
| client_plan_instance_id |
string | The client defined ID of the plan instance |
| product_fields |
hash | |
| product_field_no |
long | The system-defined ID of the plan instance field |
| product_field_desc |
string | No value - only for compatibility |
| product_field_name |
string | The client defined ID of the plan instance field |
| product_field_value |
string | The value that was assigned to this field on this plan instance |
| plan_no |
long | The Aria assigned ID of the master plan for this account |
| client_plan_id |
string | The client defined ID of the plan on this instance |
| plan_name |
string | The name of the plan on this instance |
| plan_units |
long | The number of units assigned to this instance |
| last_bill_date |
string | The last date on which the plan instance was billed |
| next_bill_date |
string | The next date on which the plan instance is scheduled to be billed |
| bill_thru_date |
string | The date through which the plan instance has been billed |
| status_cd |
string | The status code of the plan instance |
| status_date |
string | The date at which the plan instance entered the current status |
| schedule_no |
string | The balance of this "stack" (master plan instance only) |
| master_plan_instance_balance |
double | The balance of this "master plan instance" |
| billing_group_no |
long | The system defined billing group ID |
| client_billing_group_id |
string | The client defined defined billing group ID |
| dunning_group_no |
long | The system defined dunning group ID |
| primary_payment_method |
hash | Deprecated |
| billing_first_name |
string | First name from the current address instance |
| billing_middle_initial |
string | Middle name from the current address instance |
| billing_last_name |
string | Last name from the current address instance |
| billing_address1 |
string | BillingAddress1 from the current address instance |
| billing_address2 |
string | BillingAddress2 from the current address instance |
| billing_city |
string | City from the current address instance |
| billing_state |
string | State from the current address instance |
| billing_locality |
string | Locality from the current address instance |
| billing_zip |
string | Zipcode from the current address instance |
| billing_country |
string | Country from the current address instance |
| billing_intl_phone |
string | Intl phone from the current address instance |
| billing_email |
string | Email from the current address instance |
| pay_method_type |
int | pay type from the current billing instance |
| cc_expire_mm |
string | cc expire months from the current billing instance |
| cc_expire_yyyy |
string | cc expire year from the current billing instance |
| bank_routing_num |
string | bank routing num from the current billing instance |
| payment_instrument_suffix |
string | suffix from the current billing instance |
| primary_payment_method_name |
string | Primary payment method name from the current billing instance |
| primary_payment_method_description |
string | primary payment method description from the current billing instance |
| primary_payment_method_client_defined_id |
string | Primary payment client defined id from the current billing instance |
| backup_payment_method |
hash | Deprecated |
| bkup_billing_first_name |
string | First name from the current address instance |
| bkup_billing_middle_initial |
string | Middle name from the current address instance |
| bkup_billing_last_name |
string | Last name from the current address instance |
| bkup_billing_address1 |
string | BillingAddress1 from the current address instance |
| bkup_billing_address2 |
string | BillingAddress2 from the current address instance |
| bkup_billing_city |
string | City from the current address instance |
| bkup_billing_state |
string | State from the current address instance |
| bkup_billing_locality |
string | Locality from the current address instance |
| bkup_billing_zip |
string | Zipcode from the current address instance |
| bkup_billing_country |
string | Country from the current address instance |
| bkup_billing_intl_phone |
string | Intl phone from the current address instance |
| bkup_billing_email |
string | Email from the current address instance |
| bkup_pay_method_type |
int | pay type from the current billing instance |
| bkup_cc_expire_mm |
string | cc expire months from the current billing instance |
| bkup_cc_expire_yyyy |
string | cc expire year from the current billing instance |
| bkup_bank_routing_num |
string | bank routing num from the current billing instance |
| bkup_payment_instrument_suffix |
string | suffix from the current billing instance |
| backup_payment_method_name |
string | Primary payment method name from the current billing instance |
| backup_payment_method_description |
string | primary payment method description from the current billing instance |
| backup_payment_method_client_defined_id |
string | Primary payment client defined id from the current billing instance |
| primary_payment_method_info |
hash | |
| billing_first_name |
string | First name from the current address instance |
| billing_middle_initial |
string | Middle name from the current address instance |
| billing_last_name |
string | Last name from the current address instance |
| billing_address1 |
string | BillingAddress1 from the current address instance |
| billing_address2 |
string | BillingAddress2 from the current address instance |
| billing_city |
string | City from the current address instance |
| billing_state |
string | State from the current address instance |
| billing_locality |
string | Locality from the current address instance |
| billing_zip |
string | Zipcode from the current address instance |
| billing_country |
string | Country from the current address instance |
| billing_intl_phone |
string | Intl phone from the current address instance |
| billing_email |
string | Email from the current address instance |
| pay_method_type |
int | pay type from the current billing instance |
| cc_expire_mm |
string | cc expire months from the current billing instance |
| cc_expire_yyyy |
string | cc expire year from the current billing instance |
| bank_routing_num |
string | bank routing num from the current billing instance |
| payment_instrument_suffix |
string | suffix from the current billing instance |
| primary_payment_method_name |
string | Primary payment method name from the current billing instance |
| primary_payment_method_description |
string | primary payment method description from the current billing instance |
| primary_payment_method_client_defined_id |
string | Primary payment client defined id from the current billing instance |
| backup_payment_method_info |
hash | |
| bkup_billing_first_name |
string | First name from the current address instance |
| bkup_billing_middle_initial |
string | Middle name from the current address instance |
| bkup_billing_last_name |
string | Last name from the current address instance |
| bkup_billing_address1 |
string | BillingAddress1 from the current address instance |
| bkup_billing_address2 |
string | BillingAddress2 from the current address instance |
| bkup_billing_city |
string | City from the current address instance |
| bkup_billing_state |
string | State from the current address instance |
| bkup_billing_locality |
string | Locality from the current address instance |
| bkup_billing_zip |
string | Zipcode from the current address instance |
| bkup_billing_country |
string | Country from the current address instance |
| bkup_billing_intl_phone |
string | Intl phone from the current address instance |
| bkup_billing_email |
string | Email from the current address instance |
| bkup_pay_method_type |
int | pay type from the current billing instance |
| bkup_cc_expire_mm |
string | cc expire months from the current billing instance |
| bkup_cc_expire_yyyy |
string | cc expire year from the current billing instance |
| bkup_bank_routing_num |
string | bank routing num from the current billing instance |
| bkup_payment_instrument_suffix |
string | suffix from the current billing instance |
| backup_payment_method_name |
string | Primary payment method name from the current billing instance |
| backup_payment_method_description |
string | primary payment method description from the current billing instance |
| backup_payment_method_client_defined_id |
string | Primary payment client defined id from the current billing instance |
- © Copyright 2023 Aria Developer Central