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. |
![]() | service_no | int | 8 | Specifies the Service number |
OR | ||||
client_service_id | string | 100 | Client defined unique id | |
![]() | plan_no | int | 100 | Plan Number |
OR | ||||
client_plan_id | string | 100 | Client defined unique id | |
locale_no | int | 38 | Aria-assigned unique identifier of the locale used for translations. | |
OR | ||||
locale_name | string | 32 | Name of the locale to which the translations belong. | |
include_translations | string | 1 | Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowable Values |
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. |
plan_no | string | Plan Number |
client_plan_id | string | Client defined unique id |
currency_cd | string | Specifies the currency code of plan |
service_no | string | Specifies the Service number |
service_name | string | Specifies the service name |
service_type | string | Specifies Service types. Valid values are: "Usage Based", "Recurring", "Activation" |
client_service_id | string | Client defined unique id |
taxable_ind | int | Indicates If The service has tax associated with it [can be 0 or 1]; 1 indicates taxable and 0 indicates non taxable. |
tax_group | string | Specifies tax group associated with service. This will be null if taxable_ind is set to 0 |
client_tax_group_id | string | Client defined unique identifier |
gl_cd | string | Specifies chart of access code |
usage_type | int | Specifies usage type associated with service |
rate_type | string | Specifies the rate type. Valid values are:'Flat Rate' and 'Tiered Pricing' |
rate_schedules | hash | |
![]() | string | Currency for the schedule |
![]() | hash | |
![]() | int | Schedule Number for the currency |
![]() | string | |
![]() | string | Client defined unique id |
![]() | int | Tiered Pricing Rule that Specifies rate from units. This is null for Flat Rates |
![]() | int | Tiered Pricing Rule that Specifies rate to units. This is null for Flat Rates |
![]() | float | Specifies rate per unit |
![]() | string | Specifies rate tier description |
![]() | int | 1 or 0 depending on if the schedule is the default or not. identifies the default |
parent_plans | hash | |
![]() | int | |
parent_plan_ids | hash | |
![]() | string | |
exclusion_plans | hash | |
![]() | int | |
supplemental_obj_fields | hash | |
![]() | string | |
commodity_cd | string | Commodity Code |
fulfillment_based_ind | int | Indicates if the service is “Fulfillment Based” or not. Allowable Values |
apply_usage_rates_daily | int | Indicates whether or not this usage-based service is rated on a daily basis. Allowable Values |
service_translation_details | hash | Array that contains all the translated values for a given locale. |
![]() | string | Name of the locale |
![]() | int | Aria-assigned unique identifier of the locale used for translations. |
![]() | string | Specifies the Service number |
![]() | string | Specifies the service name |
![]() | hash | |
![]() | hash | |
![]() | int | Schedule Number for the currency |
![]() | string | Schedule Name |
![]() | string | Specifies rate tier description |