Objects let you output content from your Current RMS system into your document layouts. For example, the order
object has an attribute called name
that outputs the opportunity name.
Liquid Syntax is the mechanism used in Current RMS templates to dynamically access and display object attributes.
Which objects are available?
company
attributes for your companycurrent_store
attributes for the current storeorganisation
attributes for an organisationcontact
attributes for a contactvenue
attributes for a venueuser
attributes for a particular usercurrent_user
attributes for the logged in userowner_user
attributes for the owner uservehicle
attributes for a particular vehicleinvoice
attributes for an invoiceinvoice.item
attributes for an invoice iteminvoice.tax
attributes for an invoice tax recordproject
attributes for a projectorder
attributes for an opportunityorder.cost
attributes for an opportunity costorder.item
attributes for an opportunity itemitem.asset
attributes for an opportunity item assetitem.surcharge
attributes for opportunity item surchargeitem.charging_period
attributes for details of a rental charge held against a product or opportunity itemproduct
attributes for a productservice
attributes for a servicestock_level
attributes for a product stock leveladdress
attributes for an addressactivity
attributes for an activity
Where can I access objects?
Some objects can only be accessed in particular document layouts. For example, the invoice.items
object can only be accessed from within an invoice document.
For details on how to access each object, see our list. For a more comprehensive guide to Liquid Syntax, visit the Current RMS - Liquid Syntax Documentation.
Example: Displaying the Name of the Opportunity
You can display the name of the opportunity within a discussion or invoice template using the following Liquid syntax:
{% assign order = invoice.sources.first %}
This snippet ensures that opportunity data is retrieved correctly and displayed within the template.
Common Use Cases
Retrieving the Status of a Product: Use Liquid Syntax to dynamically include the 'status' of a product.
Displaying Names and Attributes: Tailor your templates to fetch specific names or attributes for enhanced personalisation. These examples highlight practical applications of Liquid Syntax in accessing objects.
Global objects
These objects are available in all document layouts:
current_user
owner_user
company
current_store