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. |
OR | ||||
client_acct_id | string | 50 | Client-defined account identifier. | |
include_service_supp_fields | string | 5 | Indicates whether to include the service supplemental fields array. If set to "true", will retrieve all of service supplemental fields If left blank, will default to "true". Allowable Values | |
limit | long | 3 | Limits the number of records returned in the all_acct_plans_m array. Min of 1 and Max 999. If no value specified, the default is 100. | |
offset | long | 3 | The number of records to skip in the all_acct_plans_m array. Min of 0 and Max is unlimited. If no value specified the default is 0. | |
include_product_fields | string | 5 | Indicates whether to include the product fields array. If set to "true", will return the product fields array. If left blank, will default to "true". Allowable Values | |
include_plan_instance_fields | string | 5 | Indicates whether to include the plans instance fields array. If set to "true", will return array. If left blank, will default to "true". Allowable Values | |
include_plan_services | string | 5 | Indicates whether to include the plans services array. If set to "true", will return array. If left blank, will default to "true". Allowable Values | |
include_surcharges | string | 5 | Indicates whether to include the surcharges array. If set to "true", will return array. If left blank, will default to "true". Allowable Values | |
locale_no | long | 22 | Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. | |
OR | ||||
locale_name | string | 50 | Name of the locale. | |
include_rate_schedule | string | If the include_rate_schedule parameter is set to True or left null, then all of the rate schedule information for each plan will be returned. If set to False, this information will be excluded from the response. Allowable Values | ||
include_contract_and_rollover_info | string | If the include_contract_and_rollover_info parameter is set to True or left null, then all of the contract and rollover information for each plan will be returned. If set to False, this information will be excluded from the response. Allowable Values | ||
include_dunning_info | string | If the include_dunning_info parameter is set to True or left null, then all of the dunning information for each plan will be returned. If set to False, this information will be excluded from the response. Allowable Values | ||
Start of product_catalog_plan_filter array | ||||
product_catalog_plan_filter | array | This array will support up to 10 individual inputs. | ||
Field Name | Field Type | Max Length | Description | |
![]() |
long | The Aria-assigned unique plan identifier that will be used to filter the results for this API. If the plan instance doesn’t have this plan_no assigned, it will not be returned. | ||
OR | ||||
![]() |
string | 100 | The client-defined unique identifier for the plan that will be used to filter the results for this API. If the plan instance doesn’t have this plan name assigned, it will not be returned. | |
End of product_catalog_plan_filter array | ||||
Start of service_no_filter array | ||||
service_no_filter | array | This array will support up to 10 individual inputs. | ||
![]() |
long | 22 | The Aria-assigned unique service identifier that will be used to filter the results for this API. If the plan instance doesn’t have this service_no assigned, it will not be returned. | |
OR | ||||
![]() |
string | 100 | The client-defined unique identifier for the service that will be used to filter the results for this API. If the plan instance doesn’t have the service with this description assigned, it will not be returned. | |
End of service_no_filter array | ||||
Start of master_plan_instance_filter array | ||||
master_plan_instance_filter | array | This array will support up to 10 individual inputs. | ||
Field Name | Field Type | Max Length | Description | |
![]() |
long | The Aria-assigned unique identifier of the master plan that will be used to filter the results for this API. Results will only display for plans related to the master plan instance provided. | ||
OR | ||||
![]() |
string | The client-defined unique identifier of the master plan that will be used to filter the results for this API. Results will only display for plans related to the master plan instance provided. | ||
End of master_plan_instance_filter array | ||||
Start of supplemental_field_filter array | ||||
supplemental_field_filter | array | This array will support up to 10 individual inputs. | ||
Field Name | Field Type | Max Length | Description | |
![]() |
string | Name of the supplemental field associated with a plan that will be used to filter results. | ||
![]() |
string | Value for the supplemental field listed above that will be used to filter results. | ||
End of supplemental_field_filter array | ||||
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. | |
Start of optional_transaction_qualifiers array | ||||
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
Field Name | Field Type | Max Length | Description | |
![]() |
string | 100 | Name of the field you want to associate with this API call. | |
![]() |
string | 100 | Corresponding value of the field you want to associate with this API call. | |
End of optional_transaction_qualifiers array | ||||
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. |
record_count | long | Returns a total count of the number of records. |
all_acct_plans_m | hash | |
![]() |
long | Aria-assigned unique plan identifier |
![]() |
string | Plan Name |
![]() |
string | Text description of this plan |
![]() |
long | Unique plan instance number for each assigned master plan. |
![]() |
string | Unique client-defined ID for each assigned master plan. |
![]() |
string | Date on which the account was assigned to their current plan. |
![]() |
long | Number of plan units the account is billed for. |
![]() |
string | The date the account was last billed |
![]() |
string | Date the account will be evaluated for invoicing, whether or not it results in any actual charges. |
![]() |
string | Date the accounts forward charges have been billed through. |
![]() |
long | Day of the month that the account is billed. |
![]() |
long | Number of months between billing cycles |
![]() |
long | Number of months between billing cycles |
![]() |
long | Indicates whether or not this plan is billable Allowable Values |
![]() |
long | Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable. Allowable Values |
![]() |
long | Number of months in which the account will change from the current plan to the pre-defined rollover plan. |
![]() |
long | Pre-defined plan to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined rollover plan. |
![]() |
double | Fee charged for early cancellations. |
![]() |
long | Number of months during which early cancellation fees would apply on master plan cancellation. Not applicable to supplemental plans. |
![]() |
long | Pre-defined period in days in which an account will degrade to Suspended status (-1) if action is not taken such as a plan or status change. |
![]() |
long | Default status used when master plan is initially assigned on an account. Allowable Values |
![]() |
long | Status used for the master plan instance at the completion of the rollover period. Allowable Values |
![]() |
long | Duration of the plan status rollover period, after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjuction with rollover_plan_status_uom_cd). |
![]() |
long | Units associated with the duration of the plan status rollover period after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status. (used in conjunction with rollover_plan_status_duration). Allowable Values |
![]() |
long | Duration of the initial free period (used in conjunction with init_free_period_uom_cd). |
![]() |
long | Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration). Allowable Values |
![]() |
long | Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd). |
![]() |
long | Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration). Allowable Values |
![]() |
long | Default status used when master plan is initially assigned on an account. Allowable Values |
![]() |
long | Status used for the master plan instance at the completion of the plan status rollover period. Allowable Values |
![]() |
long | The billing group number. |
![]() |
string | Client-defined billing group ID. |
![]() |
long | Dunning group number |
![]() |
string | Client-defined unique identifier for dunning group |
![]() |
long | Plan to assign when an account on this plan is suspended. |
![]() |
long | Default notification method given to an account that is assigned to this plan. Allowable Values |
![]() |
long | Indicates whether or not this plan is prepaid Allowable Values |
![]() |
string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
![]() |
long | Aria-assigned unique rate schedule number |
![]() |
string | Name of the rate schedule |
![]() |
long | Indicates whether or not the account is using the plans default rate schedule. 0 means the account is using an alternate rate schedule. 1 means the account is using the default rate schedule. Allowable Values |
![]() |
long | Indicates whether or not the plan is a supplemental plan. If it is "1", then the plan is a supplemental plan and if it is "0", then the plan is a master plan. Allowable Values |
![]() |
long | Current status code of the plan instance. Allowable Values |
![]() |
string | Current status of the plan instance. Allowable Values |
![]() |
string | Most recent date on which the status of the plan instance changed. |
![]() |
long | Dunning state assigned to the master plan instance. In Progress indicates the master plan is in dunning. None indicates the master plan is not in dunning. Note that dunning state is applicable only for master plans and is set to Complete by the system once the dunning process is completed. Allowable Values |
![]() |
long | Current dunning step of the plan instance (applicable only for master plans currently in dunning). |
![]() |
string | Next future date on which the plan instance would advance to the next dunning step (applicable only for master plans currently in dunning). |
![]() |
string | The date on which the current plan was assigned on this plan instance. |
![]() |
string | The date on which the current plan on this plan instance was suspended, cancelled or terminated. |
![]() |
string | The API receipt ID used while creating this plan instance. |
![]() |
string | Client-defined Plan ID for which to query available child plans |
![]() |
string | Pre-defined plan to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined client rollover plan ID. |
![]() |
string | CDID of the plan to be assigned when an account on this plan is suspended. |
![]() |
string | Client assigned unique rate schedule number |
![]() |
string | Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately. Allowable Values |
![]() |
hash | |
![]() |
string | Name of the product field associated with the plan in the product catalog. |
![]() |
string | Value associated with the product field as defined in the product catalog. |
![]() |
hash | |
![]() |
string | Name of the plan instance field |
![]() |
string | Value associated with the plan instance field |
![]() |
long | Master plan instance number for each supplemental plan. |
![]() |
string | Client master plan instance ID for each supplemental plan. |
![]() |
long | Parent plan instance number to identify each supplemental plan and child supplemental plan heirarchy. |
![]() |
string | Client parent plan instance ID to identify each supplemental plan and child supplemental plan heirarchy. |
![]() |
hash | Deprecated A multidimensional array of Services for this plan |
![]() |
long | The services for this plan |
![]() |
string | Description of this service |
![]() |
long | Indicates whether or not this service is a recurring service Allowable Values |
![]() |
long | Indicates whether or not this service is a usage-based service Allowable Values |
![]() |
long | The usage type supported by this usage based service |
![]() |
long | Indicates whether or not this service is taxable Allowable Values |
![]() |
long | Indicates whether or not this service is a tax-based service Allowable Values |
![]() |
long | Indicates whether or not this service is an arrears-based service Allowable Values |
![]() |
long | Indicates whether or not this service is a setup-based service Allowable Values |
![]() |
long | Indicates whether or not this service is a miscellaneous service Allowable Values |
![]() |
long | Indicates whether or not this service is a donation-based service Allowable Values |
![]() |
long | Indicates whether or not this service is an order-based service Allowable Values |
![]() |
long | Indicates whether or not this service is a cancellation- based service Allowable Values |
![]() |
string | Chart of accounts ID |
![]() |
string | This field is deprecated in favor of coa_id |
![]() |
string | The client-defined override for coa_id |
![]() |
long | Indicates if this service is displayable or not Allowable Values |
![]() |
long | The Tiered Pricing Rule Allowable Values |
![]() |
long | Indicates whether or not this service is a minimum fee. Allowable Values |
![]() |
string | The client-defined Service ID for this plan. |
![]() |
string | Denotes which usage type to record. |
![]() |
hash | |
![]() |
string | The machine-readable name of this field |
![]() |
string | The human-readable name of this field |
![]() |
long | The sort order of this field |
![]() |
string | The value stored in this field |
![]() |
long | Indicates if the service is Fulfillment Based or not. |
![]() |
long | The Aria-assigned unique identifier for the origin location for the service. |
![]() |
string | The client-defined location identifier for the origin location for the service. |
![]() |
string | The name of the origin location for the service. |
![]() |
string | Company name of the service location. |
![]() |
string | First address line of the service location. |
![]() |
string | Second address line of the service location. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field. |
![]() |
string | Third address line of the service location. |
![]() |
string | City of the service location. |
![]() |
string | Locality of the service location. |
![]() |
string | State or Province of the service location. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries. |
![]() |
string | Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase. |
![]() |
string | Postal/Zip code for the service location address. |
![]() |
hash | Represents the rates for the default rate schedule for the default currency for the plan |
![]() |
long | Sequential number in the rate schedule for dertermining tiers |
![]() |
double | Tiered Units (from) This value represents the start of a tiered range of values. |
![]() |
double | Tiered Units (to) This value represents the end of the range for a single tier of values. |
![]() |
double | The cost per unit of this service over the time period the plan is billed for |
![]() |
double | The future cost per unit of this service over the time period the plan is billed for |
![]() |
double | If the plan interval is more than one month, this field will rate per unit per month |
![]() |
double | If the plan interval is more than one week, this field will rate per unit per week |
![]() |
double | If the plan interval is more than one week, this field will rate per unit per week |
![]() |
string | Client assigned unique rate schedule number |
![]() |
string | Rate Tier Description |
![]() |
hash | All rates for all rate schedules and currencies for this plan |
![]() |
long | Rate schedule number |
![]() |
string | Client assigned unique rate schedule number |
![]() |
long | Indicates whether future rates are captured or not. Allowable Values |
![]() |
string | Future Change Date of the rates. |
![]() |
long | Aria internal ID of follow-up default rate schedule |
![]() |
string | Client-defined ID of followup rate schedule |
![]() |
hash | Represents the rates for the default rate schedule for the default currency for the plan |
![]() |
long | Sequential number in the rate schedule for dertermining tiers |
![]() |
double | Tiered Units (from) This value represents the start of a tiered range of values. |
![]() |
double | Tiered Units (to) This value represents the end of the range for a single tier of values. |
![]() |
double | The cost per unit of this service over the time period the plan is billed for |
![]() |
double | The future cost per unit of this service over the time period the plan is billed for |
![]() |
double | If the plan interval is more than one month, this field will rate per unit per month |
![]() |
string | Client assigned unique rate schedule number |
![]() |
string | Rate Tier Description |
![]() |
string | The human-readable name of this usage type |
![]() |
string | The long description of this usage type |
![]() |
string | Client-assigned identifier for the type of usage being recorded. |
![]() |
string | The display-level description of the units this usage represents. |
![]() |
long | Indicates whether or not this usage-based service is rated on a daily basis. Allowable Values |
![]() |
hash | A multidimensional array of Services for this plan |
![]() |
long | The services for this plan |
![]() |
string | Description of this service |
![]() |
long | Indicates whether or not this service is a recurring service Allowable Values |
![]() |
long | Indicates whether or not this service is a usage based service Allowable Values |
![]() |
long | The usage type supported by this usage based service |
![]() |
long | Indicates whether or not this service is taxable Allowable Values |
![]() |
long | Indicates whether or not this service is a tax based service Allowable Values |
![]() |
long | Indicates whether or not this service is an arrears based service Allowable Values |
![]() |
long | Indicates whether or not this service is a setup bases service Allowable Values |
![]() |
long | Indicates whether or not this service is a miscellaneous service Allowable Values |
![]() |
long | Indicates whether or not this service is a donation based service Allowable Values |
![]() |
long | Indicates whether or not this service is an order based service Allowable Values |
![]() |
long | Indicates whether or not this service is a cancellation based service Allowable Values |
![]() |
string | Chart of accounts ID |
![]() |
string | This field is deprecated in favor of coa_id |
![]() |
string | The client-defined override for coa_id |
![]() |
long | Indicates if this service is displayable or not Allowable Values |
![]() |
long | The Tiered Pricing Rule Allowable Values |
![]() |
long | Indicates whether or not this service is a minimum fee. Allowable Values |
![]() |
string | The client-defined Service ID for this plan. |
![]() |
string | Denotes which usage type to record. |
![]() |
hash | |
![]() |
string | The machine-readable name of this field |
![]() |
string | The human-readable name of this field |
![]() |
long | The sort order of this field |
![]() |
string | The value stored in this field |
![]() |
long | Indicates if the service is Fulfillment Based or not. |
![]() |
hash | Represents the rates for the default rate schedule for the default currency for the plan |
![]() |
long | Sequential number in the rate schedule for dertermining tiers |
![]() |
double | Tiered Units (from) This value represents the start of a tiered range of values. |
![]() |
double | Tiered Units (to) This value represents the end of the range for a single tier of values. |
![]() |
double | The cost per unit of this service over the time period the plan is billed for |
![]() |
double | The future cost per unit of this service over the time period the plan is billed for |
![]() |
double | If the plan interval is more than one month, this field will rate per unit per month |
![]() |
string | Client assigned unique rate schedule number |
![]() |
string | Rate Tier Description |
![]() |
string | The human-readable name of this usage type |
![]() |
string | The long description of this usage type |
![]() |
string | Client-assigned identifier for the type of usage being recorded. |
![]() |
string | The display-level description of the units this usage represents. |
![]() |
long | Indicates whether or not this usage-based service is rated on a daily basis. Allowable Values |
![]() |
long | The Aria-assigned unique identifier for the origin location for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations. |
![]() |
string | The client-defined unique identifier for the origin location for the service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations. |
![]() |
string | The name of the origin location for the service. |
![]() |
string | Company name of the service location. |
![]() |
string | First address line of the service location. |
![]() |
string | Second address line of the service location. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field. |
![]() |
string | Third address line of the service location. |
![]() |
string | City of the service location. |
![]() |
string | Locality of the service location. |
![]() |
string | State or Province of the service location. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries. |
![]() |
string | Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase. |
![]() |
string | Postal/Zip code for the service location address. |
![]() |
long | The Aria-assigned unique identifier for the destination contact for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations. |
![]() |
long |
Indicator that states whether a taxable service is tax-inclusive or tax-exclusive. Allowable Values |
![]() |
hash | A multidimensional array of Surcharges for this plan' |
![]() |
long | Surcharge number for this plan |
![]() |
string | Surcharge name for this plan |
![]() |
string | Client-defined surcharge ID. |
![]() |
string | description for surcharge. |
![]() |
string | External Description for surcharge. |
![]() |
string | Surcharge type for the plan. |
![]() |
string | Currency for this surcharge plan |
![]() |
string | If taxable, the tax group this item belongs to |
![]() |
string | Invoice application method of this plan surcharge Allowable Values |
![]() |
string | Revenue Account GL Code for this plan surcharge |
![]() |
string | Accounts Recievable GL Code for this plan surcharge |
![]() |
hash | A multidimensional array of Surcharges Rate for this plan' |
![]() |
long | Aria-assigned unique rate sequence number |
![]() |
double | Tiered Units (from) This value represents the start of a tiered range of values. |
![]() |
double | Tiered Units (to) This value represents the end of the range for a single tier of values. |
![]() |
double | This is the rate for the tiered units specified by from and to unit values above. |
![]() |
long | This indicator indicates whether the rate schedule has includes zero or not. |
![]() |
long | This indicator indicates the assigned rate schedule for the surcharge. |
![]() |
string | Rate Tier Description |
![]() |
long | Pre-defined plan to be used as the rollover plan at the completion of the contract. |
![]() |
string | Client-defined ID of the pre-defined plan to be used as the rollover plan at the completion of a contract. |
![]() |
long | Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract |
![]() |
string | Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract |
![]() |
string | Purchase order number assigned to the plan instance. |
![]() |
string | Start date of assigned rate schedule |
![]() |
string | End date of assigned rate schedule |
![]() |
long | Aria internal ID of follow-up default rate schedule for the assigned rate schedule |
![]() |
string | Client-defined ID of followup rate schedule for the assigned rate schedule |
![]() |
long | The number of reset months for each plan. |
months_renewal_option |
long | Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at the end of the current period. Allowable Values |
![]() |
long | Number of months since last reset. Once this value reaches the <usage_ accumulation_reset_months> value, it will reset to 0 (zero). |
![]() |
long |
Bill lag days refer to the number of days prior to (negative) or after (positive) an account billing date at which you specified that an invoice should be generated for a master plan instance. Examples:
|
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. |