Back

Full Variables guide

The Enerpize software provides a guide of variables for the fields in both sales, purchases, customers, suppliers, and more. With it, you can create a flexible print template design that adapts dynamically without the need to manually edit the template data again.

Sales Invoice Variables

 

  • Client Business Name: {%client_business_name%}
    • This variable represents the business name of the client, for example: “Enerpize Business Management Company” within the client’s profile.
      • Note: This variable can be used whether the client is a business or an individual.
  • Client Name: {%client_name%}
    • This variable represents the first name and last name of the client for whom an invoice has been issued.
  • Client First Name: {%client_first_name%}
    • This variable represents the first name of the client within the client’s profile for whom an invoice has been issued.
  • Client Last Name: {%client_last_name%}
    • This variable represents the last name of the client within the client’s profile for whom an invoice has been issued.
  • Client Address: {%client_address%}
    • This variable represents both Street Address 1 and Street Address 2 within the client’s profile for whom an invoice has been issued.
  • Client City: {%client_city%}
    • This variable represents the city of the client within the client’s profile for whom an invoice has been issued.
  • Client State/Region: {%client_state%}
    • This variable represents the state or region of the client within the client’s profile for whom an invoice has been issued.
  • Client Postal Code: {%client_postal_code%}
    • This variable represents the postal code of the client within the client’s profile for whom an invoice has been issued.
  • Client Country: {%client_country%}
    • This variable represents the country within the client’s profile for whom an invoice has been issued.
  • Client Number: {%client_number%}
    • This variable represents the client number within the client’s profile for whom an invoice has been issued.
  • Invoice Number: {%invoice_no%}
    • This variable represents the invoice number that has been issued.
  • Invoice Date: {%invoice_date%}
    • This variable represents the date the invoice was issued.
  • Invoice Manual Status: {%manual_status%}
    • This variable represents the manual status assigned to the invoice.
  • Due Date: {%due_date%}
    • This variable represents the due date of the invoice, which is determined by adding a specified number of days to the “Payment Terms” field when adding the invoice.
      • The due date of the invoice is generated by adding a specified number of days to the ‘Payment Terms’ field when adding the invoice.
  • Release Date: {%issue_date%}
    • This variable represents the “Invoice Issue Date” field that was added to the “Issue Date” field when creating the invoice.
      • This field is used when the invoice issue date is different from its creation date.
  • Invoice subtotal: {%invoice_subtotal%}
    • This variable represents the “Subtotal” value of the invoice items before adding the value of the added tax.
  • Total Invoice Amount: {%invoice_total%}
    • This variable represents the “Total” value of the invoice items after calculating and adding the value of the added tax.
  • Amount Due: {%deposit%}
    • This variable represents the “Next Payment” value added in the “Deposit” field when creating the invoice.
      • To make this variable affect the invoice template, make sure not to click on “Already Paid” inside the “Deposit” data.
  • Paid Amount: {%paid%}
    • This variable represents the “Paid Amount” from the total invoice amount.
      • Example: If the total invoice amount is 1,000 Riyals and the amount paid is 500 Riyals, then the amount displayed based on this variable is 500.
  • Remaining Amount: {%unpaid%}
    • This variable represents the “Amount Due for Payment” from the total invoice amount.
      • Example: If the total invoice amount is 1,000 Riyals, 400 Riyals have been paid, and the client owes 600 Riyals, then the amount displayed based on this variable is 600.
  • Discount: {%discount%}
    • This variable represents the “Total Discount Amount” added from the “Discount and Adjustment” field.
      • This variable will not display item-level discount data but will only show the total discount amount.
  • Total Taxes: {%tax-total%}
    • This variable represents the “Total Tax Amount” added to the total invoice amount.
      • Example: If the total invoice amount is 100 Riyals exclusive of tax, and the tax rate is 15%, which is 15 Riyals, this is the number displayed based on this variable.
  • Item discount Total: {%item-discount-total%}
    • This variable represents the “Item-Level Discount Amount” added in the discount field for each item separately.
      • This variable will display item-level discount data only and will not be affected by the total-level discount.
  • Payment Link: {%payment_link%}
    • This variable represents the “Payment Link” specific to the invoice, which is sent to the customer via email or SMS.
      • This field is used in email or SMS templates and not in print templates.
  • View Link: {%view_link%}
    • This variable represents the “Invoice View Link,” which is sent to the customer via email or SMS.
      • This field is used in email or SMS templates and not in print templates.
  • Short Link: {%short-link%}
    • This variable represents the “Short Link for Invoice View,” which is sent to the customer via email or SMS.
      • This field is used in email or SMS templates and not in print templates.
  • Invoice Notes: {%invoice_notes%}
    • This variable represents the data added in the “Notes” field when creating the invoice.
  • Invoice Barcode: {%invoice_barcode%}
    • This variable represents the image of the “Invoice Barcode.”
  • Invoice Barcode Number: {%invoice_barcode_number%}
    • This variable represents the “Invoice Barcode Number,” which is automatically generated by the software.
  • Invoice currency code: {%invoice_currency_code%}
    • This variable represents the “Currency” used in adding the invoice.
  • Creation Date: {%created_date%}
    • This variable represents the “Invoice Creation Date” field, which is the date the invoice was recorded in the software.
  • Creation Time: {%created_time%}
    • This variable represents the “Invoice Creation Time” in the software, which is the time the invoice was recorded.
  • Client view link: {%client_view_link%}
    • This variable represents the “Invoice View Link” sent to the customer via email or SMS.
      • This field is used in email or SMS templates and not in print templates.
  • QR Code Link: {%qr_code_link%}
    • This variable represents the link to the “QR Code,” which is generated upon saving the invoice.
  • QR Code Image: {%qr_code_image%}
    • This variable represents the image of the “QR Code,” which is generated upon saving the invoice.
      • This variable represents a regular QR Code and is not specific to the Kingdom of Saudi Arabia and the Zakat and Income Authority.
  • Owner view link: {%owner_view_link%}
    • This variable represents the “Invoice View Link” specific to the account owner.
  • Warehouse: {%ware_house%}
    • This variable represents the “Warehouse” chosen when creating the invoice.
  • Salesperson: {%sales_person%}
    • This variable represents the “Salesperson” field assigned when creating the invoice.
  • Invoice Item Count: {%invoice_item_count%}
    • This variable represents the “Total Item Count” selected in the sales invoice.
  • Invoice quantity count: {%invoice_item_qty%}
    • This variable represents the “Total Quantity Sold” in the sales invoice.
  • Invoice payment status: {%invoice_payment_status%}
    • This variable represents the “Payment Status” specific to the sales invoice, e.g., Paid or Unpaid.
  • Client Balance: {%extra_details.client_balance%}
    • This variable represents the “Client Balance” before adding and saving a new invoice.
  • Advanced Client balance: {%invoice_advanced_client_balance%}
    • This variable represents the “Client Balance” after adding and saving the latest invoice.
  • Invoice Payment List: {%invoice_payment_table%}
    • This variable represents the “Client Payment Table,” which shows payment methods and the value of each payment separately.
  • Spelled Total Invoice Amount: {%invoice_total_spelled%}
    • This variable represents the “Total Invoice Amount in Words,” which shows the total invoice amount in words.
  • Spelled Deposit Amount: {%deposit_spelled%}
    • This variable represents the “Deposit Amount in Words,” which shows the next payment amount in words added in the “Deposit” field when creating the invoice.
  • Spelled Paid Amount: {%paid_spelled%}
    • This variable represents the “Paid Amount” from the total invoice amount in words.
  • Spelled Unpaid  Amount: {%unpaid_spelled%}
    • This variable represents the “Amount Due for Payment” from the total invoice amount in words.
  • Spelled Discount Amount: {%discount_spelled%}
    •  This variable represents the “Discount on Total Amount” in words.
  • Note: If any additional fields are added to sales invoices, the field name will appear in the invoice variable screen, and the corresponding variable to be used in the print template will correspond to it.

Clients-specific variables

 

  • Client Company: {%client_business_name%}
    • This variable represents the client’s business name, for example: “Enerpize Business Management Company,” within the client file.
      • Note: This variable can be used for both commercial and individual clients.
  • Client Code: {%client_number%}
    • This variable represents the “Client Code” within the client file.
  • Client First Name: {%client_first_name%}
    • This variable represents the client’s first name within the client file.
  • Client Last Name: {%client_last_name%}
    • This variable represents the client’s last name within the client file.
  • Client Phone: {%client_phone%}
    • This variable represents the “Phone” field within the client file.
  • Client Mobile: {%client_mobile%}
    • This variable represents the “Mobile” field within the client file.
  • Client Email: {%client_email%}
    • This variable represents the “Email” field within the client file.
  • Full Client Address: {%client_full_address%}
    • This variable represents “Street Address 1” and “Street Address 2” together within the client file.
  • Client Street: {%client_address%}
    • This variable represents the “Street Address” within the client file.
  • Postal Code: {%client_postcode%}
    • This variable represents the client’s postal code within the client file.
  • City: {%client_city%}
    • This variable represents the client’s city within the client file.
  • State/Region: {%client_state%}
    • This variable represents the client’s state or region within the client file.
  • Client Country: {%client_country%}
    • This variable represents the client’s country within the client file.
  • Secondary Client Address: {%client_secondary_address%}
    • This variable represents “Street Address 1” and “Street Address 2” together for a secondary address added to the client file.
      • Note: This variable is associated with adding a secondary address for the client through the “Add Secondary Address” field located below the client’s page.
  • Second Client Postal Code: {%client_secondary_postcode%}
    • This variable represents the second postal code for the client within the client file.
      • Note: This variable is associated with adding a secondary address for the client through the “Add Secondary Address” field located below the client’s page.
  • Second Client City: {%client_secondary_city%}
    • This variable represents the second city field for the client within the client file.
      • Note: This variable is associated with adding a secondary address for the client through the “Add Secondary Address” field located below the client’s page.
  • Second Client State/Region: {%client_secondary_state%}
    • This variable represents the second state/region field for the client within the client file.
      • Note: This variable is associated with adding a secondary address for the client through the “Add Secondary Address” field located below the client’s page.
  • Second Client Country: {%client_secondary_country%}
    • This variable represents the second country field for the client within the client file.
      • Note: This variable is associated with adding a secondary address for the client through the “Add Secondary Address” field located below the client’s page.
  • Business Registration Number: {%client_bn1%}
    • This variable represents the “Business Registration” field for the client within the client file.
  • Tax Identification Number: {%client_bn2%}
    • This variable represents the “Tax ID” field for the client within the client file.
  • Client Business Info 1: {%client_business_registration_info1%}
    • This variable represents the “Business Registration Information” for the client within the client file.
  • Client Business Info 2: {%client_business_registration_info2%}
    • This variable represents the “Tax Registration Information” for the client within the client file.
  • Client Barcode: {%client_barcode%}
    • This variable represents the client’s barcode image, which is added by the program.
  • Client Barcode Number: {%client_barcode_number%}
    • This variable represents the “Barcode Number” specific to the client.
      • Note: This number is automatically generated by the program.
  • Client photo: {%client_photo%}
    • This variable represents the field for the “Client Photo.”
  • Client Status Name: {%client_status_name%}
    • This variable represents the manual status of the “Client.”
  • Client Category: {%client_category%}
    • This variable represents the “Category” field within the client file.
  • Client Location: {%client_location%}
    • This variable represents the “Client Location on Map” field within the client file.
      • Note: Ensure that the “Location on Map” field for the client is activated through the “Client Settings” for this variable to have an effect.
  • Client Starting Balance: {%client_starting_balance%}
    • This variable represents the “Starting Balance” field within the client file.
      • Note: Ensure that the “Starting Balance” field for the client is activated through the “Client Settings” for this variable to have an effect.
  • Client Gender: {%client_gender%}
    • This variable represents the “Gender” field within the client file.
      • Note: Ensure that the “Gender” field for the client is activated through the “Client Settings” for this variable to have an effect.
  • Client National ID: {%client_national_id%}
    • This variable represents the “National ID” field within the client file.
      • Note: Ensure that the “National ID” field for the client is activated through the “Client Settings” for this variable to have an effect.

Note: If additional fields are added for clients, the field name will appear on the client variable screen, and the corresponding variable should be used in the print template.

Variables for Purchase Invoices

 

  • Business Name: {%business_name%} 
    • This variable represents the “Business Name” field for your organization, which is set through the “Account Settings” page.
  • Business Email: {%business_email%} 
    • This variable represents the “Business Email” field for your organization, which is set through the “Account Settings” page.
  • Business Address 1: {%address1%} 
    • This variable represents the “Street Address 1” field for your organization, which is set through the “Account Settings” page.
  • Business Address 2: {%address2%} 
    • This variable represents the “Street Address 2” field for your organization, which is set through the “Account Settings” page.
  • Business City: {%city%} 
    • This variable represents the “City” field for your organization, which is set through the “Account Settings” page.
  • Business State: {%state%} 
    • This variable represents the “State” field for your organization, which is set through the “Account Settings” page.
  • Postal Code: {%postal_code%} 
    • This variable represents the “Postal Code” field for your organization, which is set through the “Account Settings” page.
  • Business Telephone: {%telephone%} 
    •  This variable represents the “Telephone” field for your organization, which is set through the “Account Settings” page.
  • Business Mobile: {%mobile%} 
    • This variable represents the “Mobile” field for your organization, which is set through the “Account Settings” page.
  • Supplier Business Name: {%supplier_business_name%} 
    • This variable represents the “Supplier Business Name” field, which is set within the “Add Supplier” page.
  • Supplier Name: {%supplier_name%} 
    • This variable represents the first and last name of the supplier within the invoice created for them.
  • Supplier Address: {%supplier_address%} 
    • This variable represents the “Supplier Address” field, which is set within the supplier’s file for the invoice.
  • Supplier City: {%supplier_city%}
    •  This variable represents the “City” field, which is set within the “Add Supplier” page.
  • Supplier State: {%supplier_state%} 
    • This variable represents the “State/Region” field, which is set within the “Add Supplier” page.
  • Supplier Postal Code: {%supplier_postal_code%} 
    • This variable represents the “Postal Code” field, which is set within the “Add Supplier” page.
  • Supplier Country: {%supplier_country%} 
    • This variable represents the “Country” field, which is set within the “Add Supplier” page.
  • Purchase Order Number: {%purchaseorders_no%}
    •  This variable represents the “Purchase Order Number” field, which is the unique sequence for the added purchase order.
  • Purchase Order Date: {%purchaseorders_date%} 
    • This variable represents the “Date” field set when adding a new purchase order.
  • Total Purchase Order: {%purchaseorders_total%}
    •  This variable represents the value of the “Total Purchase Order” for the issued purchase order.
  • Purchase Order note: {%po_note%}
    • This variables represents the “Notes” field for the issued purchase order.
  • Warehouse: {%ware_house%} 
    • This variable represents the “Warehouse” field for the issued purchase order.
  • Purchase Invoice quantity count: {%po_item_qty%}
    • This variable represents the “Total Quantity Sold” field for the items in the issued purchase order.
  • Discount: {%discount%}  
    • This variable represents the value of the “Discount on Total” amount added from the “Discount and Settlement” field.
      • Note: This variable will not display item-level discount data but will only display the “Discount on Total” value.
  • Item discount Total: {%item-discount-total%}
    • This variable represents the value of the “Item-Level Discount” added in the discount field for each item individually.
    • Note: This variable will display item-level discount data only and will not be affected by the “Discount on Total” value.
  • Purchase Invoice Tax total: {%purchaseorder_tax_total%}
    • This variable represents the value of the “Total Tax” added to the total value of the purchase order.
      • Example: If the total invoice amount is 100 Riyals excluding tax, and the tax rate is 15%, i.e., 15 Riyals, this is the number displayed based on this variable.
  • Purchase Invoice subtotal: {%purchaseorder_subtotal%}
    • This variable represents the “Subtotal” value for the items in the purchase order before calculating the added tax.
  • Purchase Invoice total Spelled: {%purchaseorder_total_spelled%}
    • This variable represents the “Purchase Invoice Total in Words” and provides the total value in words.
  • Purchase Invoice total tax Spelled: {%purchaseorder_total_tax_spelled%}
    • This variable represents the “Purchase Invoice Total Tax in Words” and provides the tax amount in words in the invoice.

Supplier-specific variables

 

  • Supplier Business Name: {%supplier_business_name%} 
    • This variable represents the “Supplier Business Name” field, which is set within the “Add Supplier” page.
  • Supplier Number: {%supplier_number%} 
    • This variable represents the “Supplier Code” field found within the “Add Supplier” page.
  • Supplier First Name: {%supplier_first_name%} 
    • This variable represents the “First Name” field found within the supplier’s file.
  • Supplier Last Name: {%supplier_last_name%} 
    •  This variable represents the “Last Name” field found within the supplier’s file.
  • Supplier Phone: {%supplier_mobile%} 
    • This variable represents the “Phone” field found within the supplier’s file.
  • Supplier Mobile: {%supplier_phone%}
    • This variable represents the “Mobile” field found within the supplier’s file.
  • Supplier Email: {%supplier_email%} 
    • This variable represents the “Email” field found within the supplier’s file.
  • Supplier Full Address: {%supplier_full_address%}
    •  This variable represents the “Full Supplier Address,” including Supplier Street 1, Supplier Street 2, Supplier City, and Supplier State.
  • Supplier Address: {%supplier_address%} 
    • This variable represents the “Supplier Address,” including Supplier Street 1 and Supplier Street 2.
  • Supplier City: {%supplier_city%} 
    • This variable represents the “City” field, which is set within the “Add Supplier” page.
  • Supplier State: {%supplier_state%} 
    • This variable represents the “State/Region” field, which is set within the “Add Supplier” page.
  • Supplier Postal Code: {%supplier_postal_code%} 
    • This variable represents the “Postal Code” field, which is set within the “Add Supplier” page.
  • Supplier Country: {%supplier_country%} 
    • This variable represents the “Country” field, which is set within the “Add Supplier” page.
  • Secondary Street Address: {%supplier_secondary_address%}  
    • This variable represents the “Secondary Street Address,” which includes Supplier Secondary Street 1 and Supplier Secondary Street 2, found within the supplier’s file.
      • Note: This variable is associated with adding a secondary address for the supplier through the “Add Secondary Address” field located below the supplier’s profile.
  • Supplier Secondary Postcode: {%supplier_secondary_postcode%}
    • This variable represents the “Secondary Postal Code” field found within the supplier’s file.
      • Note: This variable is associated with adding a secondary address for the supplier through the “Add Secondary Address” field located below the supplier’s profile.
  • Supplier Secondary City: {%supplier_secondary_city%}
    • This variable represents the “Secondary City” field found within the supplier’s file.
      • Note: This variable is associated with adding a secondary address for the supplier through the “Add Secondary Address” field located below the supplier’s profile.
  • Supplier Secondary State: {%supplier_secondary_state%}
    • This variables represents the “Secondary State/Region” field found within the supplier’s file.
          • Note: This variable is associated with adding a secondary address for the supplier through the “Add Secondary Address” field located below the supplier’s profile.
  • Supplier Secondary Country: {%supplier_secondary_country%}
    • This variable represents the “Secondary Country” field found within the supplier’s file.
      • Note: This variable is associated with adding a secondary address for the supplier through the “Add Secondary Address” field located below the supplier’s profile.
  • Business Registration: {%supplier_bn1%}
    • This variable represents the “Business Registration” field for the supplier found within the supplier’s file.
  • Tax ID: {%supplier_bn2%}
    • This variable represents the “Tax ID” field for the supplier found within the supplier’s file.
  • Supplier Business Info 1: {%supplier_business_registration_info1%}
    • This variable represents additional “Business Registration Information” for the supplier found within the supplier’s file.
  • Supplier Business Info 2: {%supplier_business_registration_info2%}
    • This variable represents additional “Tax Registration Information” for the supplier found within the supplier’s file.
  • Note: If any additional fields are added for suppliers, the field name will appear on the supplier variables screen and will correspond to the variable to be used in the print template.