Templates

Variables (Proposals)

The following variables are available in the template.ejs files of proposal templates:

#Variables

proposalProposalThe proposal that is being rendered.
showCakedeskBranding boolean Whether or not to display Cakedesk branding on the proposal.

#Proposal

proposalId string

The user-facing proposal ID.
Example: "2"

language string

The language of the proposal.
Example: "en"

proposalDate string

The date of the proposal.
Example: "2022-09-13"

hasVat boolean Does the proposal include VAT?
hasQuantities boolean Does the proposal include quantities for each individual item?
introTextRichTextA piece of text to go along with the proposal.
buyerProposalBuyerThe client.
sellerProposalSellerYou.
itemsProposalItem[]The individual items that make up the proposal.
taxSubtotalsTaxSubtotal[]

An array of tax subtotals. Only relevant if hasVat is true. If your proposal items contain multiple VAT percentages, this field will include multiple VAT percentages as well.

totalTaxesMoneyValueThe total amount of taxes included in this proposal. The sum of all VAT.
subtotalMoneyValueThe total amount without taxes.
totalMoneyValueThe total amount including taxes.

#ProposalBuyer

id string

The client's user-facing ID.
Example: "1643505266"

name string

The full name of the client.
Example: "Restful Ltd."

vatId string

The VAT ID of the client.
Example: "DE123456789"

addressAddressThe address of the client.

#ProposalSeller

name string

Your company name.
Example: "Restful Ltd."

vatId string

Your VAT ID.
Example: "DE123456789"

phone string

Your phone number.
Example: "+49 (0) 170 123 456"

email string

Your email.
Example: "mail@example.com"

website string

Your website.
Example: "https://example.com"

addressAddressYour address.

#Address

addressLine1 string

The first part of the address.
Example: "Weichselstraße 65"

addressLine2 string

The second part of the address.
Example: "Building 2"

zipCode string

The zip code of the address
Example: "54747"

city string

The city.
Example: "Berlin"

countryCode string

The country code.
Example: "DE"

#ProposalItem

title string The title of the item.
descriptionRichTextAn optional description for the item. Can be an empty string.
unitPriceMoneyValueThe price of a single unit of that item. Only relevant if proposal.hasQuantities is true.
quantity number How many of this item were sold. Only relevant if proposal.hasQuantities is true.
amountMoneyValueThe total price of this item (excluding VAT).
vatPercentage number | null

How much VAT is applied for this item. Only relevant if proposal.hasVat is true.
Example: 19 or null

itemsProposalItem[]Only the top-level proposal items can have child items.

#TaxSubtotal

vatPercentage number

The VAT percentage of this tax subtotal.
Example: 19

subtotalMoneyValueThe amount of this tax subtotal

#MoneyValue

currency string

The currency of this particular value.
Example: "EUR"

amount number

The amount for this particular value, in cents.
Example: 450000

#RichText

Variables with type RichText are strings of HTML markup. It can include the following tags:

  • <p>
  • <ul>
  • <ol>
  • <li>
  • <strong>