(PureBasic) QuickBooks - Query an Account

Demonstrates how to query the QuickBooks chart of accounts.

For more information, see https://developer.intuit.com/app/developer/qbo/docs/api/accounting/ecommerce/account#query-an-account

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkDateTime.pb"
IncludeFile "CkDtObj.pb"

Procedure ChilkatExample()

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

    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/qb-access-token.json")

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"sandbox-quickbooks.api.intuit.com",443,1,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    sbAuth.i = CkStringBuilder::ckCreate()
    If sbAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbAuth,"Bearer ")
    CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"access_token"))
    CkRest::setCkAuthorization(rest, CkStringBuilder::ckGetAsString(sbAuth))

    CkRest::ckAddHeader(rest,"Accept","application/json")
    CkRest::setCkAllowHeaderFolding(rest, 0)

    ; Add a SELECT statement 
    CkRest::ckAddQueryParam(rest,"query","select * from Account where Metadata.CreateTime > '2014-12-31'")
    CkRest::ckAddQueryParam(rest,"minorversion","45")

    ; The company ID is 123146096291789
    responseBody.s = CkRest::ckFullRequestNoBody(rest,"GET","/v3/company/123146096291789/query")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbAuth)
        ProcedureReturn
    EndIf

    CkRest::ckClearAllQueryParams(rest)

    ; We should expect a 200 response if successful.
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "Request Header: "
        Debug CkRest::ckLastRequestHeader(rest)
        Debug "----"
        Debug "Response StatusCode = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "Response StatusLine: " + CkRest::ckResponseStatusText(rest)
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        Debug responseBody
        CkJsonObject::ckDispose(jsonToken)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbAuth)
        ProcedureReturn
    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.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,responseBody)

    ; These will be used for parsing date/time strings..
    dtime.i = CkDateTime::ckCreate()
    If dtime.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    bLocalTime.i = 1
    dt.i

    ; Iterate over each account returned.
    numAccounts.i = CkJsonObject::ckSizeOfArray(json,"QueryResponse.Account")
    i.i = 0
    While i < numAccounts

        CkJsonObject::setCkI(json, i)
        Debug "Name: " + CkJsonObject::ckStringOf(json,"QueryResponse.Account[i].Name")
        Debug "Id: " + CkJsonObject::ckStringOf(json,"QueryResponse.Account[i].Id")

        ; Load the CreateTime into a CkDateTime...
        CkDateTime::ckSetFromTimestamp(dtime,CkJsonObject::ckStringOf(json,"QueryResponse.Account[i].MetaData.CreateTime"))
        dt = CkDateTime::ckGetDtObj(dtime,bLocalTime)
        Debug Str(CkDtObj::ckMonth(dt)) + "/" + Str(CkDtObj::ckDay(dt)) + "/" + Str(CkDtObj::ckYear(dt)) + "  " + Str(CkDtObj::ckHour(dt)) + ":" + Str(CkDtObj::ckMinute(dt))
        CkDtObj::ckDispose(dt)

        Debug "----"
        i = i + 1
    Wend

    Debug "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"
    ; 


    CkJsonObject::ckDispose(jsonToken)
    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbAuth)
    CkJsonObject::ckDispose(json)
    CkDateTime::ckDispose(dtime)


    ProcedureReturn
EndProcedure