Index | WHMCS Internal Class Documentation

A

Announcement — Class in namespace WHMCS\Announcement: A client-facing general announcement.
$Announcement — Property in class Announcement: Content of the announcement, in HTML.
$Invoice — Property in class Invoice: Free-form text provided by, and expected to be viewable only to, the admin.
$Item — Property in class Item: Total amount due for this line item.
$Transaction — Property in class Transaction: Gross amount paid by the client in this transaction.
$Transaction — Property in class Transaction: Gross amount returned to the client via this transaction.
$Quote — Property in class Quote: First address line of the prospective client requesting the quote.
$Quote — Property in class Quote: Second address line of the prospective client requesting the quote.
$Quote — Property in class Quote: Freeform notes provided by the admin which should not be displayed to the client or on the quote.
Setting::allDefaults() — Method in class Setting: Retrieve a collection of models that each have a default value assigned
Setting::allAsArray() — Method in class Setting: Retrieve all settings as a key value pair array.
$CustomField — Property in class CustomField: Is the field only visible for Admins
AdditionalField — Class in namespace WHMCS\Domain: Domain additional fields.
$Domain — Property in class Domain: Additional notes provided by the admin. Should not be displayed to the client.
$Domain — Property in class Domain: All additional fields belonging to this domain's registration.
Domain::additionalFields() — Method in class Domain: Every domain can have one or more additional registrar-specific fields.
Download::asLink() — Method in class Download: Represent a download as a file download link.
$Template — Property in class Template: Comma delimited list of filenames for files that should be attached to the outgoing email, with it's root at /downloads/
$NetworkIssue — Property in class NetworkIssue: An English language internal name for the type of network issue: 'server' (affects a hosting server), 'system' (affects the billing or support systems), 'other' (user defined)
$NetworkIssue — Property in class NetworkIssue: A string which is displayed as the network issue type if "other" is the affectedType.
$NetworkIssue — Property in class NetworkIssue: The Unique ID number of the server affected, if "server" is the affectedType.
$Product — Property in class Product: Whether or not customers may specify if they want more than one of this item when purchasing.
$Product — Property in class Product: When provisioning a product should take place, either "order", "payment", "on", or "".
$Product — Property in class Product: The id of the email to send to a client when a product is automatically terminated.
$Product — Property in class Product: Whether or not a product's configurable options can be upgraded and downgraded.
$Product — Property in class Product: Whether or not tax should be applied to a product.
$Product — Property in class Product: Whether or not affiliates should only be paid on a product once, even if it's a recurring product.
$Product — Property in class Product: The type of payment available for affiliates that successfully promote a product, either "percentage", "fixed", "none", or "" (the default payout method).
$Product — Property in class Product: The percent or fixed amount which should be paid to affiliates.
$Product — Property in class Product: The email to send to a client when a product is automatically terminated.
Product::autoTerminationEmailTemplate() — Method in class Product: A product has one auto termination email template.
AbstractTask — Class in namespace WHMCS\Scheduling\Task: Abstract Task that should be extend by domain specific tasks.
Addon — Class in namespace WHMCS\Service: Service addons
$Addon — Property in class Addon: ID of addon that this object is an instance of.
$Addon — Property in class Addon: True if tax is charged when purchasing/paying for this addon.
$Service — Property in class Service: The recurring payment amount for this service.
$Service — Property in class Service: If the service is assigned to IP addresses, those addresses will appear as comma delimited strings here.
$Service — Property in class Service: Addons purchased alongside this service.
Service::addons() — Method in class Service: Each service can have many addons
Admin — Class in namespace WHMCS\User: An administrative user
$Admin — Property in class Admin
Alert — Class in namespace WHMCS\User: A user level alert
$Client — Property in class Client
$Client — Property in class Client: The first line of the address a client resides at.
$Client — Property in class Client: The second line of the address a client resides at.
$Client — Property in class Client: Determines if Single Sign-On is permitted for this client user.
$Client — Property in class Client: A client's affiliate record, if activated as an affiliate.
Client::affiliate() — Method in class Client: A client can have an associated affiliate record.
Affiliate — Class in namespace WHMCS\User\Client: Client affiliate information
$Affiliate — Property in class Affiliate: The total balance withdrawn by an affiliate.
$Contact — Property in class Contact
$Contact — Property in class Contact: All contact permissions.
$Contact — Property in class Contact: The first line of the address a client contact resides at.
$Contact — Property in class Contact: The second line of the address a client contact resides at.
Item::addChild() — Method in class Item: Add a child menu item.

B

$Announcement — Property in class Announcement
$Invoice — Property in class Invoice: Balance still due on this invoice. If a client makes partial payments toward this invoice, those payments against the total will be reflected here.
$Item — Property in class Item
$Item — Property in class Item
$Setting — Property in class Setting: The following settings have boolean values.
Setting::boot() — Method in class Setting: Load events around settings.
CustomField::boot() — Method in class CustomField
$Domain — Property in class Domain
$Category — Property in class Category
$Download — Property in class Download
Download::boot() — Method in class Download: Bind events to download objects.
$Template — Property in class Template
Template::boot() — Method in class Template
$Group — Property in class Group
Group::boot() — Method in class Group
$Product — Property in class Product
Product::boot() — Method in class Product
$Addon — Property in class Addon: English language internal name for billing cycle from this set: 'Free Account', 'One Time', 'Monthly', 'Quarterly', 'Semi-Annually', 'Annually', 'Biennially', 'Triennially'
$Service — Property in class Service
$Service — Property in class Service: English language internal name of this service's billing cycle from this set: 'Free Account', 'One Time', 'Monthly', 'Quarterly', 'Semi-Annually', 'Annually', 'Biennially', 'Triennially'
$Service — Property in class Service: If the service's module provides bandwidth usage telemetry, that value is stored here.
$Service — Property in class Service: If the service was purchased with a disk usage limit, that limit is stored here.
$Client — Property in class Client
$Client — Property in class Client: The id number of a client's associated billing contact.
$Affiliate — Property in class Affiliate: The total balance of unclaimed commission belonging to an affiliate.
$Contact — Property in class Contact
$Item — Property in class Item: An optional badge displayed to the right of a menu item's label.
$Item — Property in class Item: Raw HTML to be rendered in a menu item's body area.

C

$Announcement — Property in class Announcement
$Announcement — Property in class Announcement: Date this announcement was originally created.
$Invoice — Property in class Invoice
$Invoice — Property in class Invoice: ID number of the client this invoice is addressed to.
$Invoice — Property in class Invoice: If the client has credit on hand, this is the amount of credit applied to this invoice.
$Invoice — Property in class Invoice: Client object for which this invoice is due.
Invoice::client() — Method in class Invoice: Each invoice belongs to one client.
$Item — Property in class Item
$Transaction — Property in class Transaction
$Transaction — Property in class Transaction: ID of client which made this transaction.
$Transaction — Property in class Transaction: ID number of currency for which this invoice is calculated.
Transaction::client() — Method in class Transaction: A transaction can belong to a client.
$Quote — Property in class Quote
$Quote — Property in class Quote: ID of client this quote is assigned to, if the quote belongs to a pre-existing client.
$Quote — Property in class Quote: Company name of the prospective client requesting the quote.
$Quote — Property in class Quote: City of the prospective client requesting the quote.
$Quote — Property in class Quote: Country of the prospective client requesting the quote.
$Quote — Property in class Quote: ID of the currency this quote is generated in.
$Quote — Property in class Quote: Text block provided by the admin which is displayed at the footer of the quote generated by WHMCS.
$Quote — Property in class Quote: The Client to whom this quote belongs to, if the client is pre-existing.
Quote::client() — Method in class Quote: Each quote may belong to a client.
$Item — Property in class Item
$Item — Property in class Item: Date this line item was created.
$Setting — Property in class Setting
CustomField — Class in namespace WHMCS: Custom Fields model class
$CustomField — Property in class CustomField
$CustomField — Property in class CustomField
$CustomField — Property in class CustomField: The date a custom field was created.
$AdditionalField — Property in class AdditionalField: Date this additional field was added to the domain.
$Domain — Property in class Domain
$Domain — Property in class Domain
$Domain — Property in class Domain: ID of client who owns this domain.
$Domain — Property in class Domain: Date this domain was created.
$Domain — Property in class Domain: Client to whom this domain belongs to.
Domain::client() — Method in class Domain: Each domain belongs to one client.
Category — Class in namespace WHMCS\Download: A download category
$Category — Property in class Category
$Category — Property in class Category: The date this category was created.
$Category — Property in class Category: Array of Category objects which are subcategories of this one, if they exist.
Category::childCategories() — Method in class Category: A category may have many child categories.
$Download — Property in class Download
$Download — Property in class Download: If true, this download should only be available to clients.
$Download — Property in class Download: The date when this specific download was created.
$Template — Property in class Template
$Template — Property in class Template: False if the email template is a WHMCS built-in. True otherwise.
$Template — Property in class Template: Comma delimited list of email addresses that should be CC: on the outgoing email.
$Template — Property in class Template
$NetworkIssue — Property in class NetworkIssue
$NetworkIssue — Property in class NetworkIssue: The date this network issue was originally created.
$Group — Property in class Group
$Group — Property in class Group
$Group — Property in class Group: The date a product group was created.
$Product — Property in class Product
$Product — Property in class Product
$Product — Property in class Product: The date a product was created.
$Product — Property in class Product: The custom fields for a product.
Product::customFields() — Method in class Product
$AbstractTask — Property in class AbstractTask
$Addon — Property in class Addon
$Addon — Property in class Addon: The date this addon was created.
CancellationRequest — Class in namespace WHMCS\Service: A service cancellation request
$CancellationRequest — Property in class CancellationRequest
$CancellationRequest — Property in class CancellationRequest: Timestamp of when this cancellation request was created.
$Service — Property in class Service
$Service — Property in class Service: ID of client who owns this service.
$Service — Property in class Service: Date this service was created.
$Service — Property in class Service: Client object which owns this service.
$Service — Property in class Service: Any cancellation requests related to this service.
Service::client() — Method in class Service: Each service belongs to one client.
Service::cancellationRequests() — Method in class Service: Each service can have many cancellation requests
$Admin — Property in class Admin
$Admin — Property in class Admin
Client — Class in namespace WHMCS\User: A client user.
$Client — Property in class Client
$Client — Property in class Client: The name of the company employing a client.
$Client — Property in class Client: The city a client resides in.
$Client — Property in class Client: The two-letter ISO code of the country a client resides in.
$Client — Property in class Client: The id number of a client's preferred currency.
$Client — Property in class Client: The amount of credit a client has available.
$Client — Property in class Client: The type of credit card a client has on file.
$Client — Property in class Client: The last four digits of a client's credit card on file.
$Client — Property in class Client: The encrypted expiration date of a client's card on file.
$Client — Property in class Client: The full name of the country a client resides in.
$Client — Property in class Client: A client's associated contacts.
$Client — Property in class Client: Initial creation of the client data (or 0000-00-00 00:00:00 if created before 6.0.0).
Client::contacts() — Method in class Client: A client can have many contacts.
$Affiliate — Property in class Affiliate
$Affiliate — Property in class Affiliate: The id of the client associated with an affiliate record.
$Affiliate — Property in class Affiliate: The type of commission payment made to an affiliate, either "percentage", "fixed", or null.
$Affiliate — Property in class Affiliate: The date an affiliate record was created.
$Affiliate — Property in class Affiliate: The client associated with an affiliate record.
Affiliate::client() — Method in class Affiliate: Each affiliate belongs to one client.
Contact — Class in namespace WHMCS\User\Client: A client contact
$Contact — Property in class Contact
$Contact — Property in class Contact
$Contact — Property in class Contact: The id of the client a client contact belongs to.
$Contact — Property in class Contact: The name of the company employing a client contact.
$Contact — Property in class Contact: The city a client contact resides in.
$Contact — Property in class Contact: The two-letter ISO code of the country a client contact resides in.
$Contact — Property in class Contact: The date a client contact was created.
$Contact — Property in class Contact: The full name of the country a client contact resides in.
$Contact — Property in class Contact: The client that a client contact belongs to.
Contact::client() — Method in class Contact: Each contact belongs to one client.
$SecurityQuestion — Property in class SecurityQuestion: The date a security question was created.
$SecurityQuestion — Property in class SecurityQuestion: The clients that must answer this security question upon login.
SecurityQuestion::clients() — Method in class SecurityQuestion: A security question may be in use by many clients.
Item::copy() — Method in class Item: Make a copy of a menu item.

D

$Announcement — Property in class Announcement
$Invoice — Property in class Invoice
$Invoice — Property in class Invoice: Date this invoice was created.
$Invoice — Property in class Invoice: Date this invoice is considered "Due."
$Invoice — Property in class Invoice: Date this invoice was marked as "Paid."
$Item — Property in class Item
$Item — Property in class Item: A text description of this line item.
$Item — Property in class Item: Date this line item is due.
$Transaction — Property in class Transaction
$Transaction — Property in class Transaction: Date upon which this transaction was made.
$Transaction — Property in class Transaction: Human readable description of this transaction.
$Quote — Property in class Quote
$Quote — Property in class Quote: Date this quote was generated.
$Quote — Property in class Quote: Date this quote was sent to the [prospective] client.
$Quote — Property in class Quote: Date the [prospective] client accepted this quote.
$Item — Property in class Item: Description attached to this line item.
$Item — Property in class Item: Percentage discount offered, if any.
$Setting — Property in class Setting: Inheriting classes may provide a default key/value list for allDefaults() collection return
$CustomField — Property in class CustomField: The description of the custom field
$AdditionalField — Property in class AdditionalField: ID number of domain to which this additional field is associated.
$AdditionalField — Property in class AdditionalField: Domain object to which this additional field is attached.
AdditionalField::domain() — Method in class AdditionalField: Each additional field belongs to one domain.
Domain — Class in namespace WHMCS\Domain: A customer's domain.
$Domain — Property in class Domain
$Domain — Property in class Domain: This domain name.
$Category — Property in class Category: A textual description of the contents of this category.
$Category — Property in class Category: Array of Download objects which belong in this category.
Category::downloads() — Method in class Category: A download category may have many downloads in it.
Download — Class in namespace WHMCS\Download: A downloadable file.
$Download — Property in class Download: ID number of category this download belongs to.
$Download — Property in class Download: Description displayed to the client for this file.
$Download — Property in class Download: Category object to which this download belongs.
Download::downloadCategory() — Method in class Download: A download exists within a category.
$Template — Property in class Template: If set to true, this email template will not be used for outgoing email.
$NetworkIssue — Property in class NetworkIssue
$NetworkIssue — Property in class NetworkIssue: The text which should be displayed to clients, explaining the network issue. May contain HTML.
$Group — Property in class Group: Payment gateways which should NOT be displayed to the client when ordering products in a product group.
$Group — Property in class Group: The order in which a product group is displayed to clients.
$Product — Property in class Product: A product's description. Some order form templates may render structured data in a product's description.
$Product — Property in class Product: The number of days after sign up before a product is automatically terminated.
$Product — Property in class Product: The order in which to display a product in its group.
$Addon — Property in class Addon
$CancellationRequest — Property in class CancellationRequest
$CancellationRequest — Property in class CancellationRequest: The date this cancellation was originally created.
$Service — Property in class Service
$Service — Property in class Service: Domain name this service is registered under.
$Service — Property in class Service: English language internal name of status of this service, from this set: 'Pending', 'Active', 'Suspended', 'Terminated', 'Cancelled', 'Fraud' (Additionally custom status may exist)
$Service — Property in class Service: If the service provides a dedicated IP address, it is stored here.
$Service — Property in class Service: If the service's module provides disk usage telemetry, that value is stored here.
$Service — Property in class Service: If the service was purchased with a disk usage limit, that limit is stored here.
$Admin — Property in class Admin: Whether or not an admin is disabled and cannot log in.
$Client — Property in class Client
$Client — Property in class Client: A client's default default payment gateway module.
$Client — Property in class Client: Whether or not a client's invoices should be automatically processed.
$Client — Property in class Client: The date a client was created.
$Client — Property in class Client: The domains a client has purchased.
Client::domains() — Method in class Client: A client can have many domains.
$Affiliate — Property in class Affiliate
$Affiliate — Property in class Affiliate: The date an affiliate record was added to a client.
$Contact — Property in class Contact
$Item — Property in class Item: Tracks if a menu item is disabled.
Item::disable() — Method in class Item: Set a menu item as disabled.

E

$Transaction — Property in class Transaction: The exchange rate between the currency paid by the client and the currency of the WHMCS install.
$Quote — Property in class Quote: Email address of the prospective client requesting the quote.
$Domain — Property in class Domain: Date the registration expires
$NetworkIssue — Property in class NetworkIssue: The date upon which the effects of this network issue ceased, or is scheduled to end.
$Product — Property in class Product: An array whose first value is true if overages are enabled. Its second value is the unit to use for a product's disk usage limits, either "MB", "GB", or "TB". Its third value is the unit to use for a product's bandwidth usage limits, either "MB", "GB", or "TB".
AbstractTask::expressionPasses() — Method in class AbstractTask: Ensure $expression has been set property
$Admin — Property in class Admin: An admin's email address.
$Client — Property in class Client: A client's email address.
$Client — Property in class Client: Whether or not to disable sending email to a client.
$Client — Property in class Client: Determines if the client's email address ownership has been verified.
$Contact — Property in class Contact: A client contact's email address.
Item::enable() — Method in class Item: Set a menu item as enabled.

F

$Transaction — Property in class Transaction: Merchant fees charged against this transaction.
$Quote — Property in class Quote: First name of the prospective client requesting the quote.
$Setting — Property in class Setting: Allow mass assignment of setting values.
$CustomField — Property in class CustomField: The name of the custom field
$CustomField — Property in class CustomField: The type of the custom field dropdown|link|text|textarea|tickbox|password
$CustomField — Property in class CustomField: The options available for the dropdown type
$Domain — Property in class Domain: Initial payment made to purchase this domain.
$Download — Property in class Download: Name of the file on the filesystem with it's root in /downloads/
$Template — Property in class Template: Name which should be used as the "From" name displayed in the recipient's email client. If set to null, WHMCS uses the default.
$Template — Property in class Template: Email address which should be used as the "From" address in the recipient's email client. If set to null, WHMCS uses the default.
$Group — Property in class Group: The products that belong to a product group.
Group::features() — Method in class Group: A product group can have many features.
$Product — Property in class Product: The domains a client can select for a free sub-domain.
$Product — Property in class Product: Whether purchasing a product provisions a free domain name, either "once", "on", or "".
$Product — Property in class Product: The payment terms a product must be purchased with to be provisioned with a free domain name, anything from the set "onetime", "monthly", "quarterly", "semiannually", "annually", "biennially", and "triennially".
$Product — Property in class Product: The top-level domains that are available for use with a product's free domain.
$Service — Property in class Service: The first amount paid for this service.
$Admin — Property in class Admin: An admin's first name.
$Admin — Property in class Admin: An admin's first name and last name.
$Client — Property in class Client
$Client — Property in class Client: A client's first name.
$Client — Property in class Client: A client's first name and last name.
$Contact — Property in class Contact: A client contact's first name.
$Contact — Property in class Contact: A client contact's first name and last name.
$Item — Property in class Item: Raw HTML to be rendered in a menu item's footer area.

G

Announcement::getUniqueMonthsWithAnnouncements() — Method in class Announcement: Retrieve a list of the past months in which announcements were posted.
Invoice::getBalanceAttribute() — Method in class Invoice: Calculate balance remaining for the invoice.
$Setting — Property in class Setting: Once set, we cannot change a setting's 'setting' column.
Setting::getValue() — Method in class Setting: Retrieve a WHMCS setting value by setting key name.
Setting::getBooleanValues() — Method in class Setting: Return the setting names whose value should be boolean, but is stored as one of many boolean-ish strings
Setting::getCommaSeparatedValues() — Method in class Setting: Return the setting names whose value should be an array, but is stored as a csv
CustomField::getFieldNameAttribute() — Method in class CustomField: Get the custom field's name - this will override the output from the db value if set in Lang.
CustomField::getDescriptionAttribute() — Method in class CustomField: Get the custom field's name - this will override the output from the db value if set in Lang.
CustomField::getFieldName() — Method in class CustomField: Obtain the custom field name for the current language, passed language or fallback to the currently defined value for the product group.
CustomField::getDescription() — Method in class CustomField: Obtain the custom field description for the current language, passed language or fallback to the currently defined value for the product group.
Download::getFile() — Method in class Download: Retrieve a download's associated file for interaction with the filesystem.
$Template — Property in class Template
Template::getActiveLanguages() — Method in class Template: Retrieve a list of all of the languages used by all mail templates.
Group — Class in namespace WHMCS\Product: A product group
Group::getAvailableBillingCycles() — Method in class Group: Get available billing cycles for product.
Group::getNameAttribute() — Method in class Group: Get the group's name - this will override the output from the db value if set in Lang.
Group::getHeadlineAttribute() — Method in class Group: Get the group's headline - this will override the output from the db value if set in Lang.
Group::getTaglineAttribute() — Method in class Group: Get the group's tagline - this will override the output from the db value if set in Lang.
Group::getGroupName() — Method in class Group: Obtain the product group name for the current language, passed language or fallback to the currently defined value for the product group.
Group::getHeadline() — Method in class Group: Obtain the product headline for the current language, passed language or fallback to the currently defined value for the product group.
Group::getTagline() — Method in class Group: Obtain the product tagline for the current language, passed language or fallback to the currently defined value for the product group.
Product::getDownloadIds() — Method in class Product: Retrieve a list of the ids of the downloads associated with a product.
Product::getUpgradeProductIds() — Method in class Product: Retrieve a list of the ids of the upgrade products associated with a product.
Product::getAvailableBillingCycles() — Method in class Product: Get available billing cycles for product.
Product::getNameAttribute() — Method in class Product: Get the product name - this will override the output from the db value if set in Lang.
Product::getDescriptionAttribute() — Method in class Product: Get the product description - this will override the output from the db value if set in Lang.
Product::getProductName() — Method in class Product: Obtain the product name for the current language, passed language or fallback to the currently defined value for the product.
Product::getProductDescription() — Method in class Product: Obtain the product description for the current language, passed language or fallback to the currently defined value for the product.
AbstractTask::getContext() — Method in class AbstractTask
AbstractTask::getOutput() — Method in class AbstractTask
Admin::getFullNameAttribute() — Method in class Admin: "fullName" is the concatenation of first and last name.
Admin::getUsernameAttribute() — Method in class Admin: Return the username
Alert::getMessage() — Method in class Alert: Retrieve an alert's message.
Alert::getSeverity() — Method in class Alert: Retrieve an alert's severity.
Alert::getLink() — Method in class Alert: Retrieve an optional link target to provide along with an alert.
Alert::getLinkText() — Method in class Alert: Retrieve an optional link text to provide along with an alert.
$Client — Property in class Client: The id number of the group that a client belongs to.
Client::generateCreditCardEncryptionKey() — Method in class Client: Generate the AES key used to encrypt a user's credit card information.
Client::getAlerts() — Method in class Client: Retrieve a client's alerts.
Client::getFullNameAttribute() — Method in class Client: "fullName" is the concatenation of first and last name.
Client::getCountryNameAttribute() — Method in class Client: Returns the human readable name for the clients country.
Client::getSecurityQuestionAnswerAttribute() — Method in class Client: Decrypt security question answers from storage.
Client::generateCreditCardEncryptedField() — Method in class Client: Generate an AES Encrypted string from the passed value.
Client::getUsernameAttribute() — Method in class Client
Client::getEmailVerificationId() — Method in class Client: Returns the email verification id to verify email ownership.
Client::generateEmailVerificationKey() — Method in class Client: Returns a key used to verify ownership of an email account.
Contact::getFullNameAttribute() — Method in class Contact: "FullName" is the concatenation of first and last name.
Contact::getCountryNameAttribute() — Method in class Contact: Returns the human readable name for the contacts country.
Contact::getLanguageAttribute() — Method in class Contact
Contact::getTwoFactorAuthModuleAttribute() — Method in class Contact
SecurityQuestion::getQuestionAttribute() — Method in class SecurityQuestion: Decrypt security questions from storage.
Item::getName() — Method in class Item: Retrieve a menu item's name.
Item::getUri() — Method in class Item: Retrieve a menu item's link target.
Item::getLabel() — Method in class Item: Retrieve a menu item's label.
Item::getChild() — Method in class Item: Retrieve a menu item's child item by name.
Item::getLevel() — Method in class Item: Retrieve a menu item's level in the menu tree.
Item::getRoot() — Method in class Item: Retrieve the root menu item.
Item::getParent() — Method in class Item: Retrieve a menu item's parent item.
Item::getChildren() — Method in class Item: Retrieve a menu item's child items.
Item::getBadge() — Method in class Item: Retrieve a menu item's badge, or false if the badge isn't set.
Item::getOrder() — Method in class Item: Retrieve a menu item's sort order.
Item::getClass() — Method in class Item: Retrieve a menu item's css class definitions.
Item::getExtras() — Method in class Item: Retrieve a key/value pair of menu item extras.
Item::getExtra() — Method in class Item: Retrieve a menu item extra by name.
Item::getIcon() — Method in class Item: Retrieve full CSS classes of the icon displayed next to a menu item.
Item::getBodyHtml() — Method in class Item: Retrieve a menu item's body HTML content.
Item::getFooterHtml() — Method in class Item: Retrieve a menu item's footer HTML content.
Item::getHeadingHtml() — Method in class Item: Retrieve a menu item's heading HTML content.
Item::getId() — Method in class Item: Build a menu item's CSS id.

H

$Domain — Property in class Domain: True if the customer purchased DNS management as part of this domain purchase.
$Domain — Property in class Domain: True if customer purchased Email Forwarding as part of this domain purchase.
$Domain — Property in class Domain: True if customer purchased ID Protection (anonymous WHOIS) as part of this domain purchase.
$Domain — Property in class Domain: True if "Disable Auto Renew" is activated for this domain.
$Group — Property in class Group: A product group's headline.
Service::hasAvailableUpgrades() — Method in class Service: Determine if a service has available upgrades.
$Admin — Property in class Admin: A comma delimited list of admin area home page widgets and their configuration, separated by colons. For instance, widget_name:true/false
Admin::hasPermission() — Method in class Admin: Has a given permission within their assigned role group
Client::hasDomain() — Method in class Client: Determines if client has a given domain name.
Client::hasSingleSignOnPermission() — Method in class Client: Returns if the client has Single Sign-On Enabled for their account.
$Item — Property in class Item: Raw HTML to be rendered in a menu body's heading area.
Item::hasChildren() — Method in class Item: Determine if a menu item has child items.
Item::hasBadge() — Method in class Item: Determine if a menu item has a badge.
Item::hasIcon() — Method in class Item: Determine if a menu item has an icon.
Item::hasFontAwesomeIcon() — Method in class Item: Determine if a menu item's icon is a Font Awesome icon.
Item::hasGlyphicon() — Method in class Item: Determine if a menu item's icon is a Glyphicon.
Item::hasBodyHtml() — Method in class Item: Determine if a menu item has body HTML.
Item::hasFooterHtml() — Method in class Item: Determine if a menu item has footer HTML.
Item::hasHeadingHtml() — Method in class Item: Determine if a menu item has heading HTML.

I

$Announcement — Property in class Announcement: Unique ID number for this announcement.
$Announcement — Property in class Announcement: State of the "Published" checkbox. On true, the announcement is displayed to clients.
Invoice — Class in namespace WHMCS\Billing: A customer's invoice.
$Invoice — Property in class Invoice: Unique Internal Invoice ID number. Should not be confused with the invoiceNumber, which is displayed to the client.
$Invoice — Property in class Invoice: Invoice number displayed to customer. Custom formatted string configured in General Settings -> Invoices Tab -> Sequential Invoice Number Format.
Invoice::items() — Method in class Invoice: Each invoice can have many line items.
Item — Class in namespace WHMCS\Billing\Invoice: Invoice line items
$Item — Property in class Item: Unique id number for this line item.
$Item — Property in class Item: Invoice ID for the invoice this line item belongs to.
$Item — Property in class Item: The invoice this line item belongs to.
Item::invoice() — Method in class Item: Each invoice item belongs to an invoice.
$Transaction — Property in class Transaction: Unique ID number of this transaction.
$Transaction — Property in class Transaction: Internal Invoice ID number to which this transaction applies.
Transaction::invoice() — Method in class Transaction: A transaction can belong to an invoice.
$Quote — Property in class Quote: Unique ID number for this quote.
$Quote — Property in class Quote: Items associated with this quote.
Quote::items() — Method in class Quote: A quote has many quote items for.
Item — Class in namespace WHMCS\Billing\Quote: Quote line items
$Item — Property in class Item: Unique ID number for this quote line item.
$Item — Property in class Item: True if this item should be calculated with taxes.
$Setting — Property in class Setting: Settings don't have an auto-incrementing key.
$CustomField — Property in class CustomField: A custom fields unique identifier
$AdditionalField — Property in class AdditionalField: Unique ID for this domain registration additional field.
$Domain — Property in class Domain: Unique ID for this domain object.
$Domain — Property in class Domain: True if the registrar's data on this domain is fully synced with WHMCS.
$Category — Property in class Category: Unique ID number for this category.
$Category — Property in class Category: If true, do not display this category to clients.
$Download — Property in class Download: Unique ID number for this download.
$Download — Property in class Download: If true, this download should not be displayed to clients, only to admins.
$Download — Property in class Download: If true, this download is associated with a specific product.
$Template — Property in class Template: Unique ID number for this mail template.
$NetworkIssue — Property in class NetworkIssue: Unique ID Number for this specific network issue announcement.
$Group — Property in class Group: A product group's unique identifier.
$Group — Property in class Group: Whether or not a product group is displayed to clients in the shopping cart.
$Product — Property in class Product
$Product — Property in class Product: A product's unique id number.
$Product — Property in class Product: Whether or not to display a product in shopping cart modules.
$Product — Property in class Product: Whether or not a product is retired and should no longer be sold.
$Product — Property in class Product: Whether or not a product is displayed more prominently in its product group.
AbstractTask::isDue() — Method in class AbstractTask
$Addon — Property in class Addon: Unique ID number for this addon instance.
$CancellationRequest — Property in class CancellationRequest: Unique ID Number for this cancellation request.
$Service — Property in class Service: Unique ID for this service.
$Admin — Property in class Admin: An admin's unique id number.
Admin::isAllowedToAuthenticate() — Method in class Admin: Should the user be allowed to authenticate
Admin::isAllowedToMasquerade() — Method in class Admin
$Client — Property in class Client: A client's unique id number.
$Client — Property in class Client
Client::invoices() — Method in class Client: A client can have many invoices.
Client::isCreditCardExpiring() — Method in class Client: Determine if a user's credit card is going to expire within a number of months.
Client::isAllowedToAuthenticate() — Method in class Client: Should the user be allowed to authenticate
Client::isEmailAddressVerified() — Method in class Client: Returns if the client's email address ownership has been verified.
$Affiliate — Property in class Affiliate: An affiliate record's unique id.
$Affiliate — Property in class Affiliate: Whether or not an affiliate is only paid commission on initial sale. Otherwise, an affiliate's commission applies to recurring payments.
$Contact — Property in class Contact: Unique A clients contact's unique id.
$Contact — Property in class Contact: Whether or not a client contact is a sub-account. Sub-accounts may log into the client area.
$SecurityQuestion — Property in class SecurityQuestion: A security question's unique id.
Item — Class in namespace WHMCS\View\Menu: An item in one of WHMCS's client area menus.
$Item — Property in class Item: An optional icon displayed next to a menu item.
Item::isRoot() — Method in class Item: Determine if a menu item is the root menu item.
Item::isDisabled() — Method in class Item: Retrieve if a menu item is disabled.
Item::isFontAwesomeIcon() — Method in class Item: Determine if a string describes a Font Awesome icon.
Item::isGlyphicon() — Method in class Item: Determine if a string describes a Glyphicon.

L

$Announcement — Property in class Announcement: English language internal name of the language used in this translation.
$Quote — Property in class Quote: Last name of the prospective client requesting the quote.
$Quote — Property in class Quote: Last date this quote was modified.
$Template — Property in class Template: English language internal name identifying the language of this email template translation.
$NetworkIssue — Property in class NetworkIssue: The date and time of the last update of the network issue via the Admin panel.
$Service — Property in class Service: Date this service was last modified.
$Admin — Property in class Admin: An admin's last name.
$Admin — Property in class Admin: An admin's preferred display language.
$Admin — Property in class Admin: The number of times an admin has failed to log into the WHMCS admin area.
$Alert — Property in class Alert: An optional link target to provide along with an alert.
$Alert — Property in class Alert: An optional link text to provide along with an alert.
$Client — Property in class Client: A client's last name.
$Client — Property in class Client: The last date a client logged into the client area.
$Client — Property in class Client: The IP address a client used the last time they logged into the client area.
$Client — Property in class Client: The resolved hostname of the IP address used the last time a client logged into the client area.
$Client — Property in class Client: A client's preferred display language.
$Contact — Property in class Contact: A client contact's last name.

M

$Template — Property in class Template: The message template used for the body of the outgoing email.
$Product — Property in class Product: The name of the module used to provision a product.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Alert — Property in class Alert: An alert's message.
Item::moveUp() — Method in class Item: Move a menu item up in sorting order.
Item::moveDown() — Method in class Item: Move a menu item down in sorting order.
Item::moveToFront() — Method in class Item: Move a menu item to the beginning of the sorting order.
Item::moveToBack() — Method in class Item: Move a menu item to the end of the sorting order.

N

$Item — Property in class Item: Any admin supplied notes for this line item. (This property is not used internally by WHMCS, but is left in place for legacy purposes.)
$Setting — Property in class Setting: The following settings may not be null or empty.
Setting::newCollection() — Method in class Setting: Get a collection of models
$AdditionalField — Property in class AdditionalField: Name of this additional field.
$Domain — Property in class Domain: The date the next payment is due on.
$Domain — Property in class Domain: The date the next invoice will be generated on.
$Category — Property in class Category: Name of this category.
$Template — Property in class Template: Name by which the template is known in the Admin interface.
NetworkIssue — Class in namespace WHMCS\Network: A network issue.
$Group — Property in class Group: A product group's name.
$Product — Property in class Product: A product's name.
$Addon — Property in class Addon: Name of this addon. This will either be the name assigned to the master addon, or a custom name assigned by an admin.
$Addon — Property in class Addon: The next date this addon's billing cycle is due.
$Addon — Property in class Addon: The date the next invoice will be generated for this addon.
$Addon — Property in class Addon: Admin provided notes on this addon that should not be displayed to clients.
$Service — Property in class Service: Date next payment is due.
$Service — Property in class Service: Date next invoice will be generated.
$Service — Property in class Service: Admin custom notes, with expectation that client will not see them.
$Service — Property in class Service: If the service requires a nameserver (such as a domain name), the first nameserver is stored here.
$Service — Property in class Service: If the service requires a second nameserver, that nameserver is stored here.
$Admin — Property in class Admin: An internal note available for an admin's general use.
$Client — Property in class Client: Internal admin-provided notes about a client. These notes are not visible to the client.

O

$Domain — Property in class Domain: ID of order where this domain was purchased.
$Group — Property in class Group: The order form template a product group should display on the order form, or null to use the default shopping cart template.
Group::orderFormTemplate() — Method in class Group: Retrieve a product group's associated order form
$Product — Property in class Product: The soft limit of a product's allowed disk usage to this number of units configured in enableOverageBillingAndUnits.
$Product — Property in class Product: The soft limit of a product's allowed bandwidth usage to this number of units configured in enableOverageBillingAndUnits.
$Product — Property in class Product: The price to charge per unit configured in enableOverageBillingAndUnits for a product's disk usage above the soft limit configured in overageDiskLimit.
$Product — Property in class Product: The price to charge per unit configured in enableOverageBillingAndUnits for a product's bandwidth usage above the soft limit configured in overageBandwidthLimit.
$Addon — Property in class Addon: ID of order in which this addon was purchased.
$Service — Property in class Service: ID of order used to purchase this service.
$Service — Property in class Service: If true, WHMCS will not attempt to automatically suspend this service.
$Service — Property in class Service: If Auto Suspend is not overridden, on this date the service will be automatically suspended.
$Client — Property in class Client: Whether or not a client should be charged late payment fees.
$Client — Property in class Client: Whether or not a client should receive overdue invoice notices.
$Client — Property in class Client: If true, do not automatically set this client's account status to 'Closed.'
$Item — Property in class Item: The order that a menu item appears in its hierarchy.

P

$Announcement — Property in class Announcement: The most recent date the "Published" checkbox was set for this announcement (not necessarily the same as the creation date).
$Announcement — Property in class Announcement: If this announcement is a translation, this ID points to the source of the translation. Otherwise it's 0.
$Announcement — Property in class Announcement: If this is a translation of another announcement, this property points to the source Announcement object.
Announcement::parent() — Method in class Announcement: An announcement may have a parent announcement.
$Invoice — Property in class Invoice: Internal name of payment gateway assigned to this invoice.
$Item — Property in class Item: Internal name of payment gateway module selected for this line item.
$Transaction — Property in class Transaction: Internal name of payment gateway used to make this transaction.
$Quote — Property in class Quote: Post/Zip code of the prospective client requesting the quote.
$Quote — Property in class Quote: Phone Number of the prospective client requesting the quote.
$Quote — Property in class Quote: Text block provided by the admin which is displayed at the top of the quote generated by WHMCS.
$Setting — Property in class Setting: Configuration settings are keyed on the 'setting' column.
$CustomField — Property in class CustomField: The product a custom field belongs to
CustomField::product() — Method in class CustomField: A custom field can belong to a single product
$Domain — Property in class Domain: ID of promotion used to purchase this domain.
$Domain — Property in class Domain: Internal name of payment gateway used to purchase this domain name.
$Category — Property in class Category: If this category is a sub-category, this is the unique ID number of it's parent.
$Category — Property in class Category: Category object of this category's parent, if this is a subcategory.
Category::parentCategory() — Method in class Category: A category may have a parent category.
$Download — Property in class Download: Array of all products this download is associated with.
Download::products() — Method in class Download: A download can be associated with one or more products.
$Template — Property in class Template: If set to true, this email will be sent without HTML body content, only plain text.
$NetworkIssue — Property in class NetworkIssue: An English language name of the priority of this issue from this set: 'Low', 'Medium', 'High', 'Critical'
$Group — Property in class Group: The products that belong to a product group.
Group::products() — Method in class Group: A product group has many products in it.
Product — Class in namespace WHMCS\Product: A product
$Product — Property in class Product: The id of group a product belongs to.
$Product — Property in class Product: Whether or not a product uses pro rata billing instead of standard month-to-month
$Product — Property in class Product: The day of the month upon which pro rata billing should charge on.
$Product — Property in class Product: The day of the month after which the following month will also be included on the first invoice.
$Product — Property in class Product: A product's payment type, either "recurring", "onetime", or "free".
$Product — Property in class Product: The group a product belongs to.
$Product — Property in class Product: A product's associated downloadable files.
Product::productGroup() — Method in class Product: A product belongs to a product group.
Product::productDownloads() — Method in class Product: A product has many downloads.
$Addon — Property in class Addon: English language internal name for the gateway used to originally purchase this service.
$Service — Property in class Service: ID of package purchased in the order for this service.
$Service — Property in class Service: English language internal name for the gateway used to originally purchase this service.
$Service — Property in class Service: Password associated with this service.
$Service — Property in class Service: ID of promotion used when purchasing this service, or null otherwise.
$Service — Property in class Service: Product associated with this service.
Service::product() — Method in class Service: Each service is an instance of a product.
$Admin — Property in class Admin: An admin's stored password hash.
$Client — Property in class Client: The post or zip code a client resides in.
$Client — Property in class Client: A client's phone number.
$Client — Property in class Client: A client's stored password hash.
$Client — Property in class Client: A client's payment gateway token, if required by the payment gateway.
$Client — Property in class Client: The auto-generated key from a client's last password reset attempt.
$Client — Property in class Client: The date that a client's most recent password reset key was generated.
$Affiliate — Property in class Affiliate: Either the percentage or fixed amount paid to an affiliate based on the commission type.
$Contact — Property in class Contact: The post or zip code a client contact resides in.
$Contact — Property in class Contact: A client contact's phone number.
$Contact — Property in class Contact: A client contact's stored password hash.
$Contact — Property in class Contact: The permissions associated with a client contact.
$Contact — Property in class Contact: The auto-generated key from a client contact's last password reset attempt.
$Contact — Property in class Contact: The date that a client contact's most recent password reset key was generated.

Q

Quote — Class in namespace WHMCS\Billing: A quote for client services.
$Item — Property in class Item: ID of quote this line item belongs to.
$Item — Property in class Item: Quantity of this line item.
$Item — Property in class Item: Quote object to which this line item belongs.
Item::quote() — Method in class Item: Each quote item belongs to a quote.
$Product — Property in class Product: A product's currently available quantity, if stock control is enabled.
$Client — Property in class Client: The quotes assigned to a client.
Client::quotes() — Method in class Client: A client can have many quotes for services.
$SecurityQuestion — Property in class SecurityQuestion: A security question's contents.

R

$Item — Property in class Item: The related id of the corresponding entity type.
$Transaction — Property in class Transaction: Refund ID which is reflected in this invoice.
$CustomField — Property in class CustomField: The related id of the custom field type
$CustomField — Property in class CustomField: The Regular Expression Validation String
$CustomField — Property in class CustomField: Is the field required
$Domain — Property in class Domain: Date this domain was registered.
$Domain — Property in class Domain: Recurring payment amount assigned to this domain name purchase.
$Domain — Property in class Domain: Internal name of registrar module used to register this domain.
$Domain — Property in class Domain: Purchased registration period, in years.
$Domain — Property in class Domain: Pipe delimited string of Email IDs.
$Product — Property in class Product: The number of billing cycles a product may automatically renew.
AbstractTask::run() — Method in class AbstractTask: Execute the task
$Addon — Property in class Addon: Recurring fee scheduled for this addon.
$Addon — Property in class Addon: Date when this addon was purchased.
$CancellationRequest — Property in class CancellationRequest: A customer provided reason for the cancellation.
$Service — Property in class Service: Date this service was purchased.
$Admin — Property in class Admin: ID number of this admin's role. (Role based permissions)
$Admin — Property in class Admin: Whether or not an admin receives an email on new support ticket or support ticket reply creation.
$Contact — Property in class Contact: Whether or not a client contact receives domain related emails.
$Contact — Property in class Contact: Whether or not a client contact receives unrelated to specific systems.
$Contact — Property in class Contact: Whether or not a client contact receives invoice related emails.
$Contact — Property in class Contact: Whether or not a client contact receives product related emails.
$Contact — Property in class Contact: Whether or not a client contact receives support related emails.
$Contact — Property in class Contact: Whether or not a client contact receives emails from the client affiliate system.
Item::removeChild() — Method in class Item: Remove a menu item's child item.

S

$Invoice — Property in class Invoice: Total of all items in this invoice.
$Invoice — Property in class Invoice: English language internal name of the status of this invoice from this set: 'Paid', 'Unpaid', 'Cancelled', and 'Refunded'
Invoice::scopeUnpaid() — Method in class Invoice: Where status is unpaid.
Invoice::scopeOverdue() — Method in class Invoice: Where status is overdue.
Invoice::scopePaid() — Method in class Invoice: Where status is paid.
Invoice::scopeCancelled() — Method in class Invoice: Where status is cancelled.
Invoice::scopeRefunded() — Method in class Invoice: Where status is refunded.
Invoice::scopeCollections() — Method in class Invoice: Where status is collections.
Invoice::scopeMassPay() — Method in class Invoice: Where the invoice does not contain a line item that is of type "Invoice".
$Quote — Property in class Quote: Subject line provided by the admin for this quote.
$Quote — Property in class Quote: English language internal name of this quote's status, from this set: 'Draft', 'Delivered', 'Accepted', 'Lost', 'Dead'
$Quote — Property in class Quote: State of the prospective client requesting the quote.
$Quote — Property in class Quote: Subtotal of this quote.
Setting — Class in namespace WHMCS\Config: An individual setting stored in the tblconfiguration table.
$Setting — Property in class Setting
Setting::scopeUpdater() — Method in class Setting: Retrieve all updater settings.
Setting::setValue() — Method in class Setting: Set a configuration value.
$CustomField — Property in class CustomField: Should the field show in the orderForm
$CustomField — Property in class CustomField: Should the field show on the invoice
$CustomField — Property in class CustomField: The order the field should be displayed
CustomField::scopeClientFields() — Method in class CustomField: Obtain all the client custom fields
CustomField::scopeProductFields() — Method in class CustomField: Obtain all the product custom fields for a specific product.
CustomField::scopeSupportFields() — Method in class CustomField: Obtain all the support custom fields for a specific support department.
$Domain — Property in class Domain: See note above about the subscriptionId field
$Domain — Property in class Domain: English language internal name of the status of this domain registration from this set: 'Pending', 'Pending Transfer', 'Active', 'Expired', 'Cancelled', 'Fraud'
Domain::setRemindersAttribute() — Method in class Domain: Enforce business logic around domain reminders.
Domain::scopeNextDueBefore() — Method in class Domain: Retrieve domains due before a given date.
Download::scopeTopDownloads() — Method in class Download: Look for "top" downloads.
$Template — Property in class Template: Subject line that will be set in the outgoing email that uses this template.
Template::scopeMaster() — Method in class Template: Retrieve "master" mail templates.
$NetworkIssue — Property in class NetworkIssue: The date upon which the effects of this network issue began, or will begin.
$NetworkIssue — Property in class NetworkIssue: An English language internal name of the current state of this network issue from this set: 'Reported', 'Investigating', 'In Progress', 'Outage', 'Scheduled'
$Product — Property in class Product
$Product — Property in class Product: Whether or not the shopping cart should require a domain be purchased, transferred, or supplied (if already owned) to a product.
$Product — Property in class Product: Whether or not a product has limited stock which must be monitored.
$Product — Property in class Product: The id number of server group a product should be provisioned to.
$Product — Property in class Product: The services provisioned from a product.
Product::services() — Method in class Product: A product can have many service instances of that product.
$Addon — Property in class Addon: ID of service which this addon is attached to.
$Addon — Property in class Addon: Setup fee paid for this addon.
$Addon — Property in class Addon: English language internal name of status of this service, from this set: 'Pending', 'Active', 'Suspended', 'Terminated', 'Cancelled', 'Fraud' (Additionally custom status may exist)
$Addon — Property in class Addon
Addon::service() — Method in class Addon: Each addon belongs to one service.
$CancellationRequest — Property in class CancellationRequest: Unique ID number of the service the client is requesting cancelled.
$CancellationRequest — Property in class CancellationRequest
CancellationRequest::service() — Method in class CancellationRequest: Each cancellation request belongs to one service.
Service — Class in namespace WHMCS\Service: A client-owned service.
$Service — Property in class Service: ID of server this service has been provisioned to.
$Service — Property in class Service: If the service is a recurring service, and a payment gateway which supports subscriptions have been used (such as PayPal), the subscription ID for the payment gateway is stored here.
$Service — Property in class Service: An admin provided string as to why a suspension was enacted on this service.
$Admin — Property in class Admin: A message displayed at the bottom of an admin's support ticket responses.
$Admin — Property in class Admin: The id numbers of the support departments an admin is assigned to.
$Alert — Property in class Alert: An alert's severity.
Alert::setMessage() — Method in class Alert: Set an alert's message.
Alert::setSeverity() — Method in class Alert: Set an alert's severity.
Alert::setLink() — Method in class Alert: Set an optional link target to provide along with an alert.
Alert::setLinkText() — Method in class Alert: Set an optional link text to provide along with an alert.
$Client — Property in class Client: The state or province a client resides in.
$Client — Property in class Client: Whether or not a client should receive separate invoices for their purchased services.
$Client — Property in class Client: The id number of a client's configured security question.
$Client — Property in class Client: The encrypted answer to a client's configured security question.
$Client — Property in class Client: The encrypted name of a client's bank.
$Client — Property in class Client: A client's encrypted bank type.
$Client — Property in class Client: A client's encrypted bank code.
$Client — Property in class Client: A client's encrypted bank account number.
$Client — Property in class Client: A client's status, either "Active", "Inactive", or "Closed".
$Client — Property in class Client: The services a client has purchased.
$Client — Property in class Client: The security question a client has chosen for authentication.
Client::services() — Method in class Client: A client can have many services.
Client::securityQuestion() — Method in class Client: A client can have an associated security question.
Client::setSecurityQuestionAnswerAttribute() — Method in class Client: Encrypt security question answers for storage.
Client::sendEmailAddressVerification() — Method in class Client: Sends the email address verification email to the client.
$Contact — Property in class Contact: The state or province a client contact resides in.
SecurityQuestion — Class in namespace WHMCS\User\Client: A user's security question.
SecurityQuestion::setQuestionAttribute() — Method in class SecurityQuestion: Encrypt security questions for storage.
Item::setName() — Method in class Item: Set a menu item's name.
Item::setUri() — Method in class Item: Set a menu item's link target.
Item::setLabel() — Method in class Item: Set a menu item's label.
Item::setChildren() — Method in class Item: Set a menu item's child items.
Item::setBadge() — Method in class Item: Set a menu item's badge.
Item::setOrder() — Method in class Item: Set a menu item's sort order.
Item::setClass() — Method in class Item: Set a menu item's css class definitions.
Item::setExtras() — Method in class Item: Set a menu item's extras.
Item::setExtra() — Method in class Item: Set a menu item extra.
Item::setIcon() — Method in class Item: Set the icon displayed next to a menu item.
Item::setBodyHtml() — Method in class Item: Set a menu item's body HTML content.
Item::setFooterHtml() — Method in class Item: Set a menu item's footer HTML content.
Item::setHeadingHtml() — Method in class Item: Set a menu item's heading HTML content.
Item::sort() — Method in class Item: Sort a menu item's children by their sort order then alphabetically by name.
Item::swapOrder() — Method in class Item: Swap the order of the current menu item with another menu item's order.

T

$Announcement — Property in class Announcement
$Announcement — Property in class Announcement: Title to display for the announcement.
$Announcement — Property in class Announcement: If this announcement has translations provided, this is an array of those Announcement objects.
Announcement::translations() — Method in class Announcement: An announcement may be a parent of many child announcements.
$Invoice — Property in class Invoice
$Invoice — Property in class Invoice
$Invoice — Property in class Invoice: Amount of tax due, based on lowest ID number "Level 1" Tax Rule applied to this invoice.
$Invoice — Property in class Invoice: Amount of tax due, based on lowest ID number "Level 2" Tax Rule applied to this invoice. Level 2 Rules may or may not be calculated as compound tax.
$Invoice — Property in class Invoice: Total due on this invoice. Subtotal - Credit + Tax1 + Tax 2. Use this total instead of calculating your own as Level 2 taxes may or may not be compounded.
$Invoice — Property in class Invoice: Level 1 Tax rate applied to this invoice.
$Invoice — Property in class Invoice: Level 2 Tax rate applied to this invoice.
Invoice::transactions() — Method in class Invoice: Each invoice can have many transactions.
$Item — Property in class Item
$Item — Property in class Item
$Item — Property in class Item: The type of item to which this invoice line item relates. Empty for no relationship.
$Item — Property in class Item: True, if this items is taxable, otherwise false.
Transaction — Class in namespace WHMCS\Billing\Payment: A payment transaction.
$Transaction — Property in class Transaction
$Transaction — Property in class Transaction
$Transaction — Property in class Transaction: Descriptive name for this transaction. Not to be confused with the transaction's Unique ID number. Null if not set.
$Quote — Property in class Quote
$Quote — Property in class Quote
$Quote — Property in class Quote: Amount of tax due, based on lowest ID number "Level 1" Tax Rule applied to this quote.
$Quote — Property in class Quote: Amount of tax due, based on lowest ID number "Level 2" Tax Rule applied to this quote. Level 2 Rules may or may not be calculated as compound tax.
$Quote — Property in class Quote: Subtotal + Tax1 + Tax2. Use this total instead of calculating your own as Level 2 taxes may or may not be compounded.
$Item — Property in class Item
$Setting — Property in class Setting
$CustomField — Property in class CustomField
$CustomField — Property in class CustomField: The type of custom field client|product|support
$AdditionalField — Property in class AdditionalField
$Domain — Property in class Domain
$Domain — Property in class Domain: English language internal name of the type of registration used for this domain from this set: 'Register' and 'Transfer'
$Category — Property in class Category
$Download — Property in class Download
$Download — Property in class Download: English internal name used to identify the download's type. One of this set: 'pdf', 'exe', 'zip'.
$Download — Property in class Download: Name the download will be listed as on the client side.
$Download — Property in class Download: This value should be incremented every time the file is downloaded. It is used to identify "Most Popular" downloads.
$Download — Property in class Download
$Download — Property in class Download
Download::translatedNames() — Method in class Download: Return the translated names for the specific download
Download::translatedDescriptions() — Method in class Download: Return the translated names for the specific download
Template — Class in namespace WHMCS\Mail: Functionality related to mail templates.
$Template — Property in class Template
$Template — Property in class Template: English language internal name describing email type, from this set: 'general', 'product', 'support', 'invoice'
$NetworkIssue — Property in class NetworkIssue
$NetworkIssue — Property in class NetworkIssue: The title which should be displayed to clients on the Network Issues page.
$Group — Property in class Group
$Group — Property in class Group: A product group's tagline.
$Group — Property in class Group
$Group — Property in class Group
$Group — Property in class Group
Group::translatedNames() — Method in class Group: Return the translated names for the specific product
Group::translatedHeadlines() — Method in class Group: Return the translated headlines for the specific product
Group::translatedTaglines() — Method in class Group: Return the translated taglines for the specific product
$Product — Property in class Product
$Product — Property in class Product: A product's type, either "hostingaccount", "reselleraccount", "server", or "other".
$Product — Property in class Product
$Product — Property in class Product
Product::translatedNames() — Method in class Product: Return the translated names for the specific product
Product::translatedDescriptions() — Method in class Product: Return the translated names for the specific product
AbstractTask::toArray() — Method in class AbstractTask
$Addon — Property in class Addon
$Addon — Property in class Addon: The date the addon was Terminated or Cancelled.
$CancellationRequest — Property in class CancellationRequest
$Service — Property in class Service
$Service — Property in class Service: Date the service was Terminated or Cancelled.
$Admin — Property in class Admin
$Admin — Property in class Admin
$Admin — Property in class Admin: The name of an admin's two factor authentication module, if they are using one.
$Admin — Property in class Admin: An admin's two-factor authentication module's internal data, stored as a PHP serialized string.
$Admin — Property in class Admin: The name of the admin area view template WHMCS renders for an admin.
$Client — Property in class Client
$Client — Property in class Client
$Client — Property in class Client: The name of a client's two factor authentication module, if they are using one.
$Client — Property in class Client: A client's two-factor authentication module's internal data, stored as a PHP serialized string.
$Client — Property in class Client: Whether or not a client is exempt from paying taxes.
$Client — Property in class Client
Client::transactions() — Method in class Client: A client can have many transactions.
$Affiliate — Property in class Affiliate
$Contact — Property in class Contact
$SecurityQuestion — Property in class SecurityQuestion

U

$Announcement — Property in class Announcement: Date this announcement was last updated.
$Item — Property in class Item: UserID of the invoice this line item belongs to.
$Item — Property in class Item: Individual unit price of this line item.
$Item — Property in class Item: Last date this line item was edited.
$Setting — Property in class Setting: 'setting' is a unique column.
$CustomField — Property in class CustomField: The date a custom field was last modified.
$AdditionalField — Property in class AdditionalField: Last date this additional field was edited.
$Domain — Property in class Domain: Date this domain was last edited.
$Category — Property in class Category: The date this category was first updated.
$Download — Property in class Download: The date this download was last updated.
$Template — Property in class Template
$Template — Property in class Template
$NetworkIssue — Property in class NetworkIssue: Same as lastUpdateDate.
$Group — Property in class Group: The date a product group was last modified.
$Product — Property in class Product: The id of the email to send to a client when a product's options are upgraded.
$Product — Property in class Product: The date a product was last updated.
$Product — Property in class Product: The email to send to a client when a product's options are upgraded.
$Product — Property in class Product: Products which a product can be upgraded or downgraded to.
Product::upgradeEmailTemplate() — Method in class Product: A product has one upgrade email template.
Product::upgradeProducts() — Method in class Product: A product has many upgrade packages.
$Addon — Property in class Addon: The date this addon was last updated.
$CancellationRequest — Property in class CancellationRequest: Timestamp of when this cancellation request was last modified.
$Service — Property in class Service: Username associated with this service (for external control panels, etc)
$Service — Property in class Service: Date this service was last modified.
$Admin — Property in class Admin
$Admin — Property in class Admin: An admin's username.
$Client — Property in class Client
$Client — Property in class Client: A client's username (email).
$Client — Property in class Client: Last update of the client data (or 0000-00-00 00:00:00 if no updated since 6.0.0).
Client::updateLastLogin() — Method in class Client
$Affiliate — Property in class Affiliate: The date an affiliate record was last modified.
$Contact — Property in class Contact: The date a client contact was last updated.
Contact::updateLastLogin() — Method in class Contact
$SecurityQuestion — Property in class SecurityQuestion: The date a security question was last updated.

V

$Quote — Property in class Quote: Date upon which this quote is no longer valid.
$Setting — Property in class Setting
$AdditionalField — Property in class AdditionalField: Value of this additional field.
$Affiliate — Property in class Affiliate: The number of visitors who have followed affiliate links belonging to an affiliate account.

W

$Product — Property in class Product: ID number of welcome email template sent to customers when this product is activated.
$Product — Property in class Product: The email to send to a client when a product is ordered.
Product::welcomeEmailTemplate() — Method in class Product: A product has one welcome email template.
$CancellationRequest — Property in class CancellationRequest: English language internal name specifying when the cancellation should take place from this set: 'Immediately', 'End of Billing Cycle'

_

Template::__toString() — Method in class Template: Represent a mail template by its name.
AbstractTask::__construct() — Method in class AbstractTask: Create a new event instance.
Alert::__construct() — Method in class Alert: Build a new user alert.