Opportunity item assets
The opportunity item assets object holds information held against opportunity item assets.
When you add a product or service to an opportunity, it creates an opportunity item on that opportunity. Opportunity items have opportunity item assets, which are records for allocations for that item.
An allocation might be a serialized asset or a sub-rent booking.
Generally, the opportunity item asset object is used to print operations documents like Picking Lists, Delivery Notes, and Collection Notes.
Document layouts
The asset
object can be accessed in document layouts against the following modules:
Opportunity
To print assets against an opportunity item:
To print assets inside a container:
To print assets for a sub-rent supplier:
Member
To print sub-rent allocations for a particular supplier:
Discussion templates
The asset
object can be accessed in document layouts against the following modules:
Opportunity
To print assets against an opportunity item:
To print assets inside a container:
To print assets for a sub-rent supplier:
Member
To print sub-rent allocations for a particular supplier:
asset_number
asset_number
Where serialized, returns an opportunity item asset asset number.
Returns blank for bulk or non-stock.
Input
Output
barcode_number
barcode_number
Where bulk or non-stock, returns an opportunity item asset's related product barcode number.
Returns blank for serialized.
Input
Output
container
container
Returns the opportunity item asset container name.
Returns blank where no container is set.
Input
Output
cost
cost
Returns opportunity cost objects for an opportunity item asset.
Input
Output
depth
depth
Returns the depth of an opportunity item asset in the tree. An item’s depth is determined by how it is nested under items.
Input
Output
depth_padding
depth_padding
Returns the depth padding for an opportunity item asset. Generally used to apply an inline style to a table cell in HTML so that items appear nested.
Increments in multiples of 16.
Input
Output
description
description
Returns an opportunity item asset’s related opportunity item description.
Input
Output
group_depth_padding
group_depth_padding
Returns the depth padding for an opportunity item asset's related opportunity group.
Used in our default documents where the order.product_assets
is looped, which doesn't include groups.
Input
Output
group_description
group_description
Returns the description for an opportunity item asset's related opportunity group.
Used in our default documents where the order.product_assets
is looped, which doesn't include groups.
Input
Output
group_name
group_name
Returns the name for an opportunity item asset's related opportunity group.
Used in our default documents where the order.product_assets
is looped, which doesn't include groups.
Input
Output
has_shortage?
has_shortage?
Returns true
where an opportunity item asset has a shortage; false
otherwise.
Shortages are highlighted in red and have an ⚠️ exclamation icon next to them in the list.
Input
Output
id
id
Returns an opportunity item asset ID.
The ID is an internal reference for a record. It's not exposed in our web interface.
Input
Output
is_bulk_stock?
is_bulk_stock?
Returns true
if an opportunity item asset is for bulk stock; false
otherwise.
Input
Output
is_non_stock_booking?
is_non_stock_booking?
Returns true
if an opportunity item asset is a non-stock allocation; false
otherwise.
Text items are considered non-stock allocations.
Input
Output
is_resource_stock?
is_resource_stock?
Returns true
if an opportunity item asset is a service with bookable resource, i.e. a bookable resource has been allocated; false
otherwise.
Input
Output
is_serialised_component?
Returns true if an opportunity item asset is a serialized component, i.e. it is part of a serialized container; false otherwise.
is_serialised_container?
Returns true if an opportunity item asset is a serialized container; false otherwise.
is_serialised_stock?
is_serialised_stock?
Returns true
if an opportunity item asset is a serialized stock allocation, i.e. a serialized asset has been allocated; false
otherwise.
Input
Output
location
location
Returns the stock level location for an opportunity item asset.
Input
Output
name
name
Returns an opportunity item asset's name. This will always be the name of the opportunity item.
Input
Output
opportunity_item
Returns opportunity item objects for an opportunity item asset.
Generally used to access information like the opportunity item charge total or description.
Input
Output
outer_container
Returns the container attribute of a serialised component's serialised container. Otherwise returns the same as the container method.
product
product
Returns product objects for an opportunity item asset, where related to a product.
Input
Output
quantity
quantity
Returns the quantity against an opportunity item asset.
Input
Output
replacement_value
replacement_value
Returns the replacement charge for an opportunity item asset. This may differ from the opportunity item replacement charge depending on the quantity.
Input
Output
resource
resource
Returns contact, user, or vehicle objects for a bookable resource allocation.
Input
Output
resource_name
resource_name
Returns the name of the contact, user, or vehicle for a bookable resource allocation.
Input
Output
return_assets
return_assets
Returns opportunity item return assets for an opportunity item asset.
Input
Output
serial_number
serial_number
Returns the stock level serial number for an opportunity item asset.
In Current RMS we make a distinction between serial numbers and asset numbers. Asset numbers are used for allocation.
Input
Output
service
service
Returns service objects for an opportunity item asset, where related to a service.
Input
Output
service_name
service_name
Returns the name of the related service for an opportunity item asset.
Input
Output
status
status
Returns the opportunity item asset status ID.
ID
Status name
1
Provisional
2
(Allocated)
5
Reserved
10
Allocated
15
Prepared
20
Booked Out
30
Checked In
40
Completed
45
Moved
Note the difference between 2
and 10
.
2
(Allocated) is for allocations on a provisional quotation.10
Allocated is for allocations on a reserved quotation or order.
Input
Output
status_name
status_name
Returns the opportunity item asset status name.
Status names are in the language set against your user profile.
Provisional
(Allocated)
Reserved
Allocated
Prepared
Booked Out
Checked In
Completed
Moved
Input
Output
stock_level
stock_level
Returns stock level objects for the related stock level of an opportunity item asset.
Input
Output
supplier
supplier
Returns organization objects for a sub-rent or sub-contract supplier related to an opportunity item asset.
Input
Output
supplier_name
supplier_name
Returns the name of the organization set as a sub-rent or sub-contract supplier for an opportunity item asset.
Input
Output
weight
weight
Returns the weight for an opportunity item asset's related opportunity item.
Input
Output
Use the company
object to return your company weight unit, e.g. lbs
or kg
.
weight_total
weight_total
Returns the weight total for an opportunity item asset. This may differ from the opportunity item replacement charge depending on the quantity.
Input
Output
Last updated
Was this helpful?