Swift

QuickBooks - Create an Employee

See more QuickBooks Examples

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

func chilkatTest() {
    var success: Bool = false

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

    let jsonToken = CkoJsonObject()!
    success = jsonToken.loadFile(path: "qa_data/tokens/qb-access-token.json")

    let rest = CkoRest()!

    // 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.
    var bAutoReconnect: Bool = true
    success = rest.connect(hostname: "sandbox-quickbooks.api.intuit.com", port: 443, tls: true, autoReconnect: bAutoReconnect)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    let sbAuth = CkoStringBuilder()!
    sbAuth.append(value: "Bearer ")
    sbAuth.append(value: jsonToken.string(of: "access_token"))
    rest.authorization = sbAuth.getAsString()

    // 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"
    //   }
    // }
    // 
    let json = CkoJsonObject()!
    json.updateString(jsonPath: "SSN", value: "444-55-6666")
    json.updateString(jsonPath: "PrimaryAddr.Id", value: "50")
    json.updateString(jsonPath: "PrimaryAddr.Line1", value: "45 N. Elm Street")
    json.updateString(jsonPath: "PrimaryAddr.City", value: "Middlefield")
    json.updateString(jsonPath: "PrimaryAddr.CountrySubDivisionCode", value: "CA")
    json.updateString(jsonPath: "PrimaryAddr.PostalCode", value: "93242")
    json.updateString(jsonPath: "GivenName", value: "John")
    json.updateString(jsonPath: "FamilyName", value: "Meuller")
    json.updateString(jsonPath: "PrimaryPhone.FreeFormNumber", value: "408-525-1234")

    rest.addHeader(name: "Content-Type", value: "application/json")
    rest.addHeader(name: "Accept", value: "application/json")
    rest.allowHeaderFolding = false

    // The company ID is 123146096291789
    var responseBody: String? = rest.fullRequestString(httpVerb: "POST", uriPath: "/v3/company/123146096291789/employee?minorversion=45", bodyText: json.emit())
    if rest.lastMethodSuccess != true {
        print("\(rest.lastErrorText!)")
        return
    }

    // We should expect a 200 response if successful.
    if rest.responseStatusCode.intValue != 200 {
        print("Request Header: ")
        print("\(rest.lastRequestHeader!)")
        print("----")
        print("Response StatusCode = \(rest.responseStatusCode.intValue)")
        print("Response StatusLine: \(rest.responseStatusText!)")
        print("Response Header:")
        print("\(rest.responseHeader!)")
        print("\(responseBody!)")
        return
    }

    let jsonResponse = CkoJsonObject()!
    jsonResponse.load(json: responseBody)
    jsonResponse.emitCompact = false
    print("\(jsonResponse.emit()!)")
    print("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"
    // }
    // 

}