Project
The project object contains information held against a product record.
Projects are like a folder for opportunities. They're useful for things like festivals, roadshows, and jobs with multiple areas.
Project quotation
The standard project document that comes with Current RMS is a project quotation. This returns projects in the opportunity that are quotations. It won’t return inquiries, drafts, or orders.
This is because the document uses the project.quotations
drop. If you like, you can change this to:
project.enquiries
, to return inquiries;project.drafts
, to return drafts;project.orders
, to return orders;project.opportunities
, to return all opportunities.
When using project.opportunities
, you may wish to filter by opportunity status
to exclude lost, dead, postponed, or canceled opportunities.
Opportunity ordering
Opportunities on a project document are returned in no particular order. They're displayed in the order that they're returned from our servers.
You may use the sort filter to sort an array that returns opportunities by an opportunity attribute. For example, to sort by start date:
If you try to filter by an attribute that's optional and that attribute is blank, you may get an error message.
Project totals
Total objects against a project return totals for all opportunities on the project:
charge_excluding_tax_total
charge_including_tax_total
charge_total
tax_total
sale_charge_tax_total
rental_charge_total
service_charge_total
surcharge_total
Project documents tend not to return all opportunities on the project. They'll usually return just quotations or just orders. In this case, printing totals for all opportunities in the project isn't useful.
Use variables to sum the total of opportunities printed on a document. For example, from our standard project document:
Document layouts
The project
object can be accessed in document layouts created against the following modules:
Project
Opportunity
Discussion templates
The project
object can be accessed in discussion templates created against the following modules:
Project
Opportunity
attachments
attachments
Returns attachment objects for attachments stored against a project.
Input
Output
billing_address
billing_address
Returns the project billing address.
Input
Output
billing_address_detail
billing_address_detail
Returns address objects for the billing address against the project.
Input
Output
billing_address_name
billing_address_name
Returns the name of the billing address against the project.
Input
Output
charge_excluding_tax_total
charge_excluding_tax_total
Returns the project charge total excluding tax.
Input
Output
charge_including_tax_total
charge_including_tax_total
Returns the project charge total including tax.
Input
Output
charge_total
charge_total
Returns the project charge total.
This may be including or excluding tax depending on the value of the “Catalog Prices” setting in System Preferences.
Input
Output
consolidated_items
consolidated_items
Returns a list of consolidated opportunity items for all opportunities in the project
pageConsolidated opportunity itemsconsolidated_opportunities
consolidated_opportunities
Returns a list of opportunities in a project with the same start and end date and time.
pageConsolidated opportunitiescustomer
customer
Returns organization objects for the organization against the project.
Input
Output
delivery_address
delivery_address
Returns the project delivery address.
Input
Output
delivery_address_detail
delivery_address_detail
Returns address objects for the delivery address against the project.
Input
Output
delivery_address_name
delivery_address_name
Returns the name of the delivery address against the project.
Input
Output
description
description
Returns the project description.
Input
Output
drafts
drafts
Returns opportunity objects for opportunities in the project that are drafts.
Input
Output
ends_at
ends_at
Returns the end date and time for the project.
Input
Output
enquiries
enquiries
Returns opportunity objects for opportunities in the project that are inquiries.
Input
Output
icon_url
icon_url
Returns a URL pointing at the project's image.
Input
Output
id
id
Returns the project ID.
The ID is an internal reference for a record. It's not exposed in our web interface. Projects don't have an order number.
Input
Output
image_attachments
image_attachments
Returns attachment objects for attachments stored against a project where the attachment file type is an image.
Input
Output
name
name
Returns the project subject.
Input
Output
opportunities
opportunities
Returns opportunity objects for opportunities in the project.
All opportunities are returned, regardless of state or status.
Input
Output
orders
orders
Returns opportunity objects for opportunities in the project that are orders.
Input
Output
owner
owner
Returns user objects with information about the user who owns the project.
Input
Output
participants
participants
Returns contact, organization, user, vehicle, or venue objects for participants on the opportunity.
Input
Output
project_invoicing
project_invoicing
Returns true
if Project Invoicing is enabled; false
otherwise.
Input
Output
quotations
quotations
Returns opportunity objects for opportunities in the project that are quotations.
Input
Output
reference
reference
Returns the value of the project customer reference.
Input
Output
rental_charge_total
rental_charge_total
Returns the rental charge total for a project.
Opportunity item charge totals include surcharges, but the project and opportunity rental charge total object does not. You may wish to add the surcharge total object (below) to the rental charge total.
Input
Output
sale_charge_total
sale_charge_total
Returns the sale charge total for a project.
Input
Output
service_charge_total
service_charge_total
Returns the service charge total for a project.
Input
Output
starts_at
starts_at
Returns the start date and time for the project.
Input
Output
store
store
Returns store objects for the store against the project.
Input
Output
surcharge_total
surcharge_total
Returns the surcharge total for a project.
This isn't returned in the rental charge total object.
Input
Output
tax_class_name
tax_class_name
Returns the project tax class.
This may differ from the organization tax class.
Input
Output
tax_total
tax_total
Returns the project tax total.
Input
Output
venue
venue
Returns venue objects for the venue against the project.
A project delivery address can be a venue, but a venue might not always be a project's delivery address. If you don't choose a venue when creating an project, using {{ project.venue.name }}
won't return the same as {{ project.delivery_address_name }}
.
Input
Output
Last updated