JavaScript

Quickbooks Delete an Invoice

See more QuickBooks Examples

Demonstrates how to delete an invoice using the Quickbooks REST API. JavaScript

var success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// First get our previously obtained OAuth2 access token.
var jsonToken = new CkJsonObject();
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json");

var rest = new CkRest();

// Connect to the REST server.
var bTls = true;
var port = 443;
var bAutoReconnect = true;
success = rest.Connect("sandbox-quickbooks.api.intuit.com",port,bTls,bAutoReconnect);

var sbAuth = new CkStringBuilder();
sbAuth.Append("Bearer ");
sbAuth.Append(jsonToken.StringOf("access_token"));
rest.Authorization = sbAuth.GetAsString();

// --------------------------------------------------------------------------
// Note: The above code to setup the initial REST connection
// can be done once.  After connecting, any number of REST calls can be made.
// If the connection is lost, the next REST method call will automatically
// reconnect if needed.
// --------------------------------------------------------------------------

// Create the following JSON:

// {
//   "SyncToken": "3",
//   "Id": "33"
// }
// 
// Use the this online tool to generate the code from sample JSON: 
// Generate Code to Create JSON

var jsonReq = new CkJsonObject();
jsonReq.UpdateString("SyncToken","3");
jsonReq.UpdateString("Id","33");

var sbRequestBody = new CkStringBuilder();
jsonReq.EmitSb(sbRequestBody);

rest.AddHeader("Content-Type","application/json");
rest.AddHeader("Accept","application/json");
rest.AllowHeaderFolding = false;

var sbResponseBody = new CkStringBuilder();
success = rest.FullRequestSb("POST","/v3/company/<realmID>/invoice?operation=delete",sbRequestBody,sbResponseBody);
if (success !== true) {
    console.log(rest.LastErrorText);
    return;
}

var respStatusCode = rest.ResponseStatusCode;

// Success is indicated by a 200 response status code.
console.log("response status code = " + respStatusCode);

var jsonResponse = new CkJsonObject();
jsonResponse.LoadSb(sbResponseBody);
jsonResponse.EmitCompact = false;
console.log(jsonResponse.Emit());

if (rest.ResponseStatusCode !== 200) {
    console.log("Failed.");
    return;
}

// Sample output...
// (See the parsing code below..)
// 
// Use the this online tool to generate parsing code from sample JSON: 
// Generate Parsing Code from JSON

// {
//   "Invoice": {
//     "status": "Deleted",
//     "domain": "QBO",
//     "Id": "33"
//   },
//   "time": "2013-03-15T00:18:15.322-07:00"
// }
// 

var InvoiceStatus = jsonResponse.StringOf("Invoice.status");
var InvoiceDomain = jsonResponse.StringOf("Invoice.domain");
var InvoiceId = jsonResponse.StringOf("Invoice.Id");
var time = jsonResponse.StringOf("time");