Reference for variables and default templates inside Cashboard.

The Cashboard liquid template SYNTAX OVERVIEW can be found here.

Special Template Names

Cashboard recognizes a set of default templates that are necessary to drive the application.

They are as follows

• company
  • Handles display of company address information on both documents.
• css_document
  • Holds CSS information and included by default in estimate and invoice
• email_*
  • Various emails that Cashboard sends to your clients
• html_estimate
  • Estimate document
• html_invoice
  • Invoice document

Variables

These are the different variables you can access from your Liquid templates inside Cashboard.

Some of these variables are collections, which can be looped using this syntax: {% for thing in collection %} {% endfor %}

Collections are noted here by nested list items. Assuming you’d like to access a nested item (like the company name for your account), you’d do this: {{ account.company.name }}

Account

• company
• full_url
• subdomain

Contact

Accessable from any email template

• first_name
• last_name
• email_address
• last_login

Company

Accessable as a collection from Account, Estimate, Invoice

• address
• address2
• balance
  (This company’s overall monetary balance with you. Can be a negative number.)
• city
• country
• custom_1
• custom_2
• custom_3
• name
• outstanding_credit
  (The unapplied payment amount your client has with you. Never will be a negative number.)
• state
• telephone
• url
• zip

Estimate

Accessable from html_estimate, email_estimate_notice

• agreed_to
• agreement_text
• client_url
• company
• created_on
• has_worst_case_items
  (Did you use high numbers to estimate this as well as low?)
• id
• intro_text
• line_item_count
• line_items
  • description
  • estimate_time
    Biggest number, either high or low – hours
  • flat_fee
  • has_flat_fee
  • has_rate
  • has_worst_case
  • is_taxable
  • price_best
  • price_worst
  • rate
  • title
  • time_best (for task items only)
  • time_worst (for task items only)
  • unit_label
    Hours, units, things, etc
  • quantity_low
  • quantity_high
  • quantity_estimate
    The biggest number, either high or low
  • type
    Task, Product, Generic
• price_best
• price_worst
• name
• project
  • id
  • name
• requires_agreement
• sales_tax
• sales_tax_2
• status
  (Ready to go | Needs agreement)
• tax_cost_total_low
• tax_cost_total_high
• time_best
  (Best case estimated hours)
• time_worst

Invoice

Accessable from html_invoice, email_invoice_notice

• client_url
• company
• final_cost
  (Total of the invoice)
• has_been_paid
  (Has this invoice been paid in full?)
• id
• include_time_entries
  (Should we show time entries on this invoice? Controlled by details checkbox.)
• item_cost
• late_cost
• late_percentage
• late_period_in_days
• line_item_count
• line_items
  (Individual items)
  • description
  • final_cost
  • flat_fee
  • price_per
  • project
    (Contains associated project name if it exists)
  • quantity
  • time_entry_count
  • time_entries
    • created_on
    • minutes
    • person_name
    • description
  • title
• notes
• payment_count
• payments
  (Payments made on invoice)
  • amount
  • created_on
  • id
• project_count
• projects
  (Projects this invoice is for)
  • id
  • name
• sales_tax
• sales_tax_2
• tax_cost
  (Dollar amount of tax cost)
• tax_cost_2
  (Dollar amount of tax cost 2)
• total_due
  (Amount remaining to be paid on invoice)