# API: Add queue item

# addInvoiceQueueItem

Add new line/item to queue invoice

# Required parameters

Parameter Description
client_id Client ID
id Account ID
queueitem[description] Description of new queue item
queueitem[amount] Price
queueitem[qty] Item QTY, default:1
queueitem[taxed] Indicates whether item is taxed (1) or not (0)
queueitem[note] Note for new queue item

# Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=addInvoiceQueueItem&client_id=CLIENT_ID&id=ID&queueitem%5Bdescription%5D=QUEUEITEM%5BDESCRIPTION%5D&queueitem%5Bamount%5D=QUEUEITEM%5BAMOUNT%5D&queueitem%5Bqty%5D=QUEUEITEM%5BQTY%5D&queueitem%5Btaxed%5D=QUEUEITEM%5BTAXED%5D&queueitem%5Bnote%5D=QUEUEITEM%5BNOTE%5D

# PHP Samples

$url = 'http://url_to_hb.com/admin/api.php';
$post = [
  'call' => 'addInvoiceQueueItem',
  'api_id' => $API_ID,
  'api_key' => $API_KEY,
  'client_id' => $CLIENT_ID,
  'id' => $ID,
  'queueitem[description]' => $QUEUEITEM[DESCRIPTION],
  'queueitem[amount]' => $QUEUEITEM[AMOUNT],
  'queueitem[qty]' => $QUEUEITEM[QTY],
  'queueitem[taxed]' => $QUEUEITEM[TAXED],
  'queueitem[note]' => $QUEUEITEM[NOTE],
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
$data = curl_exec($ch);
curl_close($ch);

$return = json_decode($data, true);
print_r($return);
include 'class.hbwrapper.php';
HBWrapper::setAPI('http://url_to_hb.com/admin/api.php','API ID','API Key');
$params = [
  'client_id' => $CLIENT_ID,
  'id' => $ID,
  'queueitem[description]' => $QUEUEITEM[DESCRIPTION],
  'queueitem[amount]' => $QUEUEITEM[AMOUNT],
  'queueitem[qty]' => $QUEUEITEM[QTY],
  'queueitem[taxed]' => $QUEUEITEM[TAXED],
  'queueitem[note]' => $QUEUEITEM[NOTE],
];
$return = HBWrapper::singleton()->addInvoiceQueueItem($params);
print_r($return);
/* Use this method to access HostBill api from HostBill modules */
$api = new ApiWrapper();
$params = [
  'client_id' => $CLIENT_ID,
  'id' => $ID,
  'queueitem[description]' => $QUEUEITEM[DESCRIPTION],
  'queueitem[amount]' => $QUEUEITEM[AMOUNT],
  'queueitem[qty]' => $QUEUEITEM[QTY],
  'queueitem[taxed]' => $QUEUEITEM[TAXED],
  'queueitem[note]' => $QUEUEITEM[NOTE],
];
$return = $api->addInvoiceQueueItem($params);
print_r($return);

# Response

{
    "success": true,
    "invoicequeue": [
        {
            "id": "22",
            "client_id": "1",
            "rel_id": "129",
            "rel_type": "Hosting",
            "item_id": "129",
            "type": "Hosting",
            "description": "test",
            "note": "test2",
            "amount": "200.00",
            "taxed": "0",
            "qty": "1.00",
            "status": "Pending",
            "total": "200.0000"
        }
    ],
    "call": "addInvoiceQueueItem",
    "server_time": 1534758315
}
Last Updated: 10/7/2024, 2:36:43 PM