(Swift 2) Quickbooks Update an Invoice

Demonstrates how to update an invoice using the Quickbooks REST API.

For more information, see https://www.developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/invoice#full-update-an-invoice

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    // 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()
    var success: Bool = jsonToken.LoadFile("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
    var success: Bool = rest.Connect("sandbox-quickbooks.api.intuit.com", port: port, tls: bTls, autoReconnect: bAutoReconnect)

    let sbAuth = CkoStringBuilder()
    sbAuth.Append("Bearer ")
    sbAuth.Append(jsonToken.StringOf("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:

    // {
    //   "DocNumber": "1070",
    //   "SyncToken": "0",
    //   "domain": "QBO",
    //   "Balance": 150.0,
    //   "BillAddr": {
    //     "City": "Bayshore",
    //     "Line1": "4581 Finch St.",
    //     "PostalCode": "94326",
    //     "Lat": "INVALID",
    //     "Long": "INVALID",
    //     "CountrySubDivisionCode": "CA",
    //     "Id": "2"
    //   },
    //   "TxnDate": "2015-07-24",
    //   "TotalAmt": 150.0,
    //   "CustomerRef": {
    //     "name": "Amy's Bird Sanctuary",
    //     "value": "1"
    //   },
    //   "CustomerMemo": {
    //     "value": "Added customer memo."
    //   },
    //   "ShipAddr": {
    //     "City": "Bayshore",
    //     "Line1": "4581 Finch St.",
    //     "PostalCode": "94326",
    //     "Lat": "INVALID",
    //     "Long": "INVALID",
    //     "CountrySubDivisionCode": "CA",
    //     "Id": "109"
    //   },
    //   "LinkedTxn": [
    //   ],
    //   "DueDate": "2015-08-23",
    //   "PrintStatus": "NeedToPrint",
    //   "EmailStatus": "NotSet",
    //   "sparse": false,
    //   "Line": [
    //     {
    //       "LineNum": 1,
    //       "Amount": 150.0,
    //       "SalesItemLineDetail": {
    //         "TaxCodeRef": {
    //           "value": "NON"
    //         },
    //         "ItemRef": {
    //           "name": "Services",
    //           "value": "1"
    //         }
    //       },
    //       "Id": "1",
    //       "DetailType": "SalesItemLineDetail"
    //     },
    //     {
    //       "DetailType": "SubTotalLineDetail",
    //       "Amount": 150.0,
    //       "SubTotalLineDetail": {}
    //     }
    //   ],
    //   "ApplyTaxAfterDiscount": false,
    //   "CustomField": [
    //     {
    //       "DefinitionId": "1",
    //       "Type": "StringType",
    //       "Name": "Crew #"
    //     }
    //   ],
    //   "Id": "239",
    //   "TxnTaxDetail": {
    //     "TotalTax": 0
    //   },
    //   "MetaData": {
    //     "CreateTime": "2015-07-24T10:35:08-07:00",
    //     "LastUpdatedTime": "2015-07-24T10:35:08-07:00"
    //   }
    // }
    // 
    // Use the this online tool to generate the code from sample JSON: 
    // Generate Code to Create JSON

    let jsonReq = CkoJsonObject()
    jsonReq.UpdateString("DocNumber", value: "1070")
    jsonReq.UpdateString("SyncToken", value: "0")
    jsonReq.UpdateString("domain", value: "QBO")
    jsonReq.UpdateNumber("Balance", numericStr: "150.0")
    jsonReq.UpdateString("BillAddr.City", value: "Bayshore")
    jsonReq.UpdateString("BillAddr.Line1", value: "4581 Finch St.")
    jsonReq.UpdateString("BillAddr.PostalCode", value: "94326")
    jsonReq.UpdateString("BillAddr.Lat", value: "INVALID")
    jsonReq.UpdateString("BillAddr.Long", value: "INVALID")
    jsonReq.UpdateString("BillAddr.CountrySubDivisionCode", value: "CA")
    jsonReq.UpdateString("BillAddr.Id", value: "2")
    jsonReq.UpdateString("TxnDate", value: "2015-07-24")
    jsonReq.UpdateNumber("TotalAmt", numericStr: "150.0")
    jsonReq.UpdateString("CustomerRef.name", value: "Amy's Bird Sanctuary")
    jsonReq.UpdateString("CustomerRef.value", value: "1")
    jsonReq.UpdateString("CustomerMemo.value", value: "Added customer memo.")
    jsonReq.UpdateString("ShipAddr.City", value: "Bayshore")
    jsonReq.UpdateString("ShipAddr.Line1", value: "4581 Finch St.")
    jsonReq.UpdateString("ShipAddr.PostalCode", value: "94326")
    jsonReq.UpdateString("ShipAddr.Lat", value: "INVALID")
    jsonReq.UpdateString("ShipAddr.Long", value: "INVALID")
    jsonReq.UpdateString("ShipAddr.CountrySubDivisionCode", value: "CA")
    jsonReq.UpdateString("ShipAddr.Id", value: "109")
    jsonReq.UpdateNewArray("LinkedTxn")
    jsonReq.UpdateString("DueDate", value: "2015-08-23")
    jsonReq.UpdateString("PrintStatus", value: "NeedToPrint")
    jsonReq.UpdateString("EmailStatus", value: "NotSet")
    jsonReq.UpdateBool("sparse", value: false)
    jsonReq.UpdateInt("Line[0].LineNum", value: 1)
    jsonReq.UpdateNumber("Line[0].Amount", numericStr: "150.0")
    jsonReq.UpdateString("Line[0].SalesItemLineDetail.TaxCodeRef.value", value: "NON")
    jsonReq.UpdateString("Line[0].SalesItemLineDetail.ItemRef.name", value: "Services")
    jsonReq.UpdateString("Line[0].SalesItemLineDetail.ItemRef.value", value: "1")
    jsonReq.UpdateString("Line[0].Id", value: "1")
    jsonReq.UpdateString("Line[0].DetailType", value: "SalesItemLineDetail")
    jsonReq.UpdateString("Line[1].DetailType", value: "SubTotalLineDetail")
    jsonReq.UpdateNumber("Line[1].Amount", numericStr: "150.0")
    jsonReq.UpdateNewObject("Line[1].SubTotalLineDetail")
    jsonReq.UpdateBool("ApplyTaxAfterDiscount", value: false)
    jsonReq.UpdateString("CustomField[0].DefinitionId", value: "1")
    jsonReq.UpdateString("CustomField[0].Type", value: "StringType")
    jsonReq.UpdateString("CustomField[0].Name", value: "Crew #")
    jsonReq.UpdateString("Id", value: "239")
    jsonReq.UpdateInt("TxnTaxDetail.TotalTax", value: 0)
    jsonReq.UpdateString("MetaData.CreateTime", value: "2015-07-24T10:35:08-07:00")
    jsonReq.UpdateString("MetaData.LastUpdatedTime", value: "2015-07-24T10:35:08-07:00")

    let sbRequestBody = CkoStringBuilder()
    jsonReq.EmitSb(sbRequestBody)

    rest.AddHeader("Content-Type", value: "application/json")
    rest.AddHeader("Accept", value: "application/json")
    rest.AllowHeaderFolding = false

    let sbResponseBody = CkoStringBuilder()
    success = rest.FullRequestSb("POST", uriPath: "/v3/company/<realmID>/invoice", 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(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": {
    //     "TxnDate": "2015-07-24",
    //     "domain": "QBO",
    //     "PrintStatus": "NeedToPrint",
    //     "TotalAmt": 150.0,
    //     "Line": [
    //       {
    //         "LineNum": 1,
    //         "Amount": 150.0,
    //         "SalesItemLineDetail": {
    //           "TaxCodeRef": {
    //             "value": "NON"
    //           },
    //           "ItemRef": {
    //             "name": "Services",
    //             "value": "1"
    //           }
    //         },
    //         "Id": "1",
    //         "DetailType": "SalesItemLineDetail"
    //       },
    //       {
    //         "DetailType": "SubTotalLineDetail",
    //         "Amount": 150.0,
    //         "SubTotalLineDetail": {}
    //       }
    //     ],
    //     "DueDate": "2015-08-23",
    //     "ApplyTaxAfterDiscount": false,
    //     "DocNumber": "1070",
    //     "sparse": false,
    //     "CustomerMemo": {
    //       "value": "Added customer memo."
    //     },
    //     "Deposit": 0,
    //     "Balance": 150.0,
    //     "CustomerRef": {
    //       "name": "Amy's Bird Sanctuary",
    //       "value": "1"
    //     },
    //     "TxnTaxDetail": {
    //       "TotalTax": 0
    //     },
    //     "SyncToken": "1",
    //     "LinkedTxn": [
    //     ],
    //     "ShipAddr": {
    //       "CountrySubDivisionCode": "CA",
    //       "City": "Bayshore",
    //       "PostalCode": "94326",
    //       "Id": "118",
    //       "Line1": "4581 Finch St."
    //     },
    //     "EmailStatus": "NotSet",
    //     "BillAddr": {
    //       "CountrySubDivisionCode": "CA",
    //       "City": "Bayshore",
    //       "PostalCode": "94326",
    //       "Id": "117",
    //       "Line1": "4581 Finch St."
    //     },
    //     "MetaData": {
    //       "CreateTime": "2015-07-24T10:35:08-07:00",
    //       "LastUpdatedTime": "2015-07-24T10:53:39-07:00"
    //     },
    //     "CustomField": [
    //       {
    //         "DefinitionId": "1",
    //         "Type": "StringType",
    //         "Name": "Crew #"
    //       }
    //     ],
    //     "Id": "239"
    //   },
    //   "time": "2015-07-24T10:53:39.287-07:00"
    // }
    // 

    var LineNum: Int
    var Amount: String?
    var SalesItemLineDetailTaxCodeRefValue: String?
    var SalesItemLineDetailItemRefName: String?
    var SalesItemLineDetailItemRefValue: String?
    var Id: String?
    var DetailType: String?
    var DefinitionId: String?
    var invType: String?
    var Name: String?

    var InvoiceTxnDate: String? = jsonResponse.StringOf("Invoice.TxnDate")
    var InvoiceDomain: String? = jsonResponse.StringOf("Invoice.domain")
    var InvoicePrintStatus: String? = jsonResponse.StringOf("Invoice.PrintStatus")
    var InvoiceTotalAmt: String? = jsonResponse.StringOf("Invoice.TotalAmt")
    var InvoiceDueDate: String? = jsonResponse.StringOf("Invoice.DueDate")
    var InvoiceApplyTaxAfterDiscount: Bool = jsonResponse.BoolOf("Invoice.ApplyTaxAfterDiscount")
    var InvoiceDocNumber: String? = jsonResponse.StringOf("Invoice.DocNumber")
    var InvoiceSparse: Bool = jsonResponse.BoolOf("Invoice.sparse")
    var InvoiceCustomerMemoValue: String? = jsonResponse.StringOf("Invoice.CustomerMemo.value")
    var InvoiceDeposit: Int = jsonResponse.IntOf("Invoice.Deposit").intValue
    var InvoiceBalance: String? = jsonResponse.StringOf("Invoice.Balance")
    var InvoiceCustomerRefName: String? = jsonResponse.StringOf("Invoice.CustomerRef.name")
    var InvoiceCustomerRefValue: String? = jsonResponse.StringOf("Invoice.CustomerRef.value")
    var InvoiceTxnTaxDetailTotalTax: Int = jsonResponse.IntOf("Invoice.TxnTaxDetail.TotalTax").intValue
    var InvoiceSyncToken: String? = jsonResponse.StringOf("Invoice.SyncToken")
    var InvoiceShipAddrCountrySubDivisionCode: String? = jsonResponse.StringOf("Invoice.ShipAddr.CountrySubDivisionCode")
    var InvoiceShipAddrCity: String? = jsonResponse.StringOf("Invoice.ShipAddr.City")
    var InvoiceShipAddrPostalCode: String? = jsonResponse.StringOf("Invoice.ShipAddr.PostalCode")
    var InvoiceShipAddrId: String? = jsonResponse.StringOf("Invoice.ShipAddr.Id")
    var InvoiceShipAddrLine1: String? = jsonResponse.StringOf("Invoice.ShipAddr.Line1")
    var InvoiceEmailStatus: String? = jsonResponse.StringOf("Invoice.EmailStatus")
    var InvoiceBillAddrCountrySubDivisionCode: String? = jsonResponse.StringOf("Invoice.BillAddr.CountrySubDivisionCode")
    var InvoiceBillAddrCity: String? = jsonResponse.StringOf("Invoice.BillAddr.City")
    var InvoiceBillAddrPostalCode: String? = jsonResponse.StringOf("Invoice.BillAddr.PostalCode")
    var InvoiceBillAddrId: String? = jsonResponse.StringOf("Invoice.BillAddr.Id")
    var InvoiceBillAddrLine1: String? = jsonResponse.StringOf("Invoice.BillAddr.Line1")
    var InvoiceMetaDataCreateTime: String? = jsonResponse.StringOf("Invoice.MetaData.CreateTime")
    var InvoiceMetaDataLastUpdatedTime: String? = jsonResponse.StringOf("Invoice.MetaData.LastUpdatedTime")
    var InvoiceId: String? = jsonResponse.StringOf("Invoice.Id")
    var time: String? = jsonResponse.StringOf("time")
    var i: Int = 0
    var count_i: Int = jsonResponse.SizeOfArray("Invoice.Line").intValue
    while i < count_i {
        jsonResponse.I = i
        LineNum = jsonResponse.IntOf("Invoice.Line[i].LineNum").intValue
        Amount = jsonResponse.StringOf("Invoice.Line[i].Amount")
        SalesItemLineDetailTaxCodeRefValue = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value")
        SalesItemLineDetailItemRefName = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.name")
        SalesItemLineDetailItemRefValue = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.value")
        Id = jsonResponse.StringOf("Invoice.Line[i].Id")
        DetailType = jsonResponse.StringOf("Invoice.Line[i].DetailType")
        i = i + 1
    }

    i = 0
    count_i = jsonResponse.SizeOfArray("Invoice.LinkedTxn").intValue
    while i < count_i {
        jsonResponse.I = i
        i = i + 1
    }

    i = 0
    count_i = jsonResponse.SizeOfArray("Invoice.CustomField").intValue
    while i < count_i {
        jsonResponse.I = i
        DefinitionId = jsonResponse.StringOf("Invoice.CustomField[i].DefinitionId")
        invType = jsonResponse.StringOf("Invoice.CustomField[i].Type")
        Name = jsonResponse.StringOf("Invoice.CustomField[i].Name")
        i = i + 1
    }


}