Invoices and Quotes

The following hooks are provided for Invoices and Quotes related events.

Executes when a client is accepting a quote.

No response supported

<?php
add_hook('AcceptQuote', 1, function($vars) {
    // Perform hook code here...
});

Executes when a late fee has been added to an invoice

No response supported

<?php
add_hook('AddInvoiceLateFee', 1, function($vars) {
    // Perform hook code here...
});

Invoked when a payment is applied to an invoice (including partial payments).

No response supported

<?php
add_hook('AddInvoicePayment', 1, function($vars) {
    // Perform hook code here...
});

Executes when a transaction is created. Can be a payment or a refund.

No response supported

<?php
add_hook('AddTransaction', 1, function($vars) {
    // Perform hook code here...
});

Executes after invoice generation allowing for after invoicing clean-up.

No response supported

<?php
add_hook('AfterInvoicingGenerateInvoiceItems', 1, function($vars) {
    // Perform hook code here...
});

Runs when an order is requested to be cancelled and refunded, prior to the change of status actually occurring.

No response supported

<?php
add_hook('CancelAndRefundOrder', 1, function($vars) {
    // Perform hook code here...
});

Executes when an invoice is being cancelled

No response supported

<?php
add_hook('InvoiceCancelled', 1, function($vars) {
    // Perform hook code here...
});

Executes when changing the gateway on an invoice.

No response supported

<?php
add_hook('InvoiceChangeGateway', 1, function($vars) {
    // Perform hook code here...
});

Executed when an invoice has left "Draft" status and is available to its respective client. Execution of this hook occurs after sending the Invoice Created email.

No response supported

<?php
add_hook('InvoiceCreated', 1, function($vars) {
    // Perform hook code here...
});

Executes when an invoice is first created. The invoice has not been finalised and delivered to the client at this point. Changes can be made to line items at this point. The invoice totals will be recalculated post execution of this hook point.

No response supported

<?php
add_hook('InvoiceCreation', 1, function($vars) {
    // Perform hook code here...
});

Executes as an invoice is being created in the admin area before the email is being sent

No response supported

<?php
add_hook('InvoiceCreationPreEmail', 1, function($vars) {
    // Perform hook code here...
});

Executes when an invoice is Paid following the email receipt having been sent and any automation tasks associated with the payment action having been run.

No response supported

<?php
add_hook('InvoicePaid', 1, function($vars) {
    // Perform hook code here...
});

Executes when an invoice is Paid prior to any email or automation tasks associated with the payment action having been run.

No response supported

<?php
add_hook('InvoicePaidPreEmail', 1, function($vars) {
    // Perform hook code here...
});

Executes when an automated invoice payment reminder is sent.

No response supported

<?php
add_hook('InvoicePaymentReminder', 1, function($vars) {
    // Perform hook code here...
});

Executes when an invoice status is changed to Refunded.

No response supported

<?php
add_hook('InvoiceRefunded', 1, function($vars) {
    // Perform hook code here...
});

Executes as an invoice is being split

No response supported

<?php
add_hook('InvoiceSplit', 1, function($vars) {
    // Perform hook code here...
});

Executes when an invoice is being marked as Unpaid

No response supported

<?php
add_hook('InvoiceUnpaid', 1, function($vars) {
    // Perform hook code here...
});

Runs any time a payment gateway callback is received and logged.

No response supported

<?php
add_hook('LogTransaction', 1, function($vars) {
    // Perform hook code here...
});

Executes when an invoice is refunded via the Manual Refund option.

No response supported

<?php
add_hook('ManualRefund', 1, function($vars) {
    // Perform hook code here...
});

Executes prior to an invoice being automatically cancelled. Allows the action to be aborted.

Accepts a return of key/value pairs. Return abortCancel=true to abort the automatic cancellation.

<?php
add_hook('PreInvoiceAutomaticCancellation', 1, function($vars) {
    // Perform hook code here...
});

Executes prior to invoice generation to allow for manipulation of stored data prior to aggregation of due items.

No response supported

<?php

use WHMCS\Service\Service;

/**
 * Prevent invoicing of any new services added to clientID 5
 */

add_hook('PreInvoicingGenerateInvoiceItems', 1, function() {
    $services = Service::where('userid', 5)
        ->where('billingcycle', '!=', 'Free Account')
        ->get();

    foreach ($services as $service) {
        $service->billingcycle = 'Free Account';
        $service->save();
    }
});

Executes when a quote is created.

No response supported

<?php
add_hook('QuoteCreated', 1, function($vars) {
    // Perform hook code here...
});

Executes when a quote status is updated

No response supported

<?php
add_hook('QuoteStatusChange', 1, function($vars) {
    // Perform hook code here...
});

Executes when an invoice is updated with changes to or additions of line items. Can be used to manipulate the invoice.

No response supported

<?php
add_hook('UpdateInvoiceTotal', 1, function($vars) {
    // Perform hook code here...
});

Executes as the invoice is being viewed as a client

No response supported

<?php
add_hook('ViewInvoiceDetailsPage', 1, function($vars) {
    // Perform hook code here...
});