(Node.js) Quickbooks Send an Invoice

Demonstrates how to send an invoice using the Quickbooks REST API.

For more information, see https://www.developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/invoice#send-an-invoice

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // 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 chilkat.JsonObject();
    var success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json");

    var rest = new chilkat.Rest();

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

    var sbAuth = new chilkat.StringBuilder();
    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.
    // --------------------------------------------------------------------------

    // Technically, the POST has an empty request body, but the Quickbooks documentation indicates that 
    // the Content-Type header should be set to "application/octet-stream", which really makes no sense
    // because there is not content. (How can no content have a type???)
    rest.AddHeader("Content-Type","application/octet-stream");
    rest.AllowHeaderFolding = false;

    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestNoBodySb("POST","/v3/company/<realmID>/invoice/<invoiceId>/send?sendTo=<emailAddr>",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 chilkat.JsonObject();
    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": {
    //     "TxnDate": "2013-03-14",
    //     "domain": "QBO",
    //     "CurrencyRef": {
    //       "name": "United States Dollar",
    //       "value": "USD"
    //     },
    //     "ShipDate": "2013-03-01",
    //     "TrackingNum": "123456789",
    //     "ClassRef": {
    //       "name": "Class 1",
    //       "value": "200900000000000003901"
    //     },
    //     "PrintStatus": "NeedToPrint",
    //     "SalesTermRef": {
    //       "value": "4"
    //     },
    //     "DeliveryInfo": {
    //       "DeliveryType": "Email",
    //       "DeliveryTime": "2014-12-17T11:50:52-08:00"
    //     },
    //     "TotalAmt": 52.0,
    //     "Line": [
    //       {
    //         "Description": "Sample invoice create request",
    //         "DetailType": "SalesItemLineDetail",
    //         "SalesItemLineDetail": {
    //           "TaxCodeRef": {
    //             "value": "TAX"
    //           },
    //           "Qty": 1,
    //           "UnitPrice": 50,
    //           "ServiceDate": "2013-03-04",
    //           "ItemRef": {
    //             "name": "Hours",
    //             "value": "2"
    //           }
    //         },
    //         "LineNum": 1,
    //         "Amount": 50.0,
    //         "Id": "1"
    //       },
    //       {
    //         "DetailType": "SubTotalLineDetail",
    //         "Amount": 50.0,
    //         "SubTotalLineDetail": {}
    //       },
    //       {
    //         "DetailType": "DiscountLineDetail",
    //         "Amount": 5.0,
    //         "DiscountLineDetail": {
    //           "DiscountAccountRef": {
    //             "name": "Discounts given",
    //             "value": "30"
    //           },
    //           "PercentBased": true,
    //           "DiscountPercent": 10
    //         }
    //       },
    //       {
    //         "DetailType": "SalesItemLineDetail",
    //         "Amount": 2.0,
    //         "SalesItemLineDetail": {
    //           "ItemRef": {
    //             "value": "SHIPPING_ITEM_ID"
    //           }
    //         }
    //       }
    //     ],
    //     "DueDate": "2013-05-13",
    //     "MetaData": {
    //       "CreateTime": "2013-03-14T01:42:16-07:00",
    //       "LastUpdatedTime": "2014-12-17T11:50:58-08:00"
    //     },
    //     "DocNumber": "Sample_Inv#2",
    //     "PrivateNote": "Summary for sample invoice",
    //     "sparse": false,
    //     "DepositToAccountRef": {
    //       "name": "Undeposited Funds",
    //       "value": "4"
    //     },
    //     "CustomerMemo": {
    //       "value": "This is the customer message"
    //     },
    //     "EmailStatus": "EmailSent",
    //     "Deposit": 12.0,
    //     "Balance": 40.0,
    //     "CustomerRef": {
    //       "name": "Mr V3 Service Customer Jr2",
    //       "value": "15"
    //     },
    //     "TxnTaxDetail": {
    //       "TxnTaxCodeRef": {
    //         "value": "5"
    //       },
    //       "TotalTax": 5.0,
    //       "TaxLine": [
    //         {
    //           "DetailType": "TaxLineDetail",
    //           "Amount": 5.0,
    //           "TaxLineDetail": {
    //             "NetAmountTaxable": 50.0,
    //             "TaxPercent": 10,
    //             "TaxRateRef": {
    //               "value": "2"
    //             },
    //             "PercentBased": true
    //           }
    //         }
    //       ]
    //     },
    //     "SyncToken": "0",
    //     "BillEmail": {
    //       "Address": "test@intuit.com"
    //     },
    //     "ShipAddr": {
    //       "City": "San Jose",
    //       "Country": "USA",
    //       "Line5": "Cube 999",
    //       "Line4": "Dept 12",
    //       "Line3": "123 street",
    //       "Line2": "Building 1",
    //       "Line1": "Intuit",
    //       "PostalCode": "95123",
    //       "Lat": "37.2374847",
    //       "Long": "-121.8277925",
    //       "CountrySubDivisionCode": "CA",
    //       "Id": "36"
    //     },
    //     "DepartmentRef": {
    //       "name": "Mountain View",
    //       "value": "1"
    //     },
    //     "ShipMethodRef": {
    //       "name": "UPS",
    //       "value": "UPS"
    //     },
    //     "BillAddr": {
    //       "City": "Mountain View",
    //       "Country": "USA",
    //       "Line5": "Cube 999",
    //       "Line4": "Dept 12",
    //       "Line3": "123 street",
    //       "Line2": "Building 1",
    //       "Line1": "Google",
    //       "PostalCode": "95123",
    //       "Lat": "37.2374847",
    //       "Long": "-121.8277925",
    //       "CountrySubDivisionCode": "CA",
    //       "Id": "35"
    //     },
    //     "ApplyTaxAfterDiscount": false,
    //     "CustomField": [
    //       {
    //         "StringValue": "Custom1",
    //         "Type": "StringType",
    //         "Name": "Custom 1"
    //       },
    //       {
    //         "StringValue": "Custom2",
    //         "Type": "StringType",
    //         "Name": "Custom 2"
    //       },
    //       {
    //         "StringValue": "Custom3",
    //         "Type": "StringType",
    //         "Name": "Custom 3"
    //       }
    //     ],
    //     "Id": "96"
    //   },
    //   "time": "2013-03-14T13:32:04.895-07:00"
    // }
    // 

    var Description;
    var DetailType;
    var SalesItemLineDetailTaxCodeRefValue;
    var SalesItemLineDetailQty;
    var SalesItemLineDetailUnitPrice;
    var SalesItemLineDetailServiceDate;
    var SalesItemLineDetailItemRefName;
    var SalesItemLineDetailItemRefValue;
    var LineNum;
    var Amount;
    var Id;
    var DiscountLineDetailDiscountAccountRefName;
    var DiscountLineDetailDiscountAccountRefValue;
    var DiscountLineDetailPercentBased;
    var DiscountLineDetailDiscountPercent;
    var TaxLineDetailNetAmountTaxable;
    var TaxLineDetailTaxPercent;
    var TaxLineDetailTaxRateRefValue;
    var TaxLineDetailPercentBased;
    var StringValue;
    var Type;
    var Name;

    var InvoiceTxnDate = jsonResponse.StringOf("Invoice.TxnDate");
    var InvoiceDomain = jsonResponse.StringOf("Invoice.domain");
    var InvoiceCurrencyRefName = jsonResponse.StringOf("Invoice.CurrencyRef.name");
    var InvoiceCurrencyRefValue = jsonResponse.StringOf("Invoice.CurrencyRef.value");
    var InvoiceShipDate = jsonResponse.StringOf("Invoice.ShipDate");
    var InvoiceTrackingNum = jsonResponse.StringOf("Invoice.TrackingNum");
    var InvoiceClassRefName = jsonResponse.StringOf("Invoice.ClassRef.name");
    var InvoiceClassRefValue = jsonResponse.StringOf("Invoice.ClassRef.value");
    var InvoicePrintStatus = jsonResponse.StringOf("Invoice.PrintStatus");
    var InvoiceSalesTermRefValue = jsonResponse.StringOf("Invoice.SalesTermRef.value");
    var InvoiceDeliveryInfoDeliveryType = jsonResponse.StringOf("Invoice.DeliveryInfo.DeliveryType");
    var InvoiceDeliveryInfoDeliveryTime = jsonResponse.StringOf("Invoice.DeliveryInfo.DeliveryTime");
    var InvoiceTotalAmt = jsonResponse.StringOf("Invoice.TotalAmt");
    var InvoiceDueDate = jsonResponse.StringOf("Invoice.DueDate");
    var InvoiceMetaDataCreateTime = jsonResponse.StringOf("Invoice.MetaData.CreateTime");
    var InvoiceMetaDataLastUpdatedTime = jsonResponse.StringOf("Invoice.MetaData.LastUpdatedTime");
    var InvoiceDocNumber = jsonResponse.StringOf("Invoice.DocNumber");
    var InvoicePrivateNote = jsonResponse.StringOf("Invoice.PrivateNote");
    var InvoiceSparse = jsonResponse.BoolOf("Invoice.sparse");
    var InvoiceDepositToAccountRefName = jsonResponse.StringOf("Invoice.DepositToAccountRef.name");
    var InvoiceDepositToAccountRefValue = jsonResponse.StringOf("Invoice.DepositToAccountRef.value");
    var InvoiceCustomerMemoValue = jsonResponse.StringOf("Invoice.CustomerMemo.value");
    var InvoiceEmailStatus = jsonResponse.StringOf("Invoice.EmailStatus");
    var InvoiceDeposit = jsonResponse.StringOf("Invoice.Deposit");
    var InvoiceBalance = jsonResponse.StringOf("Invoice.Balance");
    var InvoiceCustomerRefName = jsonResponse.StringOf("Invoice.CustomerRef.name");
    var InvoiceCustomerRefValue = jsonResponse.StringOf("Invoice.CustomerRef.value");
    var InvoiceTxnTaxDetailTxnTaxCodeRefValue = jsonResponse.StringOf("Invoice.TxnTaxDetail.TxnTaxCodeRef.value");
    var InvoiceTxnTaxDetailTotalTax = jsonResponse.StringOf("Invoice.TxnTaxDetail.TotalTax");
    var InvoiceSyncToken = jsonResponse.StringOf("Invoice.SyncToken");
    var InvoiceBillEmailAddress = jsonResponse.StringOf("Invoice.BillEmail.Address");
    var InvoiceShipAddrCity = jsonResponse.StringOf("Invoice.ShipAddr.City");
    var InvoiceShipAddrCountry = jsonResponse.StringOf("Invoice.ShipAddr.Country");
    var InvoiceShipAddrLine5 = jsonResponse.StringOf("Invoice.ShipAddr.Line5");
    var InvoiceShipAddrLine4 = jsonResponse.StringOf("Invoice.ShipAddr.Line4");
    var InvoiceShipAddrLine3 = jsonResponse.StringOf("Invoice.ShipAddr.Line3");
    var InvoiceShipAddrLine2 = jsonResponse.StringOf("Invoice.ShipAddr.Line2");
    var InvoiceShipAddrLine1 = jsonResponse.StringOf("Invoice.ShipAddr.Line1");
    var InvoiceShipAddrPostalCode = jsonResponse.StringOf("Invoice.ShipAddr.PostalCode");
    var InvoiceShipAddrLat = jsonResponse.StringOf("Invoice.ShipAddr.Lat");
    var InvoiceShipAddrLong = jsonResponse.StringOf("Invoice.ShipAddr.Long");
    var InvoiceShipAddrCountrySubDivisionCode = jsonResponse.StringOf("Invoice.ShipAddr.CountrySubDivisionCode");
    var InvoiceShipAddrId = jsonResponse.StringOf("Invoice.ShipAddr.Id");
    var InvoiceDepartmentRefName = jsonResponse.StringOf("Invoice.DepartmentRef.name");
    var InvoiceDepartmentRefValue = jsonResponse.StringOf("Invoice.DepartmentRef.value");
    var InvoiceShipMethodRefName = jsonResponse.StringOf("Invoice.ShipMethodRef.name");
    var InvoiceShipMethodRefValue = jsonResponse.StringOf("Invoice.ShipMethodRef.value");
    var InvoiceBillAddrCity = jsonResponse.StringOf("Invoice.BillAddr.City");
    var InvoiceBillAddrCountry = jsonResponse.StringOf("Invoice.BillAddr.Country");
    var InvoiceBillAddrLine5 = jsonResponse.StringOf("Invoice.BillAddr.Line5");
    var InvoiceBillAddrLine4 = jsonResponse.StringOf("Invoice.BillAddr.Line4");
    var InvoiceBillAddrLine3 = jsonResponse.StringOf("Invoice.BillAddr.Line3");
    var InvoiceBillAddrLine2 = jsonResponse.StringOf("Invoice.BillAddr.Line2");
    var InvoiceBillAddrLine1 = jsonResponse.StringOf("Invoice.BillAddr.Line1");
    var InvoiceBillAddrPostalCode = jsonResponse.StringOf("Invoice.BillAddr.PostalCode");
    var InvoiceBillAddrLat = jsonResponse.StringOf("Invoice.BillAddr.Lat");
    var InvoiceBillAddrLong = jsonResponse.StringOf("Invoice.BillAddr.Long");
    var InvoiceBillAddrCountrySubDivisionCode = jsonResponse.StringOf("Invoice.BillAddr.CountrySubDivisionCode");
    var InvoiceBillAddrId = jsonResponse.StringOf("Invoice.BillAddr.Id");
    var InvoiceApplyTaxAfterDiscount = jsonResponse.BoolOf("Invoice.ApplyTaxAfterDiscount");
    var InvoiceId = jsonResponse.StringOf("Invoice.Id");
    var time = jsonResponse.StringOf("time");
    var i = 0;
    var count_i = jsonResponse.SizeOfArray("Invoice.Line");
    while (i < count_i) {
        jsonResponse.I = i;
        Description = jsonResponse.StringOf("Invoice.Line[i].Description");
        DetailType = jsonResponse.StringOf("Invoice.Line[i].DetailType");
        SalesItemLineDetailTaxCodeRefValue = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value");
        SalesItemLineDetailQty = jsonResponse.IntOf("Invoice.Line[i].SalesItemLineDetail.Qty");
        SalesItemLineDetailUnitPrice = jsonResponse.IntOf("Invoice.Line[i].SalesItemLineDetail.UnitPrice");
        SalesItemLineDetailServiceDate = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ServiceDate");
        SalesItemLineDetailItemRefName = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.name");
        SalesItemLineDetailItemRefValue = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.value");
        LineNum = jsonResponse.IntOf("Invoice.Line[i].LineNum");
        Amount = jsonResponse.StringOf("Invoice.Line[i].Amount");
        Id = jsonResponse.StringOf("Invoice.Line[i].Id");
        DiscountLineDetailDiscountAccountRefName = jsonResponse.StringOf("Invoice.Line[i].DiscountLineDetail.DiscountAccountRef.name");
        DiscountLineDetailDiscountAccountRefValue = jsonResponse.StringOf("Invoice.Line[i].DiscountLineDetail.DiscountAccountRef.value");
        DiscountLineDetailPercentBased = jsonResponse.BoolOf("Invoice.Line[i].DiscountLineDetail.PercentBased");
        DiscountLineDetailDiscountPercent = jsonResponse.IntOf("Invoice.Line[i].DiscountLineDetail.DiscountPercent");
        i = i+1;
    }

    i = 0;
    count_i = jsonResponse.SizeOfArray("Invoice.TxnTaxDetail.TaxLine");
    while (i < count_i) {
        jsonResponse.I = i;
        DetailType = jsonResponse.StringOf("Invoice.TxnTaxDetail.TaxLine[i].DetailType");
        Amount = jsonResponse.StringOf("Invoice.TxnTaxDetail.TaxLine[i].Amount");
        TaxLineDetailNetAmountTaxable = jsonResponse.StringOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.NetAmountTaxable");
        TaxLineDetailTaxPercent = jsonResponse.IntOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.TaxPercent");
        TaxLineDetailTaxRateRefValue = jsonResponse.StringOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.TaxRateRef.value");
        TaxLineDetailPercentBased = jsonResponse.BoolOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.PercentBased");
        i = i+1;
    }

    i = 0;
    count_i = jsonResponse.SizeOfArray("Invoice.CustomField");
    while (i < count_i) {
        jsonResponse.I = i;
        StringValue = jsonResponse.StringOf("Invoice.CustomField[i].StringValue");
        Type = jsonResponse.StringOf("Invoice.CustomField[i].Type");
        Name = jsonResponse.StringOf("Invoice.CustomField[i].Name");
        i = i+1;
    }


}

chilkatExample();