| all_client_item_details |
hash |
|
 item_no |
long |
The unique ID of the item being retrieved |
| item_label |
string |
The name or label for this item |
| service_no |
long |
The service number associated with this item, which will be used during invoicing |
| service_desc |
string |
The long description of the service associated with this item |
| client_item_id (Deprecated) |
string |
The client-defined item ID to search for images |
| client_service_id |
string |
A multidimensional array of client-defined Service ID for this plan. |
| client_item_plan_id |
string |
client-defined item plan ID the item appears on |
| usage_type_cd |
string |
An array containing usage_type_cd(s) to denote which usage type(s) to record. |
| all_service_supp_fields |
hash |
An array containing the inventory item service's supplemental fields'; field_name, field_desc, field_order_no, and field_value. |
| field_name |
string |
The machine-readable name of this field |
| field_desc |
string |
The human-readable name of this field |
| field_order_no |
long |
The sort order of this field |
| field_value |
string |
The value stored in this field |
| client_sku |
string |
Client SKU of the NSO/Inventory item. |
| item_plan |
long |
The plan associated with this item to assign when the item is purchased |
| item_months |
long |
The months to stack for this item |
| stock_level |
double |
The current number of this item left in stock |
| avg_ratings |
long |
(DEPRECATED) The average user rating of this item |
| num_ratings |
long |
(DEPRECATED) The number of total ratings for this item |
| num_reviews |
long |
(DEPRECATED) The number of user reviews for this item |
| item_type |
long |
The type of item, see allowable values legend
Allowable values for item_type:
| Values |
Description |
| 0 |
Inventory Item |
| 1 |
Months to stack |
| 2 |
Resource Item |
|
| item_desc |
string |
The long description of the item |
| active_ind |
long |
Whether or not this item is considered an active, in-stock item
Allowable values for active_ind:
| Values |
Description |
| 0 |
Inactive |
| 1 |
Active |
|
| modify_price_ind |
string |
Whether or not the item price can be modified at sale time
Allowable values for modify_price_ind:
| Values |
Description |
| Y |
Yes |
| N |
No |
|
| subunit_qty |
double |
Allows the client to associate a quantity of an arbitrary virtual item which is associated with a single unit of this item (e.g. 500 gold pieces) |
| subunit_label |
string |
The item name of the subunit represented by a single quantity of this item |
| service_type |
string |
(DEPRECATED) This field is no longer used |
| coa_id |
string |
The system internal Chart-of-Accounts ID for this item |
| client_coa_code |
string |
The client-specified Chart-of-Accounts ID for this item |
| taxable_ind |
long |
Whether or not taxes apply to this item
Allowable values for taxable_ind:
| Values |
Description |
| 0 |
taxable |
| 1 |
non-taxable |
|
| tax_group |
long |
If taxable, the tax group this item belongs to |
| usage_type |
long |
(DEPRECATED) This field is no longer used |
| purchase_scope |
long |
Purchase scope for inventory item, default is null (both 0 and 1)
Allowable values for purchase_scope:
| Values |
Description |
| 0 |
No purchase restrictions. |
| 1 |
Can be purchased with qualifying plans only. |
|
| all_item_prices |
hash |
(DEPRECATED) This is no longer used |
| 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 |
| all_item_images |
hash |
|
| image_class_name |
string |
The category of the image, such as thumbnail or full |
| image_class_no |
long |
The unique ID for the image class |
| image_class_seq_no |
long |
The sequence number of this image within its class |
| image_url |
string |
The actual URL for this image |
| image_text |
string |
The alt text for the image tag displaying the item image |
| default_ind |
long |
Whether or not this image is the default for that item
Allowable values for default_ind:
| Values |
Description |
| 0 |
Rate schedule is not the default. |
| 1 |
Rate schedule is the default. |
|
| all_item_supp_fields |
hash |
|
| field_name |
string |
The machine-readable name of this field |
| field_desc |
string |
The human-readable name of this field |
| field_order_no |
long |
The sort order of this field |
| field_value |
string |
The value stored in this field |
| all_item_classes |
hash |
|
| class_no |
long |
The unique ID of the item class to which this item belongs |
| label |
string |
The label or name for the item class |
| 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. |
| 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 determining 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. |
