PureBasic

QuickBooks - Create an Employee

See more QuickBooks Examples

Demonstrates how to send an JSON request to create a QuickBooks employee PureBasic

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

    ; 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 = 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))

    ; Create the following JSON:

    ; Use this online tool to generate code from sample JSON: 
    ; Generate Code to Create JSON

    ; {
    ;   "SSN": "444-55-6666",
    ;   "PrimaryAddr": {
    ;     "Id": "50",
    ;     "Line1": "45 N. Elm Street",
    ;     "City": "Middlefield",
    ;     "CountrySubDivisionCode": "CA",
    ;     "PostalCode": "93242"
    ;   },
    ;   "GivenName": "John",
    ;   "FamilyName": "Meuller",
    ;   "PrimaryPhone": {
    ;     "FreeFormNumber": "408-525-1234"
    ;   }
    ; }
    ; 
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"SSN","444-55-6666")
    CkJsonObject::ckUpdateString(json,"PrimaryAddr.Id","50")
    CkJsonObject::ckUpdateString(json,"PrimaryAddr.Line1","45 N. Elm Street")
    CkJsonObject::ckUpdateString(json,"PrimaryAddr.City","Middlefield")
    CkJsonObject::ckUpdateString(json,"PrimaryAddr.CountrySubDivisionCode","CA")
    CkJsonObject::ckUpdateString(json,"PrimaryAddr.PostalCode","93242")
    CkJsonObject::ckUpdateString(json,"GivenName","John")
    CkJsonObject::ckUpdateString(json,"FamilyName","Meuller")
    CkJsonObject::ckUpdateString(json,"PrimaryPhone.FreeFormNumber","408-525-1234")

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

    ; The company ID is 123146096291789
    responseBody.s = CkRest::ckFullRequestString(rest,"POST","/v3/company/123146096291789/employee?minorversion=45",CkJsonObject::ckEmit(json))
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbAuth)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    ; 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)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

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

    CkJsonObject::ckLoad(jsonResponse,responseBody)
    CkJsonObject::setCkEmitCompact(jsonResponse, 0)
    Debug CkJsonObject::ckEmit(jsonResponse)
    Debug "Success."

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

    ; A sample JSON response:
    ; {
    ;   "Employee": {
    ;     "SSN": "XXX-XX-XXXX",
    ;     "PrimaryAddr": {
    ;       "Id": "97",
    ;       "Line1": "45 N. Elm Street",
    ;       "City": "Middlefield",
    ;       "CountrySubDivisionCode": "CA",
    ;       "PostalCode": "93242"
    ;     },
    ;     "BillableTime": false,
    ;     "domain": "QBO",
    ;     "sparse": false,
    ;     "Id": "59",
    ;     "SyncToken": "0",
    ;     "MetaData": {
    ;       "CreateTime": "2016-10-25T14:05:05-07:00",
    ;       "LastUpdatedTime": "2016-10-25T14:05:05-07:00"
    ;     },
    ;     "GivenName": "John",
    ;     "FamilyName": "Meuller",
    ;     "DisplayName": "John Meuller",
    ;     "PrintOnCheckName": "John Meuller",
    ;     "Active": true,
    ;     "PrimaryPhone": {
    ;       "FreeFormNumber": "408-525-1234"
    ;     }
    ;   },
    ;   "time": "2016-10-25T14:05:05.661-07:00"
    ; }
    ; 


    CkJsonObject::ckDispose(jsonToken)
    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbAuth)
    CkJsonObject::ckDispose(json)
    CkJsonObject::ckDispose(jsonResponse)


    ProcedureReturn
EndProcedure