get_client_item_prices_m
Summary
| API Name | get_client_item_prices_m |
|---|---|
| Class | system_services_m |
| Update Version | 47 |
Description
Returns a list of prices for inventory item.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| filter_currency_cd | string | 3 | No |
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 | No |
Note: This field is deprecated. Aria no longer supports return_no_cost_items. |
| filter_item_no | long | 8 | Yes |
Aria-assigned unique identifier indicating Client Inventory Item. Alternative required field: filter_client_sku |
| filter_client_item_id | string | 100 | No |
Note: This field is deprecated. Aria no longer supports filter_client_item_id. |
| filter_client_sku | string | 100 | Yes |
The client defined SKU for this item Alternative required field: filter_item_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| item_rates | object | No |
Note: This field is deprecated. Aria no longer supports item_rates. |
|
| nso_rate_schedules | object | No | ||
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
nso_rate_schedules.nso_rate_tiers fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| rate_seq_no | long | No |
Sequential number in the rate schedule for dertermining tiers |
|
| from_unit | double | No |
Specifies the starting unit for the given tier. |
|
| to_unit | double | No |
Specifies the ending unit for the given tier |
|
| rate_per_unit | double | No |
Specifies the rate per unit billed. |
|
| description | string | No |
This field is used to display custom rate tier description. This will override the rate tier's description at service level. |
nso_rate_schedules fields
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| rate_schedule_no | long | No |
The ID of this rate schedule |
|||||||
| rate_schedule_name | string | No |
Name for the rate schedule |
|||||||
| client_rate_schedule_id | string | No |
Client-defined unique identifier |
|||||||
| currency_cd | string | No |
Currency for the schedule |
|||||||
| is_default | string | No |
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 | No |
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. Allowed values:
|
|||||||
| nso_rate_tiers | object | No |