Atomia Billing System developer guide

Templates

28 views 0

This section describes each template type and the placeholders that are available for them.

Overview

When editing a template in Admin Panel > Settings > Mail templates > Edit, e.g. of the type “Add user”, you can use all placeholders from the “Add user” section of this page in the content of the mail.

Example

Hello $CustomerFirstName$

If a customer has “World” set as the first name of the owner contact, the placeholder text is replaced and the example is displayed as “Hello World”.

Add reverse DNS

The following placeholders are available for Add reverse DNS:

  • $Customer.<Member Name>$
  • $Subscription.<Member Name>$

Add reverse delegation

The following placeholders are available for Add reverse delegation:

  • $Customer.<Member Name>$
  • $Subscription.<Member Name>$

Add user

The following placeholders are available for Add user:

  • $Reseller.Name$ The reseller name.
  • $CustomerFirstName$ The user’s first name.
  • $Username$ The username.
  • $Reseller.HcpUrl$ Reseller HCP Url.
  • $Year$ Current year.
  • $ParentAccount.Name$ Parent account name.
  • $ForgetPasswordUrl$ Forget password Url.

Contact update reminder

The following placeholders are available for Contact update reminder:

  • $Customer.<Member Name>$
  • $Environment.BillingUrl$ The Billing URL.

Credit invoice PDF

The following placeholders are available for Credit invoice:

  • $Reseller.<Member Name>$ The reseller data documentation is available here.
  • $data.CreditInvoiceReferenceNumber$ Credited invoice reference number.
  • $data.CreditInvoiceNumber$ Credited invoice number.
  • $data.InvoiceReferenceNumber$ Invoice reference number.
  • $data.InvoiceNumber$ Invoice number.
  • $data.DocumentDate$ Invoice date.
  • $data.CustomerNumber$ Invoice customer name.
  • $data.CustomerCompanyName$ Invoice customer company name.
  • $data.CustomerCompanyNumber$ Invoice customer legal number.
  • $data.CustomerFirstName$ Invoice customer first name.
  • $data.CustomerLastName$ Invoice customer last name.
  • $data.CustomerAddress$ Invoice customer address.
  • $data.CustomerZip$ Invoice customer zip.
  • $data.CustomerCity$ Invoice customer city.
  • $data.CustomerCountryName$ Invoice customer country name.
  • $data.TotalPages$ Total pages.
  • $data.Tax1CreditedSum$ Tax 1 credited sum.
  • $data.Tax1Name$ Tax 1 name.
  • $data.Subtotal$ Subtotal.
  • $data.Total$ Total.
  • $data.Currency$ Invoice currency.
  • $data.IsCompany$ True if the invoice is for a company, otherwise false.
  • $data.IsVatValid$ True if the VAT number is valid, otherwise false.
  • $data.ShowTax$ Show tax boolean.
  • $data.Pages[].Items[].Amount$ Amount.
  • $data.Pages[].Items[].Description$ Description.
  • $data.Pages[].Items[].Discount$ Discount.
  • $data.Pages[].Items[].ItemName$ Item name.
  • $data.Pages[].Items[].ItemNumber$ Item number.
  • $data.Pages[].Items[].Price$ Price.
  • $data.Pages[].Items[].Quantity$ Quantity.
  • $data.Pages[].Items[].Credited$ Credited.
  • $data.Pages[].Items[].Subtotal$ Subtotal.

Credit invoice email body

The following placeholders are available for Credit invoice email body:

  • $CustomerFirstName$ Customer first name.
  • $CustomerLastName$ Customer last name.
  • $CustomerNumber$ Customer number.
  • $InvoiceNumber$ Invoice number.
  • $InvoiceReferenceNumber$ Invoice reference number.
  • $InvoiceDate$ Invoice date.
  • $InvoiceDueDate$ Invoice due date.
  • $CreditedInvoiceNumber$ Credited invoice number.
  • $IsVatValid$ True if the VAT number is valid, otherwise false.
  • $Subtotal$ Subtotal.
  • $Total$ Total.
  • $Moms$ Moms.
  • $Rabat$ Discount.
  • $ShowTax$ Show tax.
  • $items[].Name$ Item name.
  • $items[].Renewal$ Renewal period.
  • $items[].RenewalWithoutUnit$ Only the renewal period, no unit string included.
  • $items[].Price$ Price.
  • $items[].Qty$ Quantity.
  • $items[].Discount$ Discount.
  • $items[].Total$ Total.
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Credit invoice email subject

The following placeholders are available for Credit invoice email subject:

  • $InvoiceNumber$ Credited invoice reference number.
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Customer welcome

The following placeholders are available for Customer welcome:

  • $Username$ Username.
  • $ProductName$ Name of the product.
  • $Link$ Reset password link.
  • $CustomerId$ Customer name.

Invoice PDF

The following placeholders are available for Invoice PDF:

  • $data.InvoiceReferenceNumber$ Invoice reference number.
  • $data.InvoiceNumber$ Invoice reference number.
  • $data.DocumentDate$ Invoice date.
  • $data.CustomerNumber$ Customer number.
  • $data.PaymentDue$ Due date.
  • $data.CustomerCompanyName$ Customer company name.
  • $data.CustomerCompanyNumber$ Customer company number.
  • $data.CustomerFirstName$ Customer first name.
  • $data.CustomerLastName$ Customer last name.
  • $data.CustomerAddress$ Customer address.
  • $data.CustomerAddress2$ Customer address 2.
  • $data.CustomerAddress2Present$ True if customer address 2 is present.
  • $data.CustomerZip$ Customer zip.
  • $data.CustomerCity$ Customer city.
  • $data.CustomerCountryName$ Customer country name.
  • $data.CustomerVATNumber$ Customer VAT number.
  • $data.TotalPages$ Total pages.
  • $data.Tax1Total$ Tax 1 total.
  • $data.Tax1Name$ Tax 1 name.
  • $data.Subtotal$ Subtotal.
  • $data.TaxTotal$ Tax total.
  • $data.TaxRate$ Tax rate.
  • $data.RabatExists$ True if discount exists.
  • $data.Total$ Total
  • $data.Currency$ Currency
  • $data.IsCompany$ True if the invoice is sent to a company.
  • $data.IsVatValid$ True if the VAT number is valid, otherwise false.
  • $data.ShowTax$ Show tax.
  • $data.Autopay$ Autopay.
  • $data.AutopayDate$ Autopay date.
  • $data.InvoicePaid$ True if invoice status is Closed or ClosedUnsent.
  • $data.OnlinePaymentUrl$ Online payment URL.
  • $data.PayByInvoice$ Pay by invoice.
  • $data.InvoicePaymentPeriod$ Invoice payment period.
  • $data.PaymentMethod$ Used payment method if invoice is paid.
  • $data.TransactionId$ Transaction id if invoice is paid.
  • $data.TransactionTimestamp$ Transaction time if invoice is paid.
  • $data.HasPeriodData$ Specifies whether invoice has $data.StartTime$ and $data.EndTime$ values.
  • $data.StartTime$ Start time of postpaid invoice.
  • $data.EndTime$ End time of postpaid invoice.
  • $data.DefaultCountry$ Default country.
  • $data.Pages[].Items[].Amount$ Amount.
  • $data.Pages[].Items[].Description$ Description.
  • $data.Pages[].Items[].Discount$ Discount.
  • $data.Pages[].Items[].ItemName$ Item name.
  • $data.Pages[].Items[].OriginalItemName$ Original item name.
  • $data.Pages[].Items[].ItemNumber$ Item number.
  • $data.Pages[].Items[].DomainName$ Domain name.
  • $data.Pages[].Items[].HasDomainName$ True if the item has domain name, otherwise false.
  • $data.Pages[].Items[].Recurring$ True if recurring, otherwise false.
  • $data.Pages[].Items[].RenewalPeriod$ Renewal period.
  • $data.Pages[].Items[].RenewalPeriodUnit$ Renewal period unit.
  • $data.Pages[].Items[].RenewalInYears$ Renewal in years.
  • $data.Pages[].Items[].Period$ Period.
  • $data.Pages[].Items[].Price$ Price.
  • $data.Pages[].Items[].Quantity$ Quantity.
  • $data.Pages[].Items[].Taxes$ Taxes.
  • $data.Pages[].Items[].ExpiryDate$ Expire date.
  • $data.Pages[].Items[].Usages$ Usages.
  • $data.Pages[].Items[].HasUsages$ Has usages.
  • $data.Pages[].Items[].Total$ Total.
  • $data.Pages[].Items[].SubscriptionNumber$ Invoice line’s subscription number.
  • $data.Pages[].Items[].IsSubscriptionPresent$ True if the invoice line has a matching subscription, otherwise false.
  • $data.Pages[].Items[].StartDateRaw$ Subscription start date.
  • $data.Pages[].Items[].ExpirationDateRaw$ Subscription expiration date.
  • $data.Pages[].Items[].IsCompany$ True if the customer is a company, otherwise false.
  • $data.Pages[].Items[].CustomerAddress2Present$ True if CustomerAddress2 exists, otherwise false.
  • $data.Pages[].Items[].CustomerNumber$ The customer number.
  • $data.Pages[].Items[].CustomerCompanyNumber$ The customer company number.
  • $data.Pages[].Items[].CustomerCompanyName$ The customer company name.
  • $data.Pages[].Items[].CustomerFirstName$ The customer first name.
  • $data.Pages[].Items[].CustomerLastName$ The customer last name.
  • $data.Pages[].Items[].CustomerAddress$ The customer address.
  • $data.Pages[].Items[].CustomerAddress2$ The second customer address.
  • $data.Pages[].Items[].CustomerZip$ The customer zip.
  • $data.Pages[].Items[].CustomerCity$ The customer city.
  • $data.Pages[].Items[].CustomerCountryName$ The customer country name.
  • $data.Pages[].Items[].HasItemLabel$ True if the item has a label, otherwise false.
  • $data.Pages[].Items[].ItemLabel$ Item label. More information about labels can be found here.
  • $data.Pages[].Items[].HasVdcName$ True if the item is the VDC and it has a name, otherwise false.
  • $data.Pages[].Items[].VdcName$ Item VDC name.
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Invoice email

The following placeholders are available for Invoice email:

  • $CustomerFirstName$ Customer first name.
  • $CustomerLastName$ Customer last name.
  • $InvoiceNumber$ Invoice number.
  • $InvoiceReferenceNumber$ Invoice reference number.
  • $InvoiceDate$ Invoice date.
  • $InvoiceDueDate$ Invoice due date.
  • $Subtotal$ Subtotal.
  • $Subtotal$ Subtotal.
  • $Total$ Total.
  • $Username$ Username.
  • $Moms$ VAT.
  • $TaxRate$ Tax rate.
  • $RabatExists$ True if discount exists.
  • $Rabat$ Discount.
  • $ShowTax$ Show tax.
  • $OnlinePaymentUrl$ Online payment URL.
  • $Autopay$ Autopay.
  • $IsVatValid$ True if the VAT number is valid, otherwise false.
  • $AutopayDate$ Autopay date.
  • $InvoicePaid$ Invoice paid.
  • $Currency$ Currency.
  • $PaymentMethod$ Payment method.
  • $TransactionId$ Transaction ID.
  • $TransactionTimestamp$ Transaction timestamp.
  • $HasPeriodData$ Specifies whether invoice has $StartTime$ and $EndTime$ values.
  • $StartTime$ Start time of postpaid invoice.
  • $EndTime$ End time of postpaid invoice.
  • $items[].Name$ Item name.
  • $items[].OriginalItemName$ Original item name.
  • $items[].ItemNumber$ Item number.
  • $items[].DomainName$ Domain name.
  • $items[].HasDomainName$ True if the item has domain name, otherwise false.
  • $items[].Renewal$ Renewal period.
  • $items[].RenewalWithoutUnit$ Only the renewal period, no unit string included.
  • $items[].Price$ Price.
  • $items[].Qty$ Quantity.
  • $items[].Discount$ Discount.
  • $items[].Total$ Total.
  • $items[].SubscriptionNumber$ Invoice line’s subscription number.
  • $items[].IsSubscriptionPresent$ True if the invoice line has a matching subscription, otherwise false.
  • $items[].StartDateRaw$ Subscription start date.
  • $items[].ExpirationDateRaw$ Subscription expiration date.
  • $items[].IsCompany$ True if the customer is a company, otherwise false.
  • $items[].CustomerAddress2Present$ True if CustomerAddress2 exists, otherwise false.
  • $items[].CustomerNumber$ Invoice customer name.
  • $items[].CustomerCompanyNumber$ Invoice customer legal number.
  • $items[].CustomerCompanyName$ Customer company name.
  • $items[].CustomerFirstName$ Customer first name.
  • $items[].CustomerLastName$ Customer last name.
  • $items[].CustomerAddress$ Customer address.
  • $items[].CustomerAddress2$ Customer address 2.
  • $items[].CustomerZip$ Customer Zip.
  • $items[].CustomerCity$ Customer city.
  • $items[].CustomerCountryName$ Customer country name.
  • $items[].HasItemLabel$ True if the item has a label, otherwise false.
  • $items[].ItemLabel$ Item label. More information about labels can be found here.
  • $items[].HasVdcName$ True if the item is the VDC and it has a name, otherwise false.
  • $items[].VdcName$ Item VDC name.
  • $Customer.<Member Name>$
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Invoice reminder

The following placeholders are available for Invoice reminder:

  • $CustomerFirstName$ Customer first name.
  • $CustomerLastName$ Customer last name.
  • $CustomerCompanyName$ Customer company name.
  • $IsCompany$ True if the customer is a company, otherwise false.
  • $CustomerAddress$ Customer address.
  • $CustomerAddress2$ Customer address 2.
  • $CustomerAddress2Present$ True if CustomerAddress2 exists, otherwise false.
  • $CustomerZip$ Customer zip.
  • $CustomerCity$ Customer city.
  • $CustomerCountryName$ Customer country name.
  • $InvoiceNumber$ Invoice number.
  • $InvoiceReferenceNumber$ Invoice reference number.
  • $InvoiceDate$ Invoice date.
  • $InvoiceDueDate$ Invoice due date.
  • $DaysPastDue$ Days past due date.
  • $Subtotal$ Subtotal.
  • $Total$ Total.
  • $Moms$ VAT.
  • $TaxRate$ VAT rate.
  • $Rabat$ Discount.
  • $ShowTax$ Show tax.
  • $TotalPaid$ Total amount of payments made for invoice.
  • $OutstandingAmount$ Remaining unpaid amount for invoice.
  • $ReminderDate$ Reminder creation date.
  • $items[].Name$ Item name.
  • $items[].Renewal$ Renewal period.
  • $items[].RenewalWithoutUnit$ Only the renewal period, no unit string included.
  • $items[].Price$ Price.
  • $items[].Qty$ Quantity.
  • $items[].Discount$ Discount.
  • $items[].Total$ Total.
  • $OnlinePaymentUrl$ Online payment URL.
  • $Customer.<Member Name>$
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Invoice reminder SMS

The following placeholders are available for Invoice reminder SMS:

  • $InvoiceId$ Invoice reference number.
  • $CustomerNumber$ Cusomer number.
  • $Days$ Days past due date.
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Order additional mail

The following placeholders are available for Order additional mail:

  • $name$ Name.
  • $company$ Company name, available if $isCompany$ is set to true.
  • $orgid$ Organization ID.
  • $domain$ Domain.
  • $time$ Time.
  • $version$ Version.
  • $isCompany$ Flag which is set to true if the customer has chosen Company option when setting up the account info.
  • $hasAceDomain$ Flag which is set to true if the customer has entered Unicode characters (ä, ö, ü) in the domain name.
  • $aceDomain$ Encoded domain format, available if $hasAceDomain$ is set to true.

Order confirmation

The following placeholders are available for Order confirmation:

  • $OrderNumber$ Order number.
  • $CustomerFirstName$ Customer first name.
  • $CustomerLastName$ Customer last name.
  • $Rabat$ Discount.
  • $Moms$ VAT.
  • $TaxRate$ VAT rate.
  • $Total$ Total.
  • $ShowTax$ Show tax.
  • $PayableDomains$ Payable domains.
  • $Currency$ Currency.
  • $OverDebtLimit$ Flag which is set to true if order is not going to be processed because customer is over debt limit.
  • $items[].Name$ Item name.
  • $items[].Qty$ Quantity.
  • $items[].Price$ Price.
  • $items[].Discount$ Discount.
  • $items[].Total$ Total.
  • $items[].Renwal$ Renewal period.
  • $items[].RenewalWithoutUnit$ Only the renewal period, no unit string included.
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Post subscription provisioning

The following placeholders are available for Post subscription provisioning:

  • $Customer.<Member Name>$
  • $Subscription.<Member Name>$

Recurring payment core

The following placeholders are available for Recurring payment core:

  • $CustomerFirstName$ Customer first name.
  • $InvoiceNumber$ Invoice reference number.
  • $InvoiceDueDate$ Due date.
  • $Total$ Total.
  • $Currency$ Currency.
  • $RetryScheduled$ Retry scheduled.
  • $RetryTime$ Retry time.
  • $Reseller.<Member Name>$

Recurring payment generic workflow

The following placeholders are available for Recurring payment generic workflow:

  • $CustomerFirstName$ Customer first name.
  • $CustomerNumber$ Customer number.
  • $InvoiceNumber$ Invoice number.
  • $InvoiceReferenceNumber$ Invoice reference number.
  • $InvoiceDueDate$ Due date.
  • $Total$ Total.
  • $Currency$ Currency.
  • $RetryScheduled$ Retry scheduled.
  • $RetryTime$ Retry time.
  • $PaymentMethod$ Payment method.
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Renewal heads up nofication

The following placeholders are available for Renewal heads up nofication:

  • $CustomerFirstName$ Customer first name.
  • $customerLastName$ Customer last name.
  • $items[].Domain$ Domain.
  • $items[].InvoiceDate$ Invoice date.
  • $items[].RenewalDate$ Renewal date.
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Subscription provision status changed

The following placeholders are available for Subscription provision status changed:

  • $CustomerFirstName$ Customer first name.
  • $CustomerLastName$ Customer last name.
  • $CustomerNumber$ Customer number.
  • $domainName$ Domain name.
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Termination

The following placeholders are available for Termination:

  • Not available at this moment.

Transfer in notification

The following placeholders are available for Transfer in notification:

  • $CustomerFirstName$ Customer first name.
  • $CustomerLastName$ Customer last name.
  • $DomainName$ Domain name.
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Transfer out notification

The following placeholders are available for Transfer out notification:

  • $CustomerFirstName$ Customer first name.
  • $CustomerLastName$ Customer last name.
  • $DomainName$ Domain name.
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Downgrade refund email

The following placeholders are available for Downgrade refund emails:

  • $CustomerId$ Customer id.
  • $BankAccount$ The bank account specified by user.
  • $NewItemName$ Item that the user downgraded to.
  • $OldItemName$ Item that the user downgraded from.

Provisioning Renewal Notification email

  • $TaskName$ The scheduled task name
  • $Items.<Member Name>$ List of subscriptions that are canceled.
    • FriendlyId The subscription friendly id.
    • Id The subscription id.
    • ItemName The subscription id.
    • ProvisioningStatusMessage The subscription provisioning message.
  • $Reseller.<Member Name>$ The reseller data documentation is available here.

Reseller data structure

This is the parameters available in the reseller structure.

  • $Reseller.Name$ Reseller name.
  • $Reseller.HomeUrl$ Home URL.
  • $Reseller.BillingUrl$ Billing URL.
  • $Reseller.OrderUrl$ Order URL.
  • $Reseller.HcpUrl$ Hosting control panel URL.
  • $Reseller.SupportUrl$ Support URL.
  • $Reseller.ContactUrl$ Contact URL.
  • $Reseller.SupportEmailAddress$ Support email address.
  • $Reseller.SupportPhoneNumber$ Support phone number.
  • $Reseller.SalesEmailAddress$ Sales email address.
  • $Reseller.SalesPhoneNumber$ Sales phone number.
  • $Reseller.FacebookUrl$ Facebook URL.
  • $Reseller.TwitterUrl$ Twitter URL.
  • $Reseller.BloggerUrl$ Blogger URL.
  • $Reseller.BankName$ Bank name.
  • $Reseller.BankAccNo$ Bank account number.
  • $Reseller.BankIdNumber$ Bank ID number.
  • $Reseller.IBAN$ IBAN.
  • $Reseller.SWIFT$ SWIFT.
  • $Reseller.CompanyNumber$ Company number.
  • $Reseller.GooglePlusUrl$ Google plus URL.
  • $Reseller.LinkedInUrl$ LinkedIn URL.
  • $Reseller.Address$ Reseller main address.
  • $Reseller.Address2$ Reseller main address 2.
  • $Reseller.City$ Reseller main address city.
  • $Reseller.Zip$ Reseller main address zip.
  • $Reseller.Phone$ Reseller main address phone.
  • $Reseller.Fax$ Reseller main address fax.
  • $Reseller.Country$ Reseller main address country.
  • $Reseller.LegalNumber$ Legal number.

Storage Quota Usage mail

The following placeholders are available for Storage Quota Usage mail:

  • $PackageName$ Package name.
  • $PackageNumber$ Number of the package for that customer.
  • $UsageBottomLine$ Limit set in plugin configuration for package for which email is sent.
  • $WebUsagePercentage$ Usage percentage for web part of storage for that package.
  • $MailUsagePercentage$ Usage percentage for mail part of storage for that package.
  • $TotalUsagePercentage$ Total usage percentage for that package.
  • $Year$ Current year.

Mailbox Quota Usage mail

The following placeholders are available for Mailbox Quota Usage mail:

  • $UsageBottomLine$ Limit set in plugin configuration for mailbox for which email is sent.
  • $UsagePercentage$ Usage percentage for email account.
  • $Year$ Current year.

Was this helpful?