Opportunity
The opportunity (order) object contains information held against an opportunity record.
Opportunities are the beginning and the end of the order process in Current RMS. They are one of the most complex records, with many related records like opportunity items, opportunity item assets, and opportunity costs.
Opportunity documents are the most commonly used documents. Quotations, rental agreements, delivery notes, and other documents are printed from the opportunity module.
Because the opportunity module is so complex, it touches lots of other records so there are many ways of accessing opportunity objects.
Document layouts
The order
object can be accessed in document layouts created against the following modules:
Opportunity
Project
Returns opportunity items for opportunities on a project.
Invoice
Returns opportunity items for opportunities that are sources on a particular invoice.
Member
Returns opportunity items for opportunities linked to a particular organization.
Returns opportunities items for active opportunities linked to a particular organization.
Quarantine
Returns opportunity item objects for the source opportunity of a quarantine.
Returns opportunity item objects for the opportunity that a quarantined asset is next booked on.
Discussion templates
The item
object can be accessed in discussion templates created against the following modules:
Opportunity
Project
Returns opportunity items for opportunities on a project.
Invoice
Returns opportunity items for opportunities that are sources on a particular invoice.
Member
Returns opportunity items for opportunities linked to a particular organization.
Returns opportunities items for active opportunities linked to a particular organization.
Quarantine
Returns opportunity item objects for the source opportunity of a quarantine.
Returns opportunity item objects for the opportunity that a quarantined asset is next booked on.
activities
activities
Returns activity objects for the activities relating to the opportunity.
Input
Output
actual_cost_total
actual_cost_total
Returns the actual cost total against an opportunity.
The actual cost total is calculated by totaling actual costs.
Input
Output
Use the currency filter or a number filter to change the way that the number is formatted.
assets
assets
Returns opportunity item asset objects for items on the opportunity.
Input
Output
attachments
attachments
Returns attachment objects for attachments stored against an opportunity.
Input
Output
billing_address
billing_address
Returns the opportunity billing address.
Input
Output
billing_address_detail
billing_address_detail
Returns address objects for the billing address against the opportunity.
Input
Output
billing_address_name
billing_address_name
Returns the name of the billing address against the opportunity.
Input
Output
charge_excluding_tax_total
charge_excluding_tax_total
Returns the opportunity charge total excluding tax.
Input
Output
charge_including_tax_total
charge_including_tax_total
Returns the opportunity charge total including tax.
Input
Output
charge_total
charge_total
Returns the opportunity charge total.
This may be including or excluding tax depending on the value of the “Catalog Prices” setting in System Preferences.
Input
Output
chargeable_days
chargeable_days
Returns the number of chargeable days for the opportunity.
Input
Output
collection_address
collection_address
Returns the opportunity collection address.
You may also use the venue object (below).
Input
Output
collection_address_detail
collection_address_detail
Returns address objects for the collection address against the opportunity.
Input
Output
collection_address_name
collection_address_name
Returns the name of the collection address against the opportunity.
You may also use the venue object (below).
Input
Output
combined_discount_total
combined_discount_total
Returns the total discount from deal pricing and percentage discounting on the opportunity.
Input
Output
consolidated_container_item_assets
consolidated_container_item_assets
Returns consolidated asset objects for assets on the opportunity, grouped by container.
Input
Output
Container names are converted to uppercase. Use a string filter to change the way that the text is formatted.
consolidated_items
consolidated_items
Returns consolidated item objects for items on the opportunity.
Input
Output
consolidated_principal_items
consolidated_principal_items
Returns consolidated item objects for principal items on an opportunity.
Similar to the consolidated_items
object (above), but only returns principal items. Accessories are not included.
Input
Output
container_item_assets
container_item_assets
Returns container asset objects for assets on an opportunity.
Input
Output
costs
costs
Returns opportunity cost objects for costs on an opportunity.
Input
Output
customer_collecting
customer_collecting
Returns true
if the “Customer collecting” box is ticked against an opportunity; false
otherwise.
Input
Output
customer_returning
customer_returning
Returns true
if the “Customer returning‘ box is ticked against an opportunity; false
otherwise.
Input
Output
deal_discount_total
deal_discount_total
Returns the total discount from deal pricing on the opportunity.
Input
Output
deal_exists?
deal_exists?
Returns true
if the opportunity has deal-priced groups or a deal price; false
otherwise.
Input
Output
delivery_address
delivery_address
Returns the opportunity delivery address.
You may also use the venue object (below).
Input
Output
delivery_address_detail
delivery_address_detail
Returns address objects for the delivery address against the opportunity.
Input
Output
delivery_address_name
delivery_address_name
Returns the name of the delivery address against the opportunity.
You may also use the venue object (below).
Input
Output
description
description
Returns the opportunity (internal) description.
Input
Output
discount_total
discount_total
Returns the total discount from percentage discounting on the opportunity.
Input
Output
discussion_email_address
discussion_email_address
Returns the discussion email address for the opportunity.
Input
Output
ends_at
ends_at
Returns the end date and time for the opportunity. You may also use charge_ends_at
.
Input
Output
Use a date filter to change the way that the date is formatted.
external_description
external_description
Returns the opportunity external description.
Input
Output
has_discount?
has_discount?
Returns true
if the opportunity has percentage based discounts; false
otherwise.
Input
Output
has_invoices?
has_invoices?
Returns true
if the opportunity has linked invoices; false
otherwise.
Input
Output
image_attachments
image_attachments
Returns attachment objects for attachments stored against an opportunity where the attachment file type is an image.
Input
Output
id
id
Returns the opportunity ID.
The ID is an internal reference for a record. It's not exposed in our web interface and shouldn't be confused with the opportunity number (below).
Input
Output
invoiced
invoiced
Returns true
if the opportunity “Invoiced‘ toggle is set to YES; otherwise false
.
Input
Output
invoices
invoices
Returns invoice objects for invoices linked to the opportunity.
Input
Output
items
items
Returns opportunity item objects for items on the opportunity.
Input
Output
items_sorted_by_principal
items_sorted_by_principal
Investigate further.
Input
Output
items_sorted_by_tag
items_sorted_by_tag
Investigate further
name
name
Returns the opportunity subject.
Input
Output
number
number
Returns the opportunity number.
nil
if the opportunity is an inquiry or a draft.
Input
Output
open_ended_rental
open_ended_rental
Returns true
if the “Open Ended Rental” toggle against the opportunity is set to YES; otherwise false
.
Input
Output
opportunity_has_deal?
opportunity_has_deal?
Returns true
if the entire opportunity has a deal; false
otherwise.
This will only return true
if the entire opportunity has a deal; it will return false
if there are deal priced groups. Use deal_exists?
(above) to check if there's a deal anywhere on the opportunity, including deal priced groups.
Input
Output
ordered_at
ordered_at
Returns the date entered in the opportunity “Document Date” field.
Input
Output
original_charge_excluding_tax_total
original_charge_excluding_tax_total
Returns the opportunity charge excluding tax total before deal pricing was applied.
Input
Output
original_charge_including_tax_total
original_charge_including_tax_total
Returns the opportunity charge including tax total before deal pricing was applied.
Input
Output
original_charge_total
original_charge_total
Returns the opportunity charge total before deal pricing was applied.
Input
Output
original_discount_total
original_discount_total
Returns the opportunity discount total before deal pricing was applied.
Input
Output
original_rental_charge_total
original_rental_charge_total
Returns the opportunity rental charge total before deal pricing was applied.
Input
Output
original_sale_charge_total
original_sale_charge_total
Returns the opportunity sale charge total before deal pricing was applied.
Input
Output
original_service_charge_total
original_service_charge_total
Returns the opportunity service charge total before deal pricing was applied.
Input
Output
original_surcharge_total
original_surcharge_total
Returns the opportunity surcharge total before deal pricing was applied.
Input
Output
original_tax_total
original_tax_total
Returns the opportunity tax total before deal pricing was applied.
Input
Output
owner
owner
Returns user objects with information about the user who owns the opportunity.
Input
Output
part_invoice_charge_total
part_invoice_charge_total
Returns the total of part invoices against the opportunity.
Input
Output
participants
participants
Returns contact, organization, user, vehicle, or venue objects for participants on the opportunity.
Input
Output
predicted_cost_total
predicted_cost_total
Returns the predicted cost total for an opportunity.
The predicted cost total is calculated by totalling actual costs where possible. Where an actual cost hasn't been set, the provisional cost is used.
Input
Output
product_assets
product_assets
Returns opportunity item asset objects for products on the opportunity.
Similar to the assets
object (above), but only returns product assets. Does not return service booking resource allocations.
Input
Output
products
products
Returns opportunity item objects for products on the opportunity.
Similar to the items
object (above), but only returns product opportunity items. Does not return services.
Input
Output
project
project
Returns project objects for the project that the opportunity is part of.
empty
if the opportunity isn't linked to a project.
Input
Output
project_name
project_name
Returns the name of the project that the opportunity is a part of.
nil
if the opportunity isn't linked to a project.
Input
Output
provisional_cost_total
provisional_cost_total
Returns the provisional cost total for an opportunity.
The provisional cost total is calculated by totaling provisional costs.
Input
Output
purchase_orders
purchase_orders
Returns purchase order objects for purchase orders linked to the opportunity.
Input
Output
quote_invalid_at
quote_invalid_at
Returns the value of the opportunity "Quotation valid until" field.
nil
if the opportunity isn't a quotation.
Input
Output
reference
reference
Returns the value of the opportunity customer reference.
Input
Output
rental_charge_total
rental_charge_total
Returns the rental charge total for an opportunity.
Opportunity item charge totals include surcharges, but the opportunity rental charge total object does not. You may wish to add the surcharge total object (below) to the rental charge total.
Input
Output
rentals
rentals
Investigate further
replacement_charge_total
replacement_charge_total
Returns the replacement charge total for the opportunity.
Input
Output
sale_charge_total
sale_charge_total
Returns the sale charge total for an opportunity.
Input
Output
sales
sales
Investigate further
schedule_type_is_extended?
schedule_type_is_extended?
Returns true
if the opportunity uses the extended scheduler; false
otherwise.
The scheduler type is set in System Preferences, but the scheduler type on existing opportunities won't be updated.
Input
Output
schedule_type_is_extended?
schedule_type_is_extended?
Returns true
if the opportunity uses the extended scheduler; false
otherwise.
The scheduler type is set in System Preferences, but the scheduler type on existing opportunities won't be updated.
Input
Output
schedule_type_is_standard?
schedule_type_is_standard?
Returns true
if the opportunity uses the standard scheduler; false
otherwise.
The scheduler type is set in System Preferences, but the scheduler type on existing opportunities won't be updated.
Input
Output
service_charge_total
service_charge_total
Returns the service charge total for an opportunity.
Input
Output
services
services
Investigate further
starts_at
starts_at
Returns the start date and time for the opportunity. You may also use charge_starts_at
.
Input
Output
state
state
Returns the opportunity state code.
Input
Output
state_name
state_name
Returns the opportunity state name.
State names are in the language set against your user profile.
Inquiry
Draft
Quotation
Order
Input
Output
status
status
Returns the opportunity status code.
Input
Output
status_name
status_name
Returns the opportunity status name.
Status names are in the language set against your user profile.
Open
Provisional
Reserved
Active
Completed
Canceled
Lost
Dead
Input
Output
store
store
Returns store objects for the store against the opportunity.
Input
Output
supplier_item_assets
supplier_item_assets
Returns a list of sub-rented opportunity item assets sorted by supplier.
surcharge_total
surcharge_total
Returns the surcharge total for an opportunity.
This isn't returned in the rental charge total object (above).
Input
Output
tax_class_name
tax_class_name
Returns the opportunity tax class.
This may differ from the organization tax class.
Input
Output
tax_total
tax_total
Returns the opportunity tax total.
Input
Output
use_chargeable_days
use_chargeable_days
Returns true
if the "Use Chargeable Days" toggle against the opportunity is set to YES; otherwise false
.
Input
Output
venue
venue
Returns venue objects for the venue against the opportunity.
An opportunity delivery address can be a venue, but a venue might not always be an opportunity's delivery address. If you don't choose a venue when creating an opportunity, using {{ order.venue.name }}
won't return the same as {{ order.delivery_address_name }}
.
Input
Output
weight_total
weight_total
Returns the opportunity weight total.
Input
Output
Use the company object weight unit to print the weight unit for your system.
Extended scheduler dates
prep_starts_at
prep_starts_at
Returns the “Prep“ start date and time for the opportunity.
Input
Output
prep_ends_at
prep_ends_at
Returns the “Prep“ end date and time for the opportunity.
Input
Output
load_starts_at
load_starts_at
Returns the “Load“ start date and time for the opportunity.
Input
Output
load_ends_at
load_ends_at
Returns the “Load“ end date and time for the opportunity.
Input
Output
deliver_starts_at
deliver_starts_at
Returns the “Delivery” start date and time for the opportunity.
Input
Output
deliver_ends_at
deliver_ends_at
Returns the “Delivery” end date and time for the opportunity.
Input
Output
setup_starts_at
setup_starts_at
Returns the “Setup” start date and time for the opportunity.
Input
Output
setup_ends_at
setup_ends_at
Returns the “Setup” end date and time for the opportunity.
Input
Output
show_starts_at
show_starts_at
Returns the “In Use” start date and time for the opportunity.
Input
Output
show_ends_at
show_ends_at
Returns the “In Use” end date and time for the opportunity.
Input
Output
takedown_starts_at
takedown_starts_at
Returns the “Take Down“ start date for an opportunity.
Input
Output
takedown_ends_at
takedown_ends_at
Returns the “Take Down“ end date for an opportunity.
Input
Output
collect_starts_at
collect_starts_at
Returns the “Pickup“ start date for an opportunity.
Take care not to confuse with the delivery date when customer collection is true.
Input
Output
collect_ends_at
collect_ends_at
Returns the “Pickup“ end date for an opportunity.
Take care not to confuse with the delivery date when customer collection is true.
Input
Output
unload_starts_at
unload_starts_at
Returns the “Unload“ start date for an opportunity.
Input
Output
unload_ends_at
unload_ends_at
Returns the “Unload“ end date for an opportunity.
Input
Output
deprep_starts_at
deprep_starts_at
Returns the “De-Prep“ start date for an opportunity.
Input
Output
deprep_ends_at
deprep_ends_at
Returns the “De-Prep“ ends date for an opportunity.
Input
Output
Last updated