Lianja

QuickBooks - Query an Account

See more QuickBooks Examples

Demonstrates how to query the QuickBooks chart of accounts. Lianja

llSuccess = .F.

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

// Get our previously obtained OAuth2 access token, which should contain JSON like this:
// {
//   "expires_in": 3600,
//   "x_refresh_token_expires_in": 8726400,
//   "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
//   "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
//   "token_type": "bearer"
// }

loJsonToken = createobject("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

loRest = createobject("CkRest")

// Connect using TLS.
// A single REST object, once connected, can be used for many Quickbooks REST API calls.
// The auto-reconnect indicates that if the already-established HTTPS connection is closed,
// then it will be automatically re-established as needed.
llBAutoReconnect = .T.
llSuccess = loRest.Connect("sandbox-quickbooks.api.intuit.com",443,.T.,llBAutoReconnect)
if (llSuccess = .F.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loRest
    return
endif

loSbAuth = createobject("CkStringBuilder")
loSbAuth.Append("Bearer ")
loSbAuth.Append(loJsonToken.StringOf("access_token"))
loRest.Authorization = loSbAuth.GetAsString()

loRest.AddHeader("Accept","application/json")
loRest.AllowHeaderFolding = .F.

// Add a SELECT statement 
loRest.AddQueryParam("query","select * from Account where Metadata.CreateTime > '2014-12-31'")
loRest.AddQueryParam("minorversion","45")

// The company ID is 123146096291789
lcResponseBody = loRest.FullRequestNoBody("GET","/v3/company/123146096291789/query")
if (loRest.LastMethodSuccess = .F.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loRest
    release loSbAuth
    return
endif

loRest.ClearAllQueryParams()

// We should expect a 200 response if successful.
if (loRest.ResponseStatusCode <> 200) then
    ? "Request Header: "
    ? loRest.LastRequestHeader
    ? "----"
    ? "Response StatusCode = " + str(loRest.ResponseStatusCode)
    ? "Response StatusLine: " + loRest.ResponseStatusText
    ? "Response Header:"
    ? loRest.ResponseHeader
    ? lcResponseBody
    release loJsonToken
    release loRest
    release loSbAuth
    return
endif

// Use this online tool to generate parsing code from sample JSON: 
// Generate Parsing Code from JSON

// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
loJson = createobject("CkJsonObject")
loJson.Load(lcResponseBody)

// These will be used for parsing date/time strings..
loDtime = createobject("CkDateTime")
llBLocalTime = .T.
loDt = createobject("CkDtObj")

// Iterate over each account returned.
lnNumAccounts = loJson.SizeOfArray("QueryResponse.Account")
i = 0
do while i < lnNumAccounts

    loJson.I = i
    ? "Name: " + loJson.StringOf("QueryResponse.Account[i].Name")
    ? "Id: " + loJson.StringOf("QueryResponse.Account[i].Id")

    // Load the CreateTime into a CkDateTime...
    loDtime.SetFromTimestamp(loJson.StringOf("QueryResponse.Account[i].MetaData.CreateTime"))
    loDtime.ToDtObj(llBLocalTime,loDt)

    ? str(loDt.Month) + "/" + str(loDt.Day) + "/" + str(loDt.Year) + "  " + str(loDt.Hour) + ":" + str(loDt.Minute)

    ? "----"
    i = i + 1
enddo

? "Success."

// ------------------------------------------------------
// The JSON response looks like this:

// {
//   "QueryResponse": {
//     "Account": [
//       {
//         "Name": "Accounts Payable (A/P)",
//         "SubAccount": false,
//         "FullyQualifiedName": "Accounts Payable (A/P)",
//         "Active": true,
//         "Classification": "Liability",
//         "AccountType": "Accounts Payable",
//         "AccountSubType": "AccountsPayable",
//         "CurrentBalance": -1602.67,
//         "CurrentBalanceWithSubAccounts": -1602.67,
//         "CurrencyRef": {
//           "value": "USD",
//           "name": "United States Dollar"
//         },
//         "domain": "QBO",
//         "sparse": false,
//         "Id": "33",
//         "SyncToken": "0",
//         "MetaData": {
//           "CreateTime": "2016-09-10T10:12:02-07:00",
//           "LastUpdatedTime": "2016-09-17T13:10:36-07:00"
//         }
//       },
//       {
//         "Name": "Accounts Receivable (A/R)",
//         "SubAccount": false,
//         "FullyQualifiedName": "Accounts Receivable (A/R)",
//         "Active": true,
//         "Classification": "Asset",
//         "AccountType": "Accounts Receivable",
//         "AccountSubType": "AccountsReceivable",
//         "CurrentBalance": 5281.52,
//         "CurrentBalanceWithSubAccounts": 5281.52,
//         "CurrencyRef": {
//           "value": "USD",
//           "name": "United States Dollar"
//         },
//         "domain": "QBO",
//         "sparse": false,
//         "Id": "84",
//         "SyncToken": "0",
//         "MetaData": {
//           "CreateTime": "2016-09-14T14:49:29-07:00",
//           "LastUpdatedTime": "2016-09-17T13:16:17-07:00"
//         }
//       },
//       {
//         "Name": "Advertising",
//         "SubAccount": false,
//         "FullyQualifiedName": "Advertising",
//         "Active": true,
//         "Classification": "Expense",
//         "AccountType": "Expense",
//         "AccountSubType": "AdvertisingPromotional",
//         "CurrentBalance": 0,
//         "CurrentBalanceWithSubAccounts": 0,
//         "CurrencyRef": {
//           "value": "USD",
//           "name": "United States Dollar"
//         },
//         "domain": "QBO",
//         "sparse": false,
//         "Id": "7",
//         "SyncToken": "0",
//         "MetaData": {
//           "CreateTime": "2016-09-09T14:42:07-07:00",
//           "LastUpdatedTime": "2016-09-09T14:42:07-07:00"
//         }
//       },
// ...
//   "time": "2016-10-24T15:35:25.067-07:00"
// 


release loJsonToken
release loRest
release loSbAuth
release loJson
release loDtime
release loDt