Email Template Twig Variables Overview
Introduction to Twig variables in Upmind email templates.
Last updated 10 days ago
Twig variables are dynamic placeholders used in Upmind’s email templates to personalise and automate message content. You can use these variables in two ways:
Settings > Actions
Settings > Email Templates
Account Twig variables
Variable | Description |
id | Unique identifier of the account |
name | Account name |
type | Account type designation |
status | Account current status |
created_at | Date and time the account was created |
updated_at | Last update timestamp of the account |
client | Associated client information |
arrears_credit_maximum | Maximum arrears credit allowed |
arrears_credit_available | Currently available arrears credit |
arrears_credit_used | Used arrears credit |
arrears_credit_available_converted_formatted | Formatted available credit in the account currency |
arrears_credit_used_converted_formatted | Formatted used credit in the account currency |
arrears_credit_maximum_converted_formatted | Formatted maximum credit in account currency |
currency | Account currency |
enable_negative_wallet_balance | Flag for allowing a negative wallet balance |
Brand Twig variables
Variable | Description |
id | Brand unique identifier |
name | Brand name |
code | Brand code |
prefix | Prefix used by the brand |
portal_domain | Main portal domain for the brand |
company_name | Legal or business name of the brand |
company_address | Official address |
company_phone | Contact phone number |
company_email | Contact email |
country | Brand’s operational country |
language | Default language configured for the brand |
currency | Default currency |
tax_type | Tax configuration type |
vat_number | VAT number for the brand |
payment_days_term | Default payment term in days |
create_invoice_term | Term for invoice creation timing |
style | Styling parameters or theme |
logo_src | URL to the brand’s logo image |
created_at | Brand creation timestamp |
updated_at | Last updated timestamp |
customer_portal_domain | URL for customer-facing portal |
staff_portal_domain | URL for staff admin portal |
organisation | Associated organisation |
Brand hook template Twig variables
Variable | Description |
id | Unique hook template identifier |
brand_id | Associated brand identifier |
hook_id | Identifier for the hook (event trigger) |
template_id | Template associated with the hook |
enabled | Boolean indicating if the hook template is active |
locked | Boolean marking the template as locked / uneditable |
created_at | Creation timestamp |
updated_at | Last update timestamp |
deleted_at | Timestamp for soft deletion |
Bulk action Twig variables
Variable | Description |
status | Status of the bulk action |
id | Bulk action unique identifier |
name | Bulk action name |
org_id | Organisation involved |
brand_id | Brand involved |
user_id | User who triggered the action |
status_id | Internal status ID |
retried | Count of retry attempts |
reschedule_id | ID of any scheduled re-run |
action_type | Type of action executed |
action_data | Additional data related to the action |
segment_id | ID for client segment targeted |
refresh_segment | Flag to update client segment after action |
object_type | Type of object acted upon |
object_ids | List of IDs for objects involved |
num_scheduled | Number of actions scheduled |
num_successful | Number of successful actions |
num_failed | Number of failed actions |
started_at | Start timestamp of the action |
completed_at | Completion timestamp |
created_at | Creation timestamp |
updated_at | Last updated timestamp |
deleted_at | Deletion timestamp (soft delete) |
duplicate_id | Tracking ID for duplicate action |
Client Twig variables
Variable | Description |
id | Unique client identifier |
first_name | Client’s first name |
last_name | Client’s last name |
login_email | Email used for login |
notification_email | Email used to receive notifications |
twofa_enabled | Flag if two-factor authentication is enabled |
twofa_provider | Provider used for two-factor authentication |
reg_hash | Registration hash |
reg_hash_expiry | Expiry time for registration hash |
verified | Flag if email or account is verified |
avatar_src | URL to client avatar image |
interface_language | Preferred UI language |
document_language | Preferred document language |
created_at | Account creation timestamp |
updated_at | Last profile update timestamp |
has_password | Flag if password is set |
has_login | Flag if login is enabled |
is_guest | Flag if it’s a guest user |
full_name | Full name of client |
default_payment_details | Default payment details |
default_address | Default physical address |
import_id | Import source identifier |
staged_import | Flag indicating staged import |
external_id | External system ID |
support_pin | Support pin code |
support_pin_expiry_datetime | Expiry datetime of support pin |
firstname | Alternative access to first name |
lastname | Alternative access to last name |
Alternate access to primary email | |
location_source | Source of client location |
location_town | Town or city |
location_country_code | Country code |
location_ip | IP address |
user_id | Associated user ID |
upmind_org_user_id | Organisation user ID |
reseller_account_id | Reseller client association id |
interface_language_id | Numeric UI language ID |
document_language_id | Numeric document language ID |
deleted_at | Soft delete timestamp |
apply_credit | Flag if credits applied |
credit | Credit balance |
consolidate_invoice | Invoice consolidation enabled |
consolidation_day | Day of invoice consolidation |
bf_id | Billing framework ID |
ip_address | Client IP address |
enabled_2fa | Two factor authentication enabled |
provider_2fa_id | Two factor provider ID |
org_id | Organisation ID |
picture | Client picture URL |
brand_id | Associated brand ID |
last_login | Last login timestamp |
fraud_policy | Fraud detection policy |
fraud_status | Fraud status |
failed_login_attempts | Failed login attempt count |
notifications_disabled | Notifications disabled status |
meta | Metadata |
order_template_code | Default order template code |
interface_language_code | Language code for UI |
document_language_code | Language code for documents |
fullname | Full client name |
public_name | Publicly displayed name |
secret_2fa_exists | Two-factor secret existence |
image_url | Client image URL |
topup_enabled | Prepaid top-up enabled |
upmind_org_user | Organisation user object |
upmind_package_limits | Package limits |
emails | List of client emails |
image | Client image |
invoice_consolidation_enabled | Invoice consolidation enabled |
invoice_consolidation_base_rule | Base rule for invoice consolidation |
invoice_consolidation_base_rule_date_of_month_day | Month day for consolidation |
invoice_consolidation_base_rule_day_of_week | Day of week for consolidation |
block_new_tickets_from_email | Block new support tickets from email |
default_email | Default client email |
custom_fields | Custom client field data |
custom_field_values | Values of custom fields |
tax_type | Tax type |
default_phone | Default phone number |
username | Username |
login_username | Login username |
before_due_date_charge_interval | Pre-due date charge interval |
before_due_date_charge_interval_dd | Pre-due date charge interval (days) |
manage_notification_subs_token | Notification subscription management token |
parent_client_config | Parent client configuration |
tags | Tags associated with the client |
never_suspend | Flag to never suspend the client |
never_cancel | Flag to never cancel the client |
never_close | Flag to never close the client |
failed_2fa_attempts | Count of failed 2FA attempts |
has_legacy_invoices | Flag for legacy invoices |
exclude_from_uuid_encoding | Exclude from UUID encoding |
status_id | Client status ID |
number | Client number |
settings | Client settings configurations |
tax_exempt_code | Tax exemption code |
tax_exempt_number | Tax exemption number |
email_2fa_code | Two-factor email code |
email_2fa_validity_period_seconds | Two-factor email code validity period |
Client vault asset Twig variables
Variable | Description |
id | Unique identifier of the asset |
import_id | External import reference for the asset |
staged_import | Flag indicating if the asset is from staged import |
external_id | External system ID |
client_id | Associated client identifier |
lead_id | Lead identifier if applicable |
user_id | Related user identifier |
label | Label or name of the asset |
note | Additional notes |
pinned | Flag to pin asset for priority or visibility |
visible_for_client | Asset visibility permission |
encrypted | Encryption status of the asset |
contract_product_id | Linked contract product ID |
created_at | Creation timestamp |
updated_at | Last update timestamp |
author_client_id | Client ID of asset author |
author_user_id | User ID of asset author |
editor_client_id | Client ID of last editor |
editor_user_id | User ID of last editor |
locked | Lock status to prevent modifications |
Client address Twig variables
Variable | Description |
id | Unique address ID |
client_id | Client linked to the address |
user_id | User linked to the address |
default | Is this address the default one? |
type | Address type (billing, shipping, etc.) |
name | Name associated with the address |
address_1 | Primary address line |
address_2 | Secondary address line |
country_id | Country reference ID |
state | State or province |
city | City |
postcode | Postal or ZIP code |
created_at | Creation timestamp |
updated_at | Last modification timestamp |
deleted_at | Soft deletion timestamp |
verified | Verification status |
region_id | Region reference |
can_delete | Permission flag for deletion |
import_id | Import reference |
staged_import | Staged import flag |
external_id | External system ID |
region | Region name |
country | Country name |
client | Client object |
county | County name |
Client company Twig variables
Variable | Description |
id | Company identifier |
address_id | Linked address ID |
phone_id | Linked phone number ID |
default | Is this company the default for client? |
verified | Verification status |
created_at | Creation date |
updated_at | Last update date |
deleted_at | Soft deletion date |
name | Company name |
vat_number | VAT registration number |
reg_number | Company registration number |
vat_percent | VAT percentage |
client_id | Linked client ID |
email_id | Email linked to company |
user_id | User linked |
can_delete | Permission to delete |
import_id | Import reference |
staged_import | Staged import flag |
external_id | External system ID |
client | Linked client object |
vat_validated | VAT validation status |
vat_validation_failed_reason | Reason for VAT validation failure |
vat_validated_with | Method of VAT validation |
vat_validation_checked_at | VAT validation check date |
Client email Twig variables
Variable | Description |
id | Email record identifier |
Email address | |
reg_hash | Registration hash for verification |
type | Email type (primary, secondary, etc.) |
default | Is this the default email? |
verified | Verification status |
created_at | Record creation date |
updated_at | Last updated date |
client_id | Client associated with this email |
reg_hash_expiry | Expiry date/time of reg hash |
client | Client object |
Client payment method Twig variables
Variable | Description |
active | Is the payment method active? |
id | Payment method identifier |
user_id | User linked to payment method |
client_id | Client associated |
name | Payment method name |
currency_id | Currency identifier |
default | Is this the default payment method? |
address_id | Address linked to payment |
card_type | Card brand/type |
card_last4 | Last four digits of card |
card_expire_date | Expiry date of the card |
allow_bacs | BACS payment allowed? |
allow_cheque | Cheque payment allowed? |
created_at | Creation timestamp |
updated_at | Last update timestamp |
gateway_id | Gateway used |
type | Payment method type |
pre_expiry_notification | Notify before expiry |
can_delete | Can this method be deleted? |
external_id | External identifier |
errors | Error descriptions |
manual | Manual payment method? |
next_action | Next action required |
sca_verified | Strong customer authentication verified? |
import_id | Import reference |
staged_import | Staged import flag |
auto_payment | Is auto payment enabled? |
client | Client object |
payment_method_type | Type of payment method |
autopayment_blocked | Is auto payment blocked? |
autopayment_blocked_reason | Reason for blocking auto payment |
Client phone Twig variables
Variable | Description |
id | Phone record identifier |
client_id | Client associated |
user_id | User linked |
type | Phone type (mobile, home, etc.) |
default | Is default phone number? |
verified | Verification status |
phone | Phone number |
phone_code | Phone country code |
created_at | Record creation timestamp |
updated_at | Last update timestamp |
deleted_at | Soft deletion timestamp |
full_phone | Full formatted phone number |
international_phone | International number format |
country_code | Country code |
phone_country_code | Code of the phone's country |
can_delete | Permission to delete |
import_id | Import reference |
staged_import | Staged import flag |
external_id | External system ID |
client | Client object |
Contract Twig variables
Variable | Description |
total_recurrent_amount_formatted | Total recurring amount, formatted for display |
total_amount_formatted | Total amount of the contract, formatted |
currency | Currency used in the contract |
id | Unique identifier for the contract |
name | Contract name |
start_date | Contract start date |
end_date | Contract end date |
next_due_date | Next payment due date |
next_invoice_date | Date of the next invoice |
cancellation_date | Date when the contract was cancelled |
activation_date | Date contract was activated |
status_id | Internal status identifier |
total_recurrent_amount | Total recurring amount |
total_amount | Total contract amount |
account_id | Associated account ID |
user_id | User who owns the contract |
brand_id | Brand associated with the contract |
company_id | Company linked to the contract |
address_id | Address linked to the contract |
billing_cycle_months | Billing cycle duration in months |
currency_id | Currency identifier |
main_invoice_id | Main invoice ID |
payment_days_term | Payment terms in days |
create_invoice_term | Invoice creation terms |
gateway_id | Payment gateway used |
payment_details_id | Payment details reference |
main_service_id | Main service ID |
promotion_id | Promotion applied |
promotion_code | Promotion code |
created_at | Contract creation timestamp |
updated_at | Last update timestamp |
reseller_account_id | Associated reseller account ID |
client_id | Client ID |
recurring | Is this contract recurring? |
start_recurring | Start date for recurring billing |
end_recurring | End date for recurring billing |
status | Contract status |
cancellation_reason | Reason for contract cancellation |
pricelist_id | Associated price list ID |
fraud_status | Fraud check status |
currency_exchange_rate | Exchange rate used for currency |
external_id | External system ID |
locked | Is contract locked? |
billing_cycle_days | Billing cycle duration in days |
reconciliation_strict | Strict reconciliation flag |
main_invoice_number | Invoice number of main invoice |
import_id | Import reference |
staged_import | Flag for staged import |
finished_staged_import | Flag to mark staged import finished |
notes | Admin notes |
tax_type | Applied tax type |
moved_from_contract_id | Reference to previous contract when moved |
moved_to_contract_id | Reference to next contract when moved |
moved | Is contract moved? |
partially_moved | Partial move flag |
products | List of products associated |
client | Client object |
phone_id | Associated phone ID |
tracked_referral | Referral tracking info |
Contract product bulk scheduled action Twig variables
Variable | Description |
id | Unique identifier of the bulk action |
user_id | User who initiated the action |
params | Parameters for the action |
result_count | Count of results processed |
ready | Is action ready to execute |
stuck | Is action stuck |
created_at | Creation timestamp |
updated_at | Last update timestamp |
products_processed | Number of products processed |
jobs_dispatched | Number of jobs dispatched |
org_id | Organisation ID |
brand_id | Brand ID |
action | Type of action |
Contract product scheduled action Twig variables
Variable | Description |
id | Scheduled action ID |
contract_id | Linked contract ID |
contract_product_id | Linked contract product ID |
brand_id | Brand identifier |
user_id | User who scheduled the action |
original_values | Original data values before action |
values | Updated values |
org_id | Organisation ID |
action | Action type |
status_id | Status identifier |
executed_at | Action execution timestamp |
deleted_at | Soft deletion timestamp |
created_at | Creation timestamp |
updated_at | Last update timestamp |
Contract request Twig variables
Variable | Description |
id | Request ID |
contract_id | Associated contract ID |
reason | Reason for the contract request |
product_old_ids | Old product IDs associated |
status_id | Request status ID |
created_at | Creation timestamp |
updated_at | Last update timestamp |
deleted_at | Soft deletion timestamp |
product_ids | Product IDs for the request |
ticket_id | Support ticket linked |
status | Request status |
contract_product_id | Linked contract product ID |
Contract product Twig variables
Variable | Description |
id | Unique identifier of contract product |
account_id | Linked account ID |
contract_id | Contract associated |
product_id | Product identifier |
description | Product description |
cost | Cost price |
cost_currency_id | Currency ID for cost |
base_price | Base price |
base_price_currency_id | Currency ID for base price |
selling_price | Selling price |
cost_exchange_rate | Exchange rate for cost |
base_price_exchange_rate | Exchange rate for base price |
quantity | Quantity |
vat_country_id | VAT country reference |
vat_percentage | VAT percentage |
billing_cycle_months | Billing cycle duration in months |
product_set_id | Product set grouping |
product_group_id | Product group identification |
created_at | Record creation timestamp |
updated_at | Last update timestamp |
deleted_at | Soft deletion timestamp |
status_id | Status identifier |
start_date | Contract product start date |
end_date | Contract product end date |
renew_date | Renewal date |
amount | Amount |
invoice_id | Linked invoice ID |
invoice_product_id | Invoice product ID |
next_invoice_date | Next invoicing date |
next_due_date | Next payment due date |
discount_amount | Applied discount amount |
last_invoice_id | Last invoice linked |
provision_provider_id | Provision provider reference |
provision_server_id | Provision server ID |
provision_center_id | Provision center ID |
main_contracts_product_id | Main contract product ID |
provision_lock | Provision lock flag |
product_name | Name of the product |
cost_currency_code | Currency code of cost |
base_currency_code | Base currency code |
provision_fields | Configuration fields for provisioning |
amount_formatted | Formatted amount |
cost_formatted | Formatted cost |
base_price_formatted | Formatted base price |
selling_price_formatted | Formatted selling price |
discount_amount_formatted | Formatted discount amount |
cost_exchange_rate_formatted | Formatted exchange rate for cost |
base_price_exchange_rate_formatted | Formatted exchange for base price |
status | Status |
product | Product object |
calculated_suspend_date | Date calculated for suspension |
calculated_cancel_date | Date calculated for cancellation |
calculated_close_date | Date calculated for closure |
suspend_interval | Interval for suspension |
cancel_interval | Interval for cancellation |
close_interval | Interval for closure |
is_due | Is product due for payment |
not_suspend_until | Restriction date for suspension |
not_cancel_until | Restriction date for cancellation |
not_close_until | Restriction date for closure |
selling_price_converted | Converted selling price |
unit_quantity | Unit quantity |
configuration_selling_price_formatted | Formatted configured price |
configuration_total_amount_formatted | Formatted configured total |
configuration_selling_price_discount_formatted | Formatted discounted price |
configuration_total_discount_amount_formatted | Formatted total discounts |
configuration_net_selling_price_formatted | Formatted net selling price |
configuration_net_amount_formatted | Formatted net amount |
configuration_net_amount_discount_formatted | Formatted net discount |
configuration_net_selling_price_discount_formatted | Formatted net selling price discount |
main_invoice_product_id | Main invoice product ID |
net_selling_price | Net selling price |
net_product_discount_amount | Net product discount amount |
net_global_discount_amount | Net global discount amount |
net_amount | Net amount |
vat_amount | VAT amount |
total_amount | Total amount |
total_discount_amount | Total discount amount |
net_selling_price_formatted | Formatted net selling price |
net_unit_selling_price_formatted | Formatted net unit selling price |
net_product_discount_amount_formatted | Formatted product discount |
net_global_discount_amount_formatted | Formatted global discount |
total_discount_amount_formatted | Formatted total discount |
net_amount_formatted | Formatted net amount |
vat_amount_formatted | Formatted VAT amount |
total_amount_formatted | Formatted total amount |
configuration_selling_price_discounted_formatted | Formatted discounted selling price |
configuration_total_discounted_amount_formatted | Formatted discounted total amount |
configuration_net_amount_discounted_formatted | Formatted net discounted amount |
configuration_net_selling_price_discounted_formatted | Formatted net discounted price |
attributes | Attributes of the product |
options | Product options |
set_products | Set of products |
provision_configuration_id | Provision configuration ID |
is_provisioned | Flag if provisioned |
activation_date | Activation date |
configuration_total_recurring_amount_formatted | Formatted recurring total |
configuration_total_recurring_discounted_amount_formatted | Formatted recurring discounts |
external_id | External system identifier |
service_identifier | Service identifier |
billing_cycle_days | Billing cycle duration in days |
suspended_date | Suspension date |
cancelled_date | Cancellation date |
closed_date | Closing date |
pro_rata_pending | Pending proration |
renew | Renewal flag |
notes | Notes |
contract | Linked contract |
provision_field_values | Provision configuration values |
configuration_total_recurring_net_amount_formatted | Net recurring total |
configuration_total_recurring_net_discounted_amount_formatted | Net recurring discounts |
next_invoice_date_archive | Archived next invoice date |
original_product_id | Original product ID |
can_create_next_invoice | Permission to create next invoice |
total_amount_without_discount_formatted | Total amount excluding discount |
total_amount_without_discount_converted | Converted total excluding discount |
total_unit_selling_price_formatted | Total unit selling price |
total_unit_selling_price_converted | Converted unit selling price |
configuration_total_recurring_amount_converted | Converted recurring total |
is_converted_price | Flag indicating converted pricing |
is_delegated_object | Flag if object is delegated |
price_type | Pricing type |
import_id | Import reference |
staged_import | Staged import flag |
main_invoice_id | Main invoice reference |
main_invoice_number | Main invoice number |
manual_status | Manual status |
manual_status_reason | Reason for manual status |
paid_future_invoices | Flag if future invoices are paid |
can_modify | Permission to modify |
can_cancel | Permission to cancel |
sub_products | Nested sub-products |
recommended_money_back_period | Money-back guarantee period |
auto_create_renew_invoice | Flag to auto-create renew invoices |
payment_days_term | Payment terms in days |
create_invoice_term | Invoice creation terms |
expire_notice_date | Expiry notice date |
net_amount_without_discount_formatted | Net amount excluding discount |
active_for_months | Active duration in months |
due_in_days | Days remaining for payment |
tax_amount | Tax amount |
tax_amount_formatted | Formatted tax amount |
client_label | Label set by client |
provision_setup_fields_confirmed | Confirmation of provision fields |
accounting_revenue_recognition | Accounting revenue recognition |
moved_from_contract_product_id | Previous contract product linkage |
moved_to_contract_product_id | Next contract product linkage |
moved | Flag if product moved |
trial_end_action_time | Trial end action schedule |
in_trial | Is product in trial period |
trial_duration | Duration of trial |
trial_end_action | Action to execute at trial end |
trial_pre_expire_notification | Notification before trial expiry |
trial_pre_expire_notification_date | Date for pre-expire notification |
trial_end_date | Trial end date |
provision_provider | Service provisioning provider |
provision_configuration | Provisioning configuration |
invoice_consolidation_enabled | Invoice consolidation flag |
invoice_consolidation_enabled_calculated | Calculated invoice consolidation |
tax_entity_details | Tax entity details |
tax_entity_hash | Tax entity hash |
exclude_from_uuid_encoding | Exclude from UUID encoding |
last_provision_setup_request | Timestamp of last provision setup |
last_reconciled_at | Last reconciliation timestamp |
retention_status_id | Retention policy status ID |
retention_reason_id | Reason for retention status |
retention_status_updated_at | Time of retention status update |
retention_updated_at | Retention data last updated |
currency_code | Currency code |
future_renewal_price | Price for future renewal |
configuration_future_renewal_price | Formatted future renewal price |
name | Contract product name |
calculated_next_invoice_due_date | Next invoice due date |
org_id | Organisation ID |
brand_id | Brand ID |
client_id | Client ID |
configuration_selling_price | Selling price configured |
configuration_total_recurring_net_amount | Net recurring total |
promotions | Applied promotions |
scheduled_actions | Scheduled contract actions |
promotion_codes | Promotion codes |
is_parent | Indicates if contract product is parent |
Cost Twig variables
Variable | Description |
amount_formatted | The formatted amount, usually currency formatted for display |
currency_code | The currency code related to the amount (e.g., USD, EUR) |
Credit debit transaction Twig variables
Variable | Description |
currency_code | Currency code of the transaction |
id | Unique identifier of the transaction |
credit | Credit amount in the transaction |
debit | Debit amount in the transaction |
invoice_id | Linked invoice identifier |
client_id | Client identifier |
account_id | Account related to transaction |
user_id | User who performed the transaction |
transaction_id | Transaction unique ID |
reason | Reason or description for the transaction |
created_at | Date and time of creation |
updated_at | Last update date and time |
payment_log_id | Linked payment log identifier |
captured | Amount captured flag |
deleted_at | Soft deletion timestamp |
currency_id | Currency identifier |
transaction_type | Type of transaction (e.g., payment, refund) |
parent_id | Parent transaction ID |
refunded | Refund status |
amount_refunded | Amount refunded |
gateway_id | Payment gateway identifier |
amount_captured | Amount captured |
type | Transaction type |
currency_exchange_rate | Exchange rate at the time of transaction |
shared_resource_token | Token for shared resource access |
import_id | External import ID |
staged_import | Staged import flag |
external_id | External system identifier |
document_currency_id | Currency ID for document currency |
document_currency_exchange_rate | Exchange rate for document currency |
document_amount_converted | Converted document amount |
document_amount_converted_formatted | Formatted converted document amount |
document_currency | Currency code for the document |
Custom field value Twig variables
Variable | Description |
id | Unique custom field value identifier |
field_id | Identifier of the custom field |
value | Value assigned to the custom field |
created_at | Timestamp when the value was created |
updated_at | Timestamp when the value was updated |
import_id | Import reference |
staged_import | Staged import flag |
external_id | External system ID |
object_type | Type of object this field relates to |
image_url | URL to an image related to the field (if applicable) |
Delegate Twig variables
Variable | Description |
id | Unique delegate identifier |
org_id | Organisation ID this delegate is related to |
brand_id | Brand ID associated with the delegate |
owner_client_id | Client ID of the owner of the delegation |
client_id | Client ID who is delegated to |
lead_id | Lead ID linked to the delegation |
is_full_delegate | Boolean flag, indicates if delegation includes full access |
active | Boolean flag, whether delegation is active |
hash | Unique hash for delegation identification |
invite_email | Email address used for inviting delegate |
num_delegated_cps | Number of delegated contract products |
num_delegated_tickets | Number of delegated support tickets |
lead | Lead object linked to the delegation |
client | Client object linked to the delegation |
owner_client | Owner client object |
created_at | Creation timestamp |
updated_at | Last update timestamp |
Delegated access Twig variables
Variable | Description |
id | Unique delegated access identifier |
account_id | Account ID associated |
client_id | Client associated |
object_id | Object ID the delegation applies to |
object_type | Type of the object |
creator_object_id | Creator ID of the delegated access |
creator_object_type | Creator object type |
created_at | Created timestamp |
updated_at | Updated timestamp |
deleted_at | Soft deletion timestamp |
brand_id | Brand ID |
active | Active status flag |
hash | Unique hash identifier |
org_id | Organisation ID |
invite_email | Email address used for the invitation |
import_id | Import reference |
staged_import | Staged import flag |
external_id | External system ID |
owner_client_id | Owner client ID |
client | Client object |
invite_lead_id | Lead ID for invitation |
delegate_id | Delegate ID |
Email Twig variables
Variable | Description |
id | Unique email identifier |
recipient_type_id | Type identifier of recipient |
recipient_id | Recipient ID |
client_id | Client ID |
user_id | User ID |
account_id | Account ID |
brand_id | Brand ID |
reseller_account_id | Reseller account ID |
sent | Whether the email was sent |
message_id | Message ID |
bounced | Bounced status |
error_id | Error identifier if sending failed |
error_message | Error message |
resend_email_id | Reference to resent email |
template_id | Template ID used |
template_content_id | Content ID of the template message |
smart_template_id | Smart template ID |
language_id | Language ID |
subject | Email subject |
smart_email_id | Smart email ID |
created_at | Creation timestamp |
updated_at | Last update timestamp |
sent_at | Actual sent timestamp |
bounced_at | Bounce timestamp |
bounce_data | Bounce details |
from | Sender email address |
reply_to | Reply-to email address |
to | Recipient email addresses |
cc | CC email addresses |
bcc | BCC email addresses |
hook_log_id | Related hook log ID |
resent | Resent flag |
lead_id | Linked lead ID |
hourly_rate_exceeded | Flag for hourly rate limits exceeded |
Gateway Twig variables
Variable | Description |
currencies | List of currencies supported by the gateway |
id | Gateway identifier |
name | Gateway name |
provider | Gateway provider name |
created_at | Gateway creation timestamp |
updated_at | Gateway last update timestamp |
deleted_at | Gateway deletion timestamp (soft delete) |
type | Gateway type (e.g., card, bank transfer) |
gateway_provider_id | External provider ID for the gateway |
org_id | Organisation ID associated with the gateway |
payment_instructions | Human-readable payment instructions for this gateway |
hash | Internal hash for gateway reference |
gateway_settings | Serialized or structured gateway configuration details |
payment_instructions_translated | Localized payment instructions (translated) |
is_stored | Flag indicating if gateway data is stored for reuse |
card_types | Supported card types (e.g., Visa, MasterCard) |
translations | Available translations for gateway content |
short_description | Brief description of gateway capabilities |
name_translated | Gateway name translated per locale |
short_description_translated | Translated short description |
provider_logo | Logo asset for the provider |
gateway_provider | Gateway provider object or identifier |
oauth_application_access_token_id | OAuth token ID used for API access |
require_stored | Whether stored credentials are required |
auth_type | Authentication type (e.g., OAuth, API key) |
webhook_url | Webhook URL for gateway events |
import_id | Import reference for gateway data |
staged_import | Staged import flag for gateway data |
external_id | External system ID |
allow_manual_store | Allow manual storage of gateway data |
use_frontend_implementation | Indicator for frontend-based gateway integration |
store_on_payment | Store gateway details upon payment |
store_on_payment_force | Force-stored gateway details on payment |
store_outside_payment | Store gateway details outside the payment flow |
internal_name | Internal naming convention for the gateway |
Invoice Twig variables
Variable | Description |
net_selling_price_formatted | Formatted net selling price |
net_product_discount_amount_formatted | Formatted net product discount amount |
net_global_discount_amount_formatted | Formatted global discount amount |
total_discount_amount_formatted | Formatted total discount amount |
net_amount_formatted | Formatted net amount (after discounts) |
vat_amount_formatted | Formatted VAT amount |
total_amount_formatted | Formatted total invoice amount |
paid_amount_formatted | Formatted amount paid so far (if partial) |
current_data | Snapshot of current invoice data (context) |
currency | Currency code (e.g., USD) |
id | Invoice ID |
number | Human-readable invoice number |
brand_id | Brand context for the invoice |
account_id | Linked account ID |
client_id | Client ID associated with the invoice |
gateway_id | Payment gateway used for the invoice |
payment_details_id | Payment details reference |
status_id | Invoice status identifier |
created_at | Invoice creation timestamp |
updated_at | Last invoice update timestamp |
deleted_at | Invoice deletion timestamp |
create_datetime | Invoice creation date/time (alias) |
due_date | Payment due date |
paid_datetime | Date/time when payment completed |
total_amount | Total invoice amount (unformatted) |
currency_id | Currency identifier |
pricelist_id | Pricing list reference |
total_discount_amount | Total discount applied |
net_global_discount_amount | Net global discount amount (undiscounted) |
net_product_discount_amount | Net product discount amount (undiscounted) |
net_selling_price | Net selling price (before formatting) |
net_amount | Net amount (before formatting) |
VAT fields: | VAT-related fields included above as formatted amounts |
contract_id | Contract associated with this invoice |
user_id | User performing invoice actions |
reseller_account_id | Reseller context ID if applicable |
address_id | Address tied to invoice |
category_id | Invoice category ID |
company_id | Company ID for the invoice context |
refund_request | Refund request flag |
refund_changed | Refund status changed flag |
refund_status | Current refund status |
consolidation_status | Invoice consolidation status |
consolidation_invoice_id | Linked consolidated invoice ID |
credit_invoice_id | Credit invoice ID if issued |
credited | Credited flag |
legacy | Legacy invoice flag |
notes | Administrative notes |
data | Arbitrary data payload |
status | Invoice status (alias for status_id) |
next_charge_date | Next charge date if recurring |
payment_failed_attempts | Count of failed payment attempts |
locked | Invoice locked flag |
guest_token_id | Guest session token, if applicable |
pre_due_notification_date | Notification date before due date (reminder) |
overdue_notification_date | Notification date for overdue status |
overdue_left_attempts | Remaining attempts before enforcement |
balance | Current balance due on the invoice |
balance_formatted | Formatted balance due |
fraud_status | Fraud check status |
fraud_score | Fraud risk score |
ip | IP address associated with invoice event |
abandoned | Abandoned invoice flag |
abandon_date | Date when invoice was abandoned |
temp_token_id | Temporary token for invoice actions |
currency_exchange_rate | Exchange rate used for currency conversion |
total_amount_converted | Converted total amount |
paid_amount_converted | Converted paid amount |
net_discount_amount_formatted | Formatted net discount amount |
net_discount_amount | Net discount amount (raw) |
cancellation_datetime | Cancellation timestamp (if canceled) |
warning_notes | Administrative warnings |
category | Invoice category or taxonomy |
credit_invoice | Linked credit invoice, if any |
net_amount_converted | Converted net amount |
external_id | External system ID |
external_contract_id | External contract ID, if linked |
partial_amount_credited | Partial amount credited |
unspent discounts / unspent credits | See related fields (if applicable) |
partial_amount_to_credit_formatted | Formatted partial credit amount |
partial_amount_to_credit_converted | Converted partial credit amount |
partial_amount_credited_formatted | Formatted credited amount |
partial_amount_credited_converted | Converted credited amount |
duplicate_from | Original invoice reference if duplicate |
duplicated_with | Duplicated invoice reference ID |
auto_cancel_date | Automatic cancellation date, if applicable |
auto_cancel_pro_rata_date | Pro-rata date for auto-cancel under terms |
duplicate_from_invoice_id | ID of source invoice in duplicates |
duplicatied_with_invoice_id | (Alias) duplicate reference |
allow_product_credit | Allow product-level credit flag |
delegate_related | Related delegate information |
to_be_credited | Amount to be credited |
import_id | Import reference |
staged_import | Staged import flag |
client | Client object |
today_exchange_rate | Exchange rate for today |
pending_payments | Pending payments count/details |
vat_amount_converted | Converted VAT amount |
tax_amount | Tax amount |
tax_amount_formatted | Formatted tax amount |
tax_amount_converted | Converted tax amount |
display_status | Human-friendly status label |
taxes | Taxes applied to invoice |
products | Products included in the invoice |
meta | Metadata for the invoice |
is_consolidation | Consolidation flag |
phone_id | Linked phone ID |
payment_currency_id | Currency ID used for payment |
payment_currency_exchange_rate | Exchange rate for payment currency |
object_meta | Object-level metadata |
object_meta_data | Additional object metadata |
gateway | Gateway object or identifier used for payment |
tracked_referral | Referral tracking information |
proforma | Proforma status flag |
proforma_number | Proforma invoice number |
proforma_create_datetime | Proforma creation timestamp |
cancellation_reason | Reason for cancellation, if canceled |
shared | Shared status flag |
payments | Related payment records |
contract | Linked contract object |
grouped_taxes | Taxes grouped for display |
Invoice payment Twig variables
Variable | Description |
id | Payment ID |
invoice_id | Linked invoice ID |
payment_details_id | Payment details reference |
voucher_id | Voucher or receipt ID |
payment_type_id | Payment type ID |
currency_id | Currency identifier |
amount | Payment amount |
transaction_id | Transaction reference with gateway |
created_at | Payment creation timestamp |
updated_at | Last update timestamp |
deleted_at | Deletion timestamp (soft) |
captured | Capture status flag |
amount_captured | Amount captured |
first_date_time_captured | First capture timestamp |
payment_log_id | Related payment log entry |
refunded | Has refund occurred? |
amount_refunded | Amount refunded |
parent_id | Parent payment for split/partial payments |
amount_formatted | Formatted payment amount |
currency | Currency code (e.g., USD) |
payment_type | Payment method type |
invoice | Linked invoice object |
currency_exchange_rate | Exchange rate used for currency conversion |
shared_resource_token | Token for shared resources |
amount_refunded_formatted | Formatted refunded amount |
amount_for_refund_formatted | Formatted refundable amount |
amount_converted | Converted amount |
amount_refunded_converted | Converted refunded amount |
amount_for_refund_converted | Converted refundable amount |
pending | Pending status flag |
import_id | Import reference |
staged_import | Staged import flag |
external_id | External system ID |
gateway | Gateway object or identifier used for the payment |
payment_details | Payment details object |
client | Client object |
document_currency_id | Currency ID for document currency (for reporting) |
document_currency_exchange_rate | Exchange rate for document currency |
document_amount_converted | Converted document amount |
document_amount_converted_formatted | Formatted converted document amount |
document_currency | Document currency code |
payment_method_type | Payment method type (e.g., card) |
payment_method_type_deprecated | Deprecated field for payment method type |
payment_method_type_log | Payment method type history/log |
Lead Twig variables
Variable | Description |
id | Lead ID |
name | Lead name |
firstname | Lead first name |
lastname | Lead last name |
Lead email address | |
is_main | Is this the main contact for the lead? |
is_hidden | Is lead hidden from certain views? |
phone | Lead phone number |
phone_code | Lead phone code |
phone_country_code | Lead phone country code |
international_phone | International formatted phone |
client_id | Linked client ID, if converted |
comment | Lead notes or comments |
assigned_client_at | Timestamp when assigned to a client |
created_at | Lead creation timestamp |
updated_at | Lead last update timestamp |
user_id | User linked to the lead |
brand_id | Brand context |
org_id | Organisation context |
full_name | Full name of the lead |
Domain Twig variables
Variable | Description |
id | Domain identifier |
user_id | User responsible for domain context |
name | Domain name or label |
origin | Source origin or base domain reference |
org_id | Organisation ID owning the domain |
brand_id | Brand ID associated with the domain (for branding context) |
verified | Whether the domain verification has completed |
default | Is this the primary domain for the entity |
custom | Custom flags or settings for the domain |
revoked | Whether the domain has been revoked |
created_at | Domain creation timestamp |
updated_at | Last update timestamp |
origin_healthy | Health flag for the origin/delivery path |
customer_enabled | Whether customers can access or use this domain |
provider | Underlying provider (e.g., DNS providers) |
staff_enabled | Whether staff can manage/use domain specifics |
dns_healthy | DNS health status |
ssl_healthy | SSL health status |
health_checked_at | Last time health was checked |
dns_checked_at | Last DNS health check timestamp |
ssl_checked_at | Last SSL health check timestamp |
no_health_checks_until | Time until next health check is required |
Organisation Twig variables
Variable | Description |
id | Organisation identifier |
name | Organisation name |
code | Organisation code/short name |
verified | Organisation verification status |
completed | Completion status of initial setup/verification |
status | Current status (e.g., active) |
portal_domain | Default portal domain for organisation |
reg_hash | Registration hash (for onboarding flows) |
staff_portal_domain | Domain for staff/admin portal |
reg_hash_expiry | Expiry timestamp for onboarding reg hash |
Payment reconciliation log Twig variables
Variable | Description |
id | Reconciliation log ID |
callback | Callback data or flag |
transaction_reference | External reference to the transaction |
description | Description of the reconciliation event |
reason | Reason for reconciliation action |
provider | Payment provider or gateway name |
event | Event type triggering reconciliation |
org_id | Organisation ID involved |
gateway_id | Gateway used for the transaction |
created_at | Creation timestamp |
updated_at | Last update timestamp |
brand_id | Brand context |
account_id | Account context |
Payment log Twig variables
Variable | Description |
id | Payment log ID |
brand_id | Brand context |
account_id | Account context |
user_id | User who initiated payment |
client_id | Client receiving payment |
payment_details_type | Type of payment details object |
status | Payment status (e.g., captured, pending) |
transaction_id | Gateway transaction reference |
invoice_id | Linked invoice |
currency_id | Currency identifier |
amount | Payment amount (raw) |
clients_payment_detail_id | Client's payment detail reference |
gateway_id | Gateway used for payment |
transaction_type | Type of transaction (e.g., sale, refund) |
created_at | Creation timestamp |
updated_at | Last update timestamp |
currency_exchange_rate | Exchange rate used for currency conversion |
shared_resource_token | Token for shared resources |
result | Result flag or status from processing |
address_id | Address related to payment |
result_log_id | Related result log entry |
wallet_id | Wallet context identifier |
document_currency_id | Currency for document/reports |
document_currency_exchange_rate | Exchange rate for document currency |
document_amount_converted | Converted document amount |
document_amount_converted_formatted | Formatted converted document amount |
document_currency | Document currency code |
payment_method_type | Type of payment method used |
Pricelist Twig variables
Variable | Description |
id | Pricelist ID |
name | Pricelist name |
user_id | Owner user ID |
reseller_account_id | Associated reseller account if applicable |
created_at | Creation timestamp |
updated_at | Last update timestamp |
deleted_at | Soft deletion timestamp |
org_id | Organisation ID owning the pricelist |
inheritance | Inheritance flag or parent pricelist reference |
Product Twig variables
Variable | Description |
name_translated | Translated product name |
description_translated | Translated product description |
tld | Top-level domain or related TLD context |
domain_operation_code | Domain operation code (e.g., create, renew) |
provision_fields | Provisioning fields and definitions |
category | Product category |
translations | Available translations for product fields |
id | Product ID |
name | Product name |
code | Unique product code |
billing_cycle_months | Billing cycle duration in months |
available_for_sales | Availability flag for sales |
created_at | Creation timestamp |
updated_at | Last update timestamp |
brand_id | Brand association |
user_id | Owner user ID |
reseller_account_id | Reseller account ID (if applicable) |
deleted_at | Soft deletion timestamp |
product_type | Type of product (e.g., service, license) |
order_type | Ordering type |
unit_quantity | Base unit quantity per order |
set_order_type | Order type for sets |
min_order_quantity | Minimum quantity allowed |
max_order_quantity | Maximum quantity allowed |
set_price_type | Pricing type for sets |
contract_type | Contract type associated |
currency_id | Currency ID for pricing |
max_order_billing_cycle | Max billing cycle for orders |
max_set_use_period | Maximum use period for set products |
voucher_value | Value of any voucher applied |
voucher_currency_id | Currency for voucher value |
voucher_type | Voucher type |
voucher_use_months | Duration voucher is valid (months) |
set_end_date | End date for set products |
auto_renew | Auto-renew flag |
manual_assistance | Manual assistance flag |
manual_price | Manual price override flag |
provision_category_id | Provisioning category reference |
provision_provider_type | Provisioning provider type |
main_product | Indicates if this is the main product in a bundle |
in_group | Grouping indicator for products |
original_product_id | Original product reference for clones/variants |
org_id | Organisation owning the product |
affiliate_product_id | Affiliate product mapping |
tld_id | TLD reference ID |
operation_type | Operational type for provisioning |
products_category_id | Product category reference |
products_options_category_id | Product options category reference |
products_attributes_category_id | Product attributes category reference |
description | Product description |
order | Order metadata or sequence |
category_id | Category ID for organizational grouping |
start_date | Product validity start date |
end_date | Product validity end date |
short_description | Short product description |
short_description_translated | Translated short description |
additional_currency_recalculation | Flag for currency recalculation behavior |
display_price | Display price value |
display_price_billing_cycle_months | Price display relative to billing cycles |
unit_id | Unit identifier |
provision_provider_id | Provisioning provider ID |
provision_blueprint_id | Provisioning blueprint ID |
provision_configuration_mode | Provisioning mode |
provision_configuration_id | Provisioning configuration ID |
clients_can_order | Client order permission |
provision_configuration_attribute_query | Provisioning attribute query |
provision_blueprint_setup_function_id | Provisioning setup function ID |
tax_template_id | Tax template reference |
external_id | External system ID |
default_payment_period | Default payment period for invoicing |
import_id | Import reference |
staged_import | Staged import flag |
allow_affiliate | Affiliate permission |
suspend_interval | Suspension interval |
cancel_interval | Cancel interval |
close_interval | Close interval |
due_date_free_change | Free change of due date flag |
due_date_restriction | Due date restriction policy |
reactivate_status_restriction | Reactivation restriction policy |
cancel_anytime | Cancel anytime flag |
recommended_money_back_period | Money-back recommendation period |
payment_days_term | Payment term in days |
create_invoice_term | Invoice creation term |
module_code | Module code for integrations |
module_sub_id | Module sub-identifier |
auto_create_renew_invoice | Auto-create renew invoice flag |
post_paid | Post-paid flag |
hide_catalog | Hide catalog flag |
ui_settings | User interface settings for product |
old_provision_blueprint_id | Historical blueprint reference |
provision_setup_field_defer_mode | Provisioning field defer mode |
accounting_revenue_recognition | Revenue recognition settings |
meta | Metadata for the product |
trial_supported | Trial support flag |
trial_duration | Duration of trial (in days) |
trial_end_action | Action at trial end |
trial_pre_expire_notification | Pre-expire notification flag/date |
trial_force | Force trial flag |
is_trial_only | Is trial-only product |
can_disable_auto_create_renew_invoice | Auto-renew disable flag |
invoice_consolidation_enabled | Invoice consolidation flag |
finished_staged_import | Finished staged import flag |
auto_accept_cancel_request | Auto-accept cancel requests flag |
report_code_1 | Custom report code 1 |
report_code_2 | Custom report code 2 |
brand_ticket_department_id | Brand ticket department reference |
hidden | Visibility flag for product |
provision_meta | Provisioning metadata |
provision_field_values | Provisioning field values |
exclude_from_uuid_encoding | Exclude from UUID encoding flag |
brand | Brand reference or object |
manual_recurring_days_before_due_date | Days before due date for manual recurrence |
split_quantity | Quantity split behavior |
Product group Twig variables
Variable | Description |
name_translated | Localized name of the product group |
translations | Collection of translations related to the product group |
Promotion Twig variables
Variable | Description |
name_translated | Localized name of the promotion |
description_translated | Localized description text |
amount_formatted | Promotion amount formatted for display |
translations | Set of localized strings associated with the promotion |
id | Unique identifier for the promotion |
name | Name of the promotion |
from_date | Start date validity |
to_date | End date validity |
max_uses | Maximum allowed uses |
number_of_uses | Number of times promotion has been used |
code | Promotion code |
brand_id | Associated brand identifier |
for_new_clients | Flag indicating applicability to new clients |
for_existing_clients | Flag indicating applicability to existing clients |
for_upgrade_clients | Flag indicating applicability for upgrades |
promo_recurring_count | Count of recurring promo usage |
active | Whether the promotion is currently active |
user_id | User who created or manages the promotion |
reseller_account_id | Reseller account linked to the promotion |
created_at | Creation timestamp |
updated_at | Last updated timestamp |
deleted_at | Soft deletion timestamp |
max_uses_per_client | Max usage allowed per individual client |
autoapply | Whether the promotion auto-applies |
used_at | Timestamp when promotion was last used |
global | Global flag for promotion scope |
amount | Numeric promotion amount |
currency_id | Currency identifier for the amount |
type | Type/category of promotion |
combined | Whether combinable with other promotions |
short_description | Brief textual description |
short_description_translated | Localized brief description |
pricelist_id | Related pricelist identifier |
billing_cycle_months | Applicable billing cycle in months |
external_id | Identifier from external systems |
show_on_catalog | Visibility flag for catalog display |
constant_discount | Flag indicating a fixed discount |
hidden | Flag whether promotion is hidden |
adjusted_basket_id | Basket identifier adjusted by promotion |
min_quantity | Minimum quantity to activate promotion |
max_quantity | Maximum quantity allowed for promotion |
Provision result Twig variables
Variable | Description |
id | Unique identifier of the provisioning result |
request_id | Related provisioning request ID |
status | Current status of the provisioning (e.g., success/fail) |
message | Status or error message |
error_id | Identifier for any error occurred |
created_at | Timestamp of creation |
updated_at | Last updated timestamp |
data | Additional data or payload returned |
import_id | Import process identifier |
staged_import | Flag if the import was staged |
external_id | External system identifier |
debug | Debugging data or logs |
exclude_from_uuid_encoding | Flag indicating exclusion from UUID encoding |
request | Object or content of the original provisioning request |
Report Twig variables
Variable | Description |
id | Report identifier |
brand_id | Associated brand identifier |
user_id | User who generated the report |
report_code | Code representing the report |
filename | Filename of the report file |
params | Parameters used for report generation |
ready | Flag indicating if the report is ready for download |
created_at | Report creation timestamp |
updated_at | Last update timestamp |
download_url | URL for downloading the report |
external | Flag if report is externally sourced |
Tax tag Twig variables
Variable | Description |
id | Tax tag identifier |
name | Tax tag name |
type | Tax type/category |
amount | Numeric tax amount |
currency_id | Currency associated with the tax |
tax_type_id | Type ID for classification |
tax_code | Official tax code |
org_id | Organisation identifier |
user_id | User who created or modified the tag |
show_on_item | Flag to display on item lines in invoice |
show_on_invoice | Flag to display on invoice summaries |
created_at | Creation timestamp |
updated_at | Last update timestamp |
deleted_at | Soft deletion timestamp |
brand_id | Brand context |
base_type | Base tax type |
company_type | Company classification for tax |
company_amount | Company related tax amount |
require_company_vat_number | VAT number requirement flag |
require_company_reg_number | Registration number requirement flag |
apply_on_main_product_only | Apply tax only on main product |
apply_based_on_product_quantity | Apply based on quantity thresholds |
name_translated | Localized tax name |
system_tag | System internal tag name |
amount_formatted | Formatted tax amount |
company_amount_formatted | Formatted company tax amount |
fixed_amount_apply_on_zero | Flag for fixed tax applying on zero sales |
Tax template Twig variables
Variable | Description |
id | Tax template identifier |
name | Name of the tax template |
brand_id | Associated brand |
org_id | Organisation owning the template |
user_id | User who created or modified the template |
created_at | Creation timestamp |
updated_at | Last update timestamp |
deleted_at | Soft deletion flag |
default | Flag marking default template |
name_translated | Localized template name |
system_template | Flag indicating a system-defined template |
Template Twig variables
Variable | Description |
subject | The subject line of the email template |
body | The main body content (HTML/text) of the template |
id | Unique identifier for the template |
name | Name of the template |
category_id | Category grouping identifier |
channel_id | Communication channel identifier |
recipient_type_id | Type identifier for intended recipients |
brand_id | Brand the template is associated with |
reseller_account_id | Reseller account associated with template |
reseller_can_copy | Flag allowing reseller to duplicate the template |
default | Flag indicating if template is default |
enabled | Template enabled status |
code | Unique code identifier |
user_id | User who created or owns the template |
created_at | Creation timestamp |
updated_at | Last updated timestamp |
deleted_at | Timestamp of soft deletion |
type | Template type (e.g., email, notification) |
send_attachment | Flag indicating if attachments are sent |
original_template_id | Reference ID for cloned/original template |
template_layout_id | Layout structure ID |
bcc | Blind carbon copy addresses |
cc | Carbon copy addresses |
topic_id | Topic or conversation grouping identifier |
Template content Twig variables
Variable | Description |
id | Content record identifier |
template_id | Parent template ID |
language_id | Language identifier for localization |
enabled | Content enabled flag |
default | Flag indicating default content for language |
subject | Content subject line |
body | Content body text or HTML |
created_at | Creation timestamp |
updated_at | Last updated timestamp |
deleted_at | Soft deletion timestamp |
smart_template_id | Linked smart template ID |
Ticket Twig variables
Variable | Description |
status | Current status of the ticket |
id | Ticket unique identifier |
reference | Human-readable reference code |
subject | Ticket subject line |
client_id | Associated client’s identifier |
reseller_account_id | Reseller account linked |
account_id | Account ID related to ticket |
brand_id | Brand context identifier |
org_id | Organisation ID |
user_id | User responsible for the ticket |
status_id | Numerical status identifier |
created_at | Ticket creation datetime |
updated_at | Last update timestamp |
lead_id | Lead ID associated |
invoice_id | Invoice related to ticket |
calculated_notify_close_date | Calculated notification date for closure |
calculated_close_date | Calculated closure date |
ticket_department_id | Department handling the ticket |
priority_id | Priority level identifier |
object_type | Type of object ticket is related to |
object_id | ID of the related object |
template_id | Template applied to ticket |
contract_product_id | Linked contract product |
is_delegated_object | Flag for delegation status |
client | Client object |
lead | Lead object |
source_type | Origin type of ticket |
source_ip | IP address from which ticket was created |
email_file | Linked email file attachments |
import_id | Import reference |
staged_import | Staged import flag |
external_id | External system ID |
department | Ticket department name |
first_message | First message content |
last_message | Last message content |
spam | Spam flag |
spam_reason | Reason for spam flag |
lead_user | User linked as lead |
can_see_ticket_messages | Permission flag for ticket messages visibility |
Ticket message Twig variables
Variable | Description |
user_name | Name of the user who sent the ticket message |
client_name | Name of the client who sent the ticket message |
user_image_url | URL of the user’s avatar image |
client_image_url | URL of the client’s avatar image |
id | Ticket message identifier |
ticket_id | Linked ticket identifier |
client_id | Client sending the message |
user_id | User sending the message |
is_private | Flag indicating message privacy |
body | Message content |
created_at | Creation timestamp |
updated_at | Last updated timestamp |
ticket | Ticket object |
lead_id | Lead linked to message |
template_id | Template used for message |
object_type | Related object type |
object_id | Related object ID |
deleted_at | Soft delete timestamp |
reason | Reason for deletion or action |
action | Action taken |
original_ticket_message_id | Reference ID for original message |
is_log | Flag indicating if message is log entry |
source_type | Origin type of message |
source_ip | IP address source |
user_actor_id | User actor identifier |
client_actor_id | Client actor identifier |
lead_actor_id | Lead actor identifier |
actor_name | Display name of the actor |
actor_image_url | URL of the actor’s avatar |
email_file | Attached email files |
import_id | Import reference |
staged_import | Staged import flag |
external_id | External system ID |
pinned | Flag indicating if the message is pinned |
is_author | Flag indicating if sender is author |
can_manage | Permission flag for managing the message |
Ticket user Twig variables
Variable | Description |
id | Ticket user identifier |
ticket_id | Associated ticket identifier |
user_id | Linked user identifier |
default | Flag indicating default user for ticket |
actor_id | Actor role ID |
created_at | Creation timestamp |
updated_at | Last updated timestamp |
import_id | Import reference |
staged_import | Staged import flag |
external_id | External system identification |
ticket | Ticket object |
user | User object |
actor | Actor object |
User Twig variables
Variable | Description |
id | Unique user identifier |
first_name | User’s first name |
last_name | User’s last name |
Email address | |
twofa_enabled | Flag for two-factor authentication enabled |
twofa_provider | Provider of two-factor authentication |
reg_hash | Registration hash |
reg_hash_expiry | Expiry timestamp for registration hash |
phone_code | User's phone country code |
phone | Phone number |
verified | Email or user verification status |
avatar_src | URL to user’s avatar image |
interface_language | Preferred UI language |
document_language | Language for documents or notices |
created_at | Account creation timestamp |
updated_at | Last profile update timestamp |
is_admin | Flag if the user has administrative privileges |
full_name | Full concatenated name |
manage_notification_subs_token | Token managing notification subscriptions |
has_password_auth_config | Flag if password authentication is configured |
email_2fa_code | Email two-factor authentication code |
Wallet Twig variables
Variable | Description |
id | Wallet unique identifier |
import_id | Identifier for imported wallet data |
staged_import | Flag indicating staged import |
external_id | External system wallet ID |
client_id | Client associated with the wallet |
brand_id | Brand associated with wallet |
currency_id | Currency identifier for wallet amounts |
type | Type of wallet (e.g., prepaid, postpaid) |
amount | Current wallet balance amount |
currency_exchange_rate | Exchange rate for currency conversion |
created_at | Wallet creation timestamp |
updated_at | Last update timestamp |
account_id | Linked account ID |
invoice_id | Linked invoice ID |
transaction_id | Linked transaction ID |
payment_log_id | Payment log reference ID |
refunded | Flag indicating if wallet has refunds |
amount_refunded | Total amount refunded |
gateway_id | Gateway through which wallet payments are processed |
gateway_type | Type of gateway |
refund_request_id | Refund request identifier |
amount_overpaid | Amount overpaid beyond balance |
locked | Wallet locked status |
affiliate_payout | Affiliate payout related to wallet |
amount_formatted | Formatted wallet amount for display |
amount_converted | Converted wallet amount |
amount_converted_formatted | Formatted converted amount |
amount_overpaid_formatted | Formatted overpaid amount |
amount_overpaid_converted | Converted overpaid amount |
amount_overpaid_converted_formatted | Formatted converted overpaid amount |
amount_refunded_formatted | Formatted refunded amount |
amount_refunded_converted | Converted refunded amount |
amount_refunded_converted_formatted | Formatted converted refunded amount |
brand | Brand object or name |
currency | Currency object or code |
document_currency_id | Document currency identifier |
document_currency_exchange_rate | Exchange rate for document currency |
document_amount_converted | Document amount converted |
document_amount_converted_formatted | Formatted converted document amount |
document_currency | Document currency code |
topup_credit_note_id | Top-up credit note identifier |
payment_method_type | Payment method type used |
payment_method_type_deprecated | Deprecated payment method type |
statement_id | Associated statement ID |
transaction_reason | Reason for wallet transaction |
Wallet refund Twig variables
Variable | Description |
id | Wallet refund unique identifier |
wallet_id | Associated wallet identifier |
amount | Refund amount |
currency_exchange_rate | Exchange rate used for the refund |
created_at | Refund creation timestamp |
updated_at | Last refund update timestamp |
currency_id | Currency identifier for refund |
refund_request_id | Refund request linked |
brand_id | Brand relevant to refund |
account_id | Account related to the refund |
client_id | Client receiving refund |
amount_formatted | Formatted refund amount |
amount_converted | Converted refund amount |
amount_converted_formatted | Formatted converted refund amount |
currency | Currency code or object |
Wallet statement Twig variables
Variable | Description |
id | Wallet statement identifier |
client_id | Client associated with statement |
account_id | Account linked to statement |
org_id | Organisation owning the statement |
brand_id | Brand identifier |
created_at | Creation timestamp |
updated_at | Last updated timestamp |
from_date | Start date for statement period |
to_date | End date for statement period |
currency_id | Currency identifier |
currency_exchange_rate | Currency exchange rate |
arrears_credit_maximum | Maximum arrears credit allowed |
arrears_credit_used | Total arrears credit used |
arrears_credit_available | Current available arrears credit |
total_amount | Total amount on statement |
total_amount_converted_formatted | Converted total amount formatted |
arrears_credit_available_formatted | Formatted available arrears credit |
arrears_credit_available_converted_formatted | Converted and formatted arrears credit |
arrears_credit_used_formatted | Formatted arrears credit used |
arrears_credit_used_converted_formatted | Converted and formatted arrears used |
arrears_credit_maximum_formatted | Formatted maximum arrears allowed |
arrears_credit_maximum_converted_formatted | Converted formatted maximum arrears |
client_download_url | URL for client to download statement |
admin_download_url | URL for admin to download statement |
brand | Brand context |
account | Account object |
client | Client object |
documents | List of documents attached or linked |
client_download_csv_url | CSV download URL for client |
admin_download_csv_url | CSV download URL for admin |
Webhook endpoint Twig variables
Variable | Description |
id | Unique identifier for the webhook endpoint |
name | Name of the webhook endpoint |
description | Description of the webhook’s purpose |
brand_id | Brand associated |
url | URL target for webhook calls |
secret | Shared secret for securing webhooks |
enabled | Flag indicating if webhook is active |
created_at | Creation timestamp |
updated_at | Last updated timestamp |
deleted_at | Soft deletion timestamp |
version | Endpoint version number |
webhook_endpoint_authentication_id | Authentication method ID |
provider | Provider or service linked |
webhook_extra_payload_id | ID for additional payload customization |
Whitelisted IP Twig variables
Variable | Description |
id | Unique identifier for whitelisted IP |
ip_address | IP address allowed |
name | Name or label for the IP entry |
created_at | Timestamp of the whitelist entry creation |
updated_at | Last update timestamp for the whitelist entry |