List Invoice

The List Invoice API to allows you to list the invoices of the user generated by the admin. The API response contains the list of the invoice details, which are listed according to their IDs. To filter or limit the size of the list, you can specify one or more query parameters.

HTTP Request

https://hostname:4085/index.php?act=invoices

Parameters

NameMethodValueDescriptionRequired
actGETinvoicesThe action will list all the invoicesYes
pageGETIntIf not specified, then only first 50 records are returnedNo
reslenGETIntNumber of records to be returned, default is 50No
invoidPOSTIntFilter list using the invoice IDNo
uidPOSTIntFilter the list using the user IDNo
itemPOSTtextFilter the list using the item nameNo
paydatePOSTtextFilter the list using the paydate in the format YYYY/MM/DDNo
invodatePOSTtextFilter the list using the invoice date in the format YYYY/MM/DDNo
duedatePOSTtextFilter the list using the due date in the format YYYY/MM/DDNo

Sample Code

<?php

    require_once('/usr/local/virtualizor/sdk/admin.php');

    $key =  'your_api_key';
    $pass = 'your_api_pass';
    $ip = 'your_server_ip';

    $admin = new Virtualizor_Admin_API($ip, $key, $pass);

    $page = 1;
    $reslen = 20;
    $post = array();
    $post['invoid'] = '';
    $post['uid'] = '';
    $post['item'] = '';
    $post['paydate'] = '';
    $post['invodate'] = '';
    $post['duedate'] = '';

    $output = $admin->listinvoices($page, $reslen, $post);

    print_r(json_encode($output));
?>

Output

{
    "title": "Invoices",
    "invoices": {
        "3": {
            "invoid": "3",
            "invonum": "3",
            "invodate": "19950118",
            "invotime": "790387200",
            "duedate": "19990118",
            "uid": "57",
            "paydate": "0",
            "paytime": "0",
            "item": "xyxsss",
            "additional_desc": null,
            "item_desc": "",
            "amt": "1005550.00",
            "disc": "0.00",
            "additional_disc": "0.00",
            "net": "1005550.00",
            "token": "",
            "cancelled": "0",
            "email": "samplemail@gmail.com",
            "status": "unpaid",
            "status_txt": null
        }
    },
    "timenow": 1537272991,
    "time_taken": "0.215"
}
Was this helpful to you?