get_inventory_item_details_m Guide
- Last updated
-
-
Save as PDF
-
The get_inventory_item_details_m API returns details of a specified 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.
Additional Guidance
Input Fields
| Field Name |
Notes |
| <include_translations> |
Allowable values
| Values |
Description |
| true |
Translated fields will be fetched in all the locales defined. |
| false |
Translation information will not be fetched. |
|
Output Fields
| Field Name |
Notes |
| <tax_inclusive_rate> |
Allowable values
| Values |
Description |
| 0 |
Tax exclusive |
| 1 |
Tax inclusive |
|
| <item_type> |
Allowable values
| Values |
Description |
| 0 |
Inventory Item |
| 1 |
Months To Stack (deprecated) |
| 2 |
Resource Item |
| 3 |
Fee |
|
| <fee_application_type> |
Allowable values
| Values |
Description |
| 1 |
Applied to payment plan
|
| Null |
Non-fee items
|
If <item_type> = 3, defaults to 1.
|
| <fee_type> |
Allowable values
| Values |
Description |
| P |
Percentage-based
|
| F |
Flat
|
| A |
Amortized (declining balance) interest
|
| Null |
Non-fee items |
Mandatory when <item_type> = 3.
|
| <tax_inclusive_ind> |
Allowable values
| Values |
Description |
| 1 |
tax inclusive
|
| 0 |
tax exclusive
|
|
