Swift

Quickbooks Delete an Invoice

See more QuickBooks Examples

Demonstrates how to delete an invoice using the Quickbooks REST API. Swift

func chilkatTest() {
    var success: Bool = false

    // 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.
    let jsonToken = CkoJsonObject()!
    success = jsonToken.loadFile(path: "qa_data/tokens/qb-access-token.json")

    let rest = CkoRest()!

    // Connect to the REST server.
    var bTls: Bool = true
    var port: Int = 443
    var bAutoReconnect: Bool = true
    success = rest.connect(hostname: "sandbox-quickbooks.api.intuit.com", port: port, tls: bTls, autoReconnect: bAutoReconnect)

    let sbAuth = CkoStringBuilder()!
    sbAuth.append(value: "Bearer ")
    sbAuth.append(value: jsonToken.string(of: "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:

    // {
    //   "SyncToken": "3",
    //   "Id": "33"
    // }
    // 
    // Use the this online tool to generate the code from sample JSON: 
    // Generate Code to Create JSON

    let jsonReq = CkoJsonObject()!
    jsonReq.updateString(jsonPath: "SyncToken", value: "3")
    jsonReq.updateString(jsonPath: "Id", value: "33")

    let sbRequestBody = CkoStringBuilder()!
    jsonReq.emitSb(sb: sbRequestBody)

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

    let sbResponseBody = CkoStringBuilder()!
    success = rest.fullRequestSb(httpVerb: "POST", uriPath: "/v3/company/<realmID>/invoice?operation=delete", requestBody: sbRequestBody, responseBody: sbResponseBody)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    var respStatusCode: Int = rest.responseStatusCode.intValue

    // Success is indicated by a 200 response status code.
    print("response status code = \(respStatusCode)")

    let jsonResponse = CkoJsonObject()!
    jsonResponse.loadSb(sb: sbResponseBody)
    jsonResponse.emitCompact = false
    print("\(jsonResponse.emit()!)")

    if rest.responseStatusCode.intValue != 200 {
        print("Failed.")
        return
    }

    // Sample output...
    // (See the parsing code below..)
    // 
    // Use the this online tool to generate parsing code from sample JSON: 
    // Generate Parsing Code from JSON

    // {
    //   "Invoice": {
    //     "status": "Deleted",
    //     "domain": "QBO",
    //     "Id": "33"
    //   },
    //   "time": "2013-03-15T00:18:15.322-07:00"
    // }
    // 

    var InvoiceStatus: String? = jsonResponse.string(of: "Invoice.status")
    var InvoiceDomain: String? = jsonResponse.string(of: "Invoice.domain")
    var InvoiceId: String? = jsonResponse.string(of: "Invoice.Id")
    var time: String? = jsonResponse.string(of: "time")

}