You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 3
Next »
Name | Type | Description |
|---|
id | String | The ID of the retrieved warehouse |
| name | String | The name of the retrieved warehouse |
| alternative_code | String | The alternative code of the retrieved warehouse |
| description | String | The description of the retrieved wareshouse |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
type | Warehouse type object | The type of the retrieved warehouse |
owned_by_group | Group object | The group owning the warehouse |
privacy_level | Privacy level object | The privacy level of the warehouse |
log_information | Log Information Object | The log information related with the retrieved warehouse |
stock_balance | Set of stock balance object | The quantity of each product kept in the warehouse |
Referred Objects Response Data
warehouse_type object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved warehouse type |
name | String | The name of the retrieved warehouse type |
alternative_code | String | The alternative code of the retrieved warehouse type |
| description | String | A description of the retrieved warehouse type |
group object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved group |
name | String | The name of the retrieved group |
community_name | String | The name of the community that the retrieved group belongs to |
alternative_code | String | The alternative code of the retrieved group |
| unified_code | String | The unified code of the retrieved group |
description | String | The description of the retrieved group |
privacy_level object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved privacy level |
| number | String | The number of the retrieved privacy level |
name | String | The name of the retrieved privacy level |
hierarchy_level | String | The hierarchy level of the retrieved privacy level |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
stock_balance object response data
Name | Type | Description |
| quantity | Number | The number of specified products kept in the warehouse |
| number_of_products_included_in_bundles | Number | The number of items included in physical good bundles |
product | Product Object | The product kept in the warehouse |
Referred Objects Response Data
product object response data
| | |
|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product |
| global_rate | Global Rate Object | The global rate of the retrieved product |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
global rate object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following: - QUANTITYBASED
- QUANTITYANDPERIODBASED
- BILLABLEPERIODBASED
- DURATIONBASED
- FLATFEEBASED
- USAGEBASED
|
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between |
| uot | String | The 'UOT' applicable for the rate
- Seconds
- Minute
- Hour
- Day
- Week
- Month
- Year
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |