get_plan_service_details_m
Summary
| API Name | get_plan_service_details_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Retrieve details on specified service that is on a specified plan
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
||||||
| service_no | long | 8 | Yes |
Specifies the Service number Alternative required field: client_service_id |
||||||
| client_service_id | string | 100 | Yes |
Client defined unique id Alternative required field: service_no |
||||||
| plan_no | long | 100 | Yes |
Plan Number Alternative required field: client_plan_id |
||||||
| client_plan_id | string | 100 | No |
Client defined unique id Alternative field: plan_no |
||||||
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
||||||
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
||||||
| include_translations | string | 5 | No |
Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowed values:
|
Outputs
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error |
|||||||||
| error_msg | string | No |
Textual description of any error that occurred. "OK" if there was no error. |
|||||||||
| plan_no | long | 100 | No |
Plan Number |
||||||||
| client_plan_id | string | 100 | No |
Client defined unique id |
||||||||
| currency_cd | string | 3 | No |
Specifies the currency code of plan |
||||||||
| service_no | long | 8 | No |
Specifies the Service number |
||||||||
| service_name | string | 100 | No |
Specifies the service name |
||||||||
| service_type | string | 30 | No |
Specifies Service types. Valid values are: "Usage Based", "Recurring", "Activation" |
||||||||
| client_service_id | string | 100 | No |
Client defined unique id |
||||||||
| taxable_ind | int | 1 | No |
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 | 1 | No |
Specifies tax group associated with service. This will be null if taxable_ind is set to 0 |
||||||||
| client_tax_group_id | string | 100 | No |
Client defined unique identifier |
||||||||
| gl_cd | string | 30 | No |
Specifies chart of access code |
||||||||
| usage_type | int | 38 | No |
Specifies usage type associated with service |
||||||||
| rate_type | string | 15 | No |
Specifies the rate type. Valid values are:'Flat Rate' and 'Tiered Pricing' |
||||||||
| rate_schedules | object | No |
The rate_schedules associated with this method. |
|||||||||
| parent_plans | object | No |
The parent_plans associated with this method. |
|||||||||
| parent_plan_ids | object | No |
The parent_plan_ids associated with this method. |
|||||||||
| exclusion_plans | object | No |
The exclusion_plans associated with this method. |
|||||||||
| supplemental_obj_fields | object | No |
The supplemental_obj_fields associated with this method. |
|||||||||
| commodity_cd | string | 20 | No |
Commodity Code |
||||||||
| fulfillment_based_ind | int | 1 | No |
Indicates if the service is “Fulfillment Based” or not. Allowed values:
|
||||||||
| apply_usage_rates_daily | int | 1 | No |
Indicates whether or not this usage-based service is rated on a daily basis. Allowed values:
|
||||||||
| service_locations | object | No |
The service_locations associated with this method. |
|||||||||
| service_translation_details | object | No |
Array that contains all the translated values for a given locale. |
|||||||||
| tax_inclusive_ind | long | No |
This flag denotes if a rate is inclusive of the taxes. Value of 1 means tax inclusive rates and a value of 0 (default) means tax exclusive rates. |
|||||||||
| usage_rating_time_ind | int | 1 | No |
Rating Time Indicator governs the time when usage is rated: during invoicing process or during usage loading to the platform. Allowed values:
|
||||||||
| usage_record_rating_level_ind | int | 1 | No |
Indicates whether the usage rating to be done at individual record level or aggregated records level. Allowed values:
|
||||||||
| usage_record_taxation_level_ind | int | 1 | No |
Indicates whether the usage taxation to be done at individual record level or aggregated records level. Allowed values:
|
rate_schedules.rate_info fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| schedule_no | long | 10 | Yes |
Schedule Number for the currency |
| schedule_name | string | Yes | ||
| client_rate_schedule_id | string | 100 | No |
Client defined unique id |
| from_unit | int | 10 | Yes |
Tiered Pricing Rule that Specifies rate from units. This is null for Flat Rates |
| to_unit | int | 10 | No |
Tiered Pricing Rule that Specifies rate to units. This is null for Flat Rates |
| rate_per_unit | float | 11 | Yes |
Specifies rate per unit |
| description | string | No |
Specifies rate tier description |
rate_schedules fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| currency | string | 3 | Yes |
Currency for the schedule |
| rate_info | object | No |
The rate_info associated with this method. |
|
| is_default | int | 1 | Yes |
1 or 0 depending on if the schedule is the default or not. identifies the default |
supplemental_obj_fields fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| field_no | long | 100 | No |
the field no |
| field_value | string | No |
the field value |
|
| field_name | string | 100 | No |
the field name |
service_locations fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| svc_location_no | long | 38 | No |
The Aria-assigned unique identifier for the origin location for the service. |
| client_svc_location_id | string | 100 | No |
The client-defined location identifier for the origin location for the service. |
| svc_location_name | string | 100 | No |
The name of the origin location for the service. |
| svc_location_company_name | string | 300 | No |
Company name of the service location. |
| svc_location_address1 | string | 300 | No |
First address line of the service location. |
| svc_location_address2 | string | No |
Second address line of the service location. |
|
| svc_location_address3 | string | 300 | No |
Third address line of the service location. |
| svc_location_city | string | 300 | No |
City of the service location. |
| svc_location_locality | string | 25 | No |
Locality of the service location. |
| svc_location_state_prov | string | 10 | No |
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. |
| svc_location_country | string | 300 | No |
Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase. |
| svc_location_postal_cd | string | 15 | No |
Postal/Zip code for the service location address. |
service_translation_details.rate_schedules_t.rate_info fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| schedule_no | long | 10 | Yes |
Schedule Number for the currency |
| schedule_name | string | Yes |
Schedule Name |
|
| description | string | No |
Specifies rate tier description |
service_translation_details.rate_schedules_t fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| rate_info | object | No |
The rate_info associated with this method. |
service_translation_details fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
| service_no | long | 8 | No |
Specifies the Service number |
| service_name | string | 100 | No |
Specifies the service name |
| rate_schedules_t | object | No |
The rate_schedules_t associated with this method. |