Retrieve a specific invoice

Request Parameters

Parameter Type Description Required
action string “GetInvoice” Required
invoiceid int The ID of the invoice to retrieve Required

Response Parameters

Parameter Type Description
result string The result of the operation: success or error
invoiceid int The id of the invoice
invoicenum string The Sequential Invoice Number assigned (if enabled)
userid int The id of the user owning this invoice
date \Carbon\Carbon The date of the invoice YYYY-MM-DD
duedate \Carbon\Carbon The due date of the invoice YYYY-MM-DD
datepaid \Carbon\Carbon The date the invoice was paid YYYY-MM-DD HH:ii:ss
subtotal float The subtotal on the invoice
credit float The amount of credit assigned to the invoice
tax float The amount of first level tax charged on the invoice
tax2 float The amount of second level tax charged on the invoice
total float The total of the invoice
balance float The amount left to pay on the invoice
taxrate float The rate of the first level tax
taxrate2 float The rate of the second level tax
status string The status of the invoice
paymentmethod string The payment method on the invoice in system format
notes string The notes associated with the invoice
ccgateway bool Is the payment method associated with the invoice a CC Gateway
items array The items on the invoice
transactions array The transactions on the invoice

Example Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, '');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
            'action' => 'GetInvoice',
            // See
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'invoiceid' => '1',
            'responsetype' => 'json',
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);

Example Request (Local API)

$command = 'GetInvoice';
$postData = array(
    'invoiceid' => '1',
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);

Example Response JSON

    "result": "success",
    "invoiceid": "1",
    "invoicenum": "",
    "userid": "2361",
    "date": "2016-01-01",
    "duedate": "2016-01-08",
    "datepaid": "0000-00-00 00:00:00",
    "subtotal": "15.95",
    "credit": "0.00",
    "tax": "0.00",
    "tax2": "0.00",
    "total": "15.95",
    "balance": "15.95",
    "taxrate": "0.00",
    "taxrate2": "0.00",
    "status": "Unpaid",
    "paymentmethod": "paypal",
    "notes": "",
    "ccgateway": "",
    "items[item][0][id]": "1",
    "items[item][0][type]": "Hosting",
    "items[item][0][relid]": "1",
    "items[item][0][description]": "Sample Monthly Product (01\/01\/2016 - 31\/01\/2016)",
    "items[item][0][amount]": "15.95",
    "items[item][0][taxed]": "0",
    "transactions": ""

Error Responses

Possible error condition responses include:

  • Invoice ID Not Found

Version History

Version Changelog
1.0 Initial Version