(Node.js) Quickbooks Create a New Customer

Demonstrates how to create a new customer via the Quickbooks REST API.

For more information, see https://www.developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/customer#create-a-customer

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.
    // --------------------------------------------------------------------------

    // Create the following JSON:

    // {
    //   "FullyQualifiedName": "King Groceries",
    //   "PrimaryEmailAddr": {
    //     "Address": "jdrew@myemail.com"
    //   },
    //   "DisplayName": "King's Groceries",
    //   "Suffix": "Jr",
    //   "Title": "Mr",
    //   "MiddleName": "B",
    //   "Notes": "Here are other details.",
    //   "FamilyName": "King",
    //   "PrimaryPhone": {
    //     "FreeFormNumber": "(555) 555-5555"
    //   },
    //   "CompanyName": "King Groceries",
    //   "BillAddr": {
    //     "CountrySubDivisionCode": "CA",
    //     "City": "Mountain View",
    //     "PostalCode": "94042",
    //     "Line1": "123 Main Street",
    //     "Country": "USA"
    //   },
    //   "GivenName": "James"
    // }
    // 
    // Use the this online tool to generate the code from sample JSON: 
    // Generate Code to Create JSON

    var jsonReq = new chilkat.JsonObject();
    jsonReq.UpdateString("FullyQualifiedName","King Groceries");
    jsonReq.UpdateString("PrimaryEmailAddr.Address","jdrew@myemail.com");
    jsonReq.UpdateString("DisplayName","King's Groceries");
    jsonReq.UpdateString("Suffix","Jr");
    jsonReq.UpdateString("Title","Mr");
    jsonReq.UpdateString("MiddleName","B");
    jsonReq.UpdateString("Notes","Here are other details.");
    jsonReq.UpdateString("FamilyName","King");
    jsonReq.UpdateString("PrimaryPhone.FreeFormNumber","(555) 555-5555");
    jsonReq.UpdateString("CompanyName","King Groceries");
    jsonReq.UpdateString("BillAddr.CountrySubDivisionCode","CA");
    jsonReq.UpdateString("BillAddr.City","Mountain View");
    jsonReq.UpdateString("BillAddr.PostalCode","94042");
    jsonReq.UpdateString("BillAddr.Line1","123 Main Street");
    jsonReq.UpdateString("BillAddr.Country","USA");
    jsonReq.UpdateString("GivenName","James");

    var sbRequestBody = new chilkat.StringBuilder();
    jsonReq.EmitSb(sbRequestBody);

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

    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestSb("POST","/v3/company/<realmID>/customer",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 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

    // {
    //   "Customer": {
    //     "domain": "QBO",
    //     "PrimaryEmailAddr": {
    //       "Address": "jdrew@myemail.com"
    //     },
    //     "DisplayName": "King's Groceries",
    //     "CurrencyRef": {
    //       "name": "United States Dollar",
    //       "value": "USD"
    //     },
    //     "DefaultTaxCodeRef": {
    //       "value": "2"
    //     },
    //     "PreferredDeliveryMethod": "Print",
    //     "GivenName": "James",
    //     "FullyQualifiedName": "King's Groceries",
    //     "BillWithParent": false,
    //     "Title": "Mr",
    //     "Job": false,
    //     "BalanceWithJobs": 0,
    //     "PrimaryPhone": {
    //       "FreeFormNumber": "(555) 555-5555"
    //     },
    //     "Taxable": true,
    //     "MetaData": {
    //       "CreateTime": "2015-07-23T10:58:12-07:00",
    //       "LastUpdatedTime": "2015-07-23T10:58:12-07:00"
    //     },
    //     "BillAddr": {
    //       "City": "Mountain View",
    //       "Country": "USA",
    //       "Line1": "123 Main Street",
    //       "PostalCode": "94042",
    //       "CountrySubDivisionCode": "CA",
    //       "Id": "112"
    //     },
    //     "MiddleName": "B",
    //     "Notes": "Here are other details.",
    //     "Active": true,
    //     "Balance": 0,
    //     "SyncToken": "0",
    //     "Suffix": "Jr",
    //     "CompanyName": "King Groceries",
    //     "FamilyName": "King",
    //     "PrintOnCheckName": "King Groceries",
    //     "sparse": false,
    //     "Id": "67"
    //   },
    //   "time": "2015-07-23T10:58:12.099-07:00"
    // }
    // 

    var CustomerDomain = jsonResponse.StringOf("Customer.domain");
    var CustomerPrimaryEmailAddrAddress = jsonResponse.StringOf("Customer.PrimaryEmailAddr.Address");
    var CustomerDisplayName = jsonResponse.StringOf("Customer.DisplayName");
    var CustomerCurrencyRefName = jsonResponse.StringOf("Customer.CurrencyRef.name");
    var CustomerCurrencyRefValue = jsonResponse.StringOf("Customer.CurrencyRef.value");
    var CustomerDefaultTaxCodeRefValue = jsonResponse.StringOf("Customer.DefaultTaxCodeRef.value");
    var CustomerPreferredDeliveryMethod = jsonResponse.StringOf("Customer.PreferredDeliveryMethod");
    var CustomerGivenName = jsonResponse.StringOf("Customer.GivenName");
    var CustomerFullyQualifiedName = jsonResponse.StringOf("Customer.FullyQualifiedName");
    var CustomerBillWithParent = jsonResponse.BoolOf("Customer.BillWithParent");
    var CustomerTitle = jsonResponse.StringOf("Customer.Title");
    var CustomerJob = jsonResponse.BoolOf("Customer.Job");
    var CustomerBalanceWithJobs = jsonResponse.IntOf("Customer.BalanceWithJobs");
    var CustomerPrimaryPhoneFreeFormNumber = jsonResponse.StringOf("Customer.PrimaryPhone.FreeFormNumber");
    var CustomerTaxable = jsonResponse.BoolOf("Customer.Taxable");
    var CustomerMetaDataCreateTime = jsonResponse.StringOf("Customer.MetaData.CreateTime");
    var CustomerMetaDataLastUpdatedTime = jsonResponse.StringOf("Customer.MetaData.LastUpdatedTime");
    var CustomerBillAddrCity = jsonResponse.StringOf("Customer.BillAddr.City");
    var CustomerBillAddrCountry = jsonResponse.StringOf("Customer.BillAddr.Country");
    var CustomerBillAddrLine1 = jsonResponse.StringOf("Customer.BillAddr.Line1");
    var CustomerBillAddrPostalCode = jsonResponse.StringOf("Customer.BillAddr.PostalCode");
    var CustomerBillAddrCountrySubDivisionCode = jsonResponse.StringOf("Customer.BillAddr.CountrySubDivisionCode");
    var CustomerBillAddrId = jsonResponse.StringOf("Customer.BillAddr.Id");
    var CustomerMiddleName = jsonResponse.StringOf("Customer.MiddleName");
    var CustomerNotes = jsonResponse.StringOf("Customer.Notes");
    var CustomerActive = jsonResponse.BoolOf("Customer.Active");
    var CustomerBalance = jsonResponse.IntOf("Customer.Balance");
    var CustomerSyncToken = jsonResponse.StringOf("Customer.SyncToken");
    var CustomerSuffix = jsonResponse.StringOf("Customer.Suffix");
    var CustomerCompanyName = jsonResponse.StringOf("Customer.CompanyName");
    var CustomerFamilyName = jsonResponse.StringOf("Customer.FamilyName");
    var CustomerPrintOnCheckName = jsonResponse.StringOf("Customer.PrintOnCheckName");
    var CustomerSparse = jsonResponse.BoolOf("Customer.sparse");
    var CustomerId = jsonResponse.StringOf("Customer.Id");
    var time = jsonResponse.StringOf("time");

}

chilkatExample();