Get invoices

Get your invoices list

Endpoint

Method	URI
POST	https://apiv2.keliweb.it/api/v2/keliweb/get-invoices

Request Parameters

Parameter	Type	Description	Required
HTTP headers: Authorization	string	Bearer + the token to access APIs	Required
limitstart	integer	The offset for the returned invoice data (default: 0)	Optional
limitnum	integer	The number of records to return (default: 25)	Optional
status	string	Find invoices for a specific status. Standard Invoice statuses plus Overdue	Optional
orderby	string	The field to sort results by. Accepted values are: id, invoicenumber, date, duedate, total, status	Optional
order	string	Order sort attribute. Accepted values are: asc or desc.	Optional

Response Parameters

Parameter	Type	Description
result	string	The result of the operation: success or error
totalresults	integer	The total number of results available
startnumber	integer	The starting number for the returned results
numreturned	integer	The number of results returned
invoices	array	An array of invoices matching the criteria passed

Example Request (PHP Curl)

            

                    $curl = curl_init();
                    
                    curl_setopt_array($curl, array(
                      CURLOPT_URL => "https://apiv2.keliweb.it/api/v2/keliweb/get-invoices",
                      CURLOPT_RETURNTRANSFER => true,
                      CURLOPT_ENCODING => "",
                      CURLOPT_MAXREDIRS => 10,
                      CURLOPT_TIMEOUT => 0,
                      CURLOPT_FOLLOWLOCATION => false,
                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                      CURLOPT_CUSTOMREQUEST => "POST",
                      CURLOPT_POSTFIELDS =>
                        http_build_query(
                                array(
                                    'userid'  => '1',
                                    'orderby' => 'invoicenumber'
                                )
                            ),
                      CURLOPT_HTTPHEADER => array(
                        "Content-Type: multipart/form-data",
                        "X-Requested-With: XMLHttpRequest",
                        "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NhMmNlNkNjNhMmU2MmUxIzZDRkODY5MS1mMDMzLTQ1MWMtYjU-3EHc",
                      ),
                    ));
                    
                    $response = curl_exec($curl);
                    $err = curl_error($curl);
                    
                    curl_close($curl);
                    
                    if ($err) {
                      echo "cURL Error #:" . $err;
                    } else {
                      echo $response;
                    }

            
        

Example Request (jQuery AJAX)

            
                    var form = new FormData();
                    form.append("userid", "1");
                    form.append("orderby", "invoicenumber");

                    var settings = {
                        "async": true,
                        "crossDomain": true,
                        "url": "https://apiv2.keliweb.it/api/v2/keliweb/get-invoices",
                        "method": "POST",
                        "headers": {
                            "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImNjMDEwYWVlYmUzMjMxMmZlZjBiNzRjYTBhMmNlNDc2MjNjNhMMTA1MzJjODk1In0",
                            "cache-control": "no-cache",
                        },
                        "processData": false,
                        "contentType": false,
                        "mimeType": "multipart/form-data",
                        "data": form
                    }

                    $.ajax(settings).done(function (response) {
                        console.log(response);
                    });
            
        

Example Response (JSON payload)

            
                    {
                        "result"                              : "success",
                        "totalresults"                        : "1",
                        "startnumber"                         : "0",
                        "numreturned"                         : "1",
                        "invoices[invoice][0][id]"            : "1",
                        "invoices[invoice][0][userid]"        : "1",
                        "invoices[invoice][0][firstname]"     : "Test",
                        "invoices[invoice][0][lastname]"      : "Client",
                        "invoices[invoice][0][companyname]"   : "",
                        "invoices[invoice][0][invoicenum]"    : "",
                        "invoices[invoice][0][date]"          : "2016-01-01",
                        "invoices[invoice][0][duedate]"       : "2016-01-08",
                        "invoices[invoice][0][datepaid]"      : "0000-00-00 00:00:00",
                        "invoices[invoice][0][subtotal]"      : "15.95",
                        "invoices[invoice][0][credit]"        : "0.00",
                        "invoices[invoice][0][tax]"           : "0.00",
                        "invoices[invoice][0][tax2]"          : "0.00",
                        "invoices[invoice][0][total]"         : "15.95",
                        "invoices[invoice][0][taxrate]"       : "0.00",
                        "invoices[invoice][0][taxrate2]"      : "0.00",
                        "invoices[invoice][0][status]"        : "Unpaid",
                        "invoices[invoice][0][paymentmethod]" : "authorize",
                        "invoices[invoice][0][notes]"         : "",
                        "invoices[invoice][0][currencycode]"  : "USD",
                        "invoices[invoice][0][currencyprefix]": "$",
                        "invoices[invoice][0][currencysuffix]": "USD"
                    }