API: Add queue item

addInvoiceQueueItem

Add new line/item to queue invoice. If billondate = 0 – item will be added to the nearest invoice related to the given account (id). If billondate = 1 – item will be scheduled for invoicing on a specific date (billdate). On that day, cron will generate a new invoice or merge the item with the invoice created for the client.

Required parameters

Parameter	Description
client_id	Client 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

Optional parameters

Parameter	Description
id	Related account ID. Required if billondate is not set
queueitem[billondate]	Set 1 to schedule invoice item for specific date (billdate must be provided). Set 0 for account-related invoicing
queueitem[billdate]	Date (YYYY-MM-DD) on which invoice should be generated if billondate is set to 1. Ignored otherwise.

Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=addInvoiceQueueItem&client_id=CLIENT_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

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
}