(Xojo Plugin) 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

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// 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.
Dim jsonToken As New Chilkat.JsonObject
Dim success As Boolean
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

Dim rest As New Chilkat.Rest

// Connect to the REST server.
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
bAutoReconnect = True
Dim success As Boolean
success = rest.Connect("sandbox-quickbooks.api.intuit.com",port,bTls,bAutoReconnect)

Dim sbAuth As New Chilkat.StringBuilder
success = sbAuth.Append("Bearer ")
success = 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

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

Dim sbRequestBody As New Chilkat.StringBuilder
success = jsonReq.EmitSb(sbRequestBody)

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestSb("POST","/v3/company/<realmID>/customer",sbRequestBody,sbResponseBody)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim respStatusCode As Int32
respStatusCode = rest.ResponseStatusCode

// Success is indicated by a 200 response status code.
System.DebugLog("response status code = " + Str(respStatusCode))

Dim jsonResponse As New Chilkat.JsonObject
success = jsonResponse.LoadSb(sbResponseBody)
jsonResponse.EmitCompact = False
System.DebugLog(jsonResponse.Emit())

If (rest.ResponseStatusCode <> 200) Then
    System.DebugLog("Failed.")
    Return
End If

// 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"
// }
// 

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