Home > Aria Crescendo Documentation > Aria Crescendo core api > get_client_item_prices_m
get_client_item_prices_m
get_client_item_prices_m
Table of contents
Returns a list of prices for inventory item.
Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.
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. | |
| filter_currency_cd | string | 3 | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. | |
| return_no_cost_items | string | 5 | A boolean value that asserts the API call should include no-cost items in its returned results (true/1=yes, false/0=no). (DEPRECATED) | |
| filter_item_no | long | 8 | Aria-assigned unique identifier indicating Client Inventory Item. | |
| OR | ||||
| filter_client_item_sku | string array | 100 | Client SKU of the NSO/Inventory Item. |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| item_rates | hash | (DEPRECATED) |
 price |
double | (DEPRECATED) The total price for this item |
| price_per_unit |
double | (DEPRECATED) The price for a single unit of this item |
| currency_cd |
string | (DEPRECATED) The ISO-compatible 3-digit currency code for the currency this item price bills in |
| schedule | ||
| schedule_no |
long | The ID of this rate schedule |
| schedule_name |
string | Name for the rate schedule |
| client_rate_schedule_id |
string | Client-defined unique identifier |
| currency_cd |
string | Currency for the schedule |
| is_default |
string | This flag denotes if this rate schedule is the default one for this plan. One and only one rate schedule can be marked as default. The value of 1 is defaulted for the first rate schedule for a given currency denoting it is the default. For subsequent rate schedules, the default is set to 0. |
| tax_inclusive_ind |
||
| tier |
array | This array contains tiered pricing information for the given rate schedule. |
| rate_schedule_name |
string | Name of rate schedule this tier belongs to. |
| client_rate_schedule_id |
string | Client-defined unique identifier for the rate schedule. |
| amount |
float | Tiered pricing rule that specifies rate per unit. |
| from |
int | Tiered pricing rule that specifies "from" units. |
| to |
int | Tiered pricing rule that specifies to units. |
| description |
string | This field is used to display custom rate tier description. This will override the rate tier's description at service level. |
| nso_rate_schedules | ||
| rate_schedule_no |
long | The ID of this rate schedule |
| rate_schedule_name |
string | Name for the rate schedule |
| client_rate_schedule_id |
string | Client-defined unique identifier |
| currency_cd |
string | Currency for the schedule |
| is_default |
string | This flag denotes if this rate schedule is the default one for this item. One and only one rate schedule can be marked as default. The value of 1 is defaulted for the first rate schedule for a given currency denoting it is the default. For subsequent rate schedules, the default is set to 0. |
| tax_inclusive_ind |
string | This flag denotes if a rate is inclusive of taxes. Valid values are: 1 - Means tax inclusive rates and 0 (default) - Means tax exclusive rates. |
| nso_rate_tiers |
||
| rate_seq_no |
long | Sequential number in the rate schedule for dertermining tiers |
| from_unit |
double | Specifies the starting unit for the given tier. |
| to_unit |
double | Specifies the ending unit for the given tier |
| rate_per_unit |
double | Specifies the rate per unit billed |
| description |
string | This field is used to display custom rate tier description. This will override the rate tier's description at service level. |
| 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. |
- © Copyright 2023 Aria Developer Central