(Swift 3,4,5...) Quickbooks Create an Invoice

Demonstrates how to create an invoice via the Quickbooks REST API.

For more information, see https://www.developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/invoice#create-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.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:

    // {
    //   "Line": [
    //     {
    //       "DetailType": "SalesItemLineDetail",
    //       "Amount": 100.0,
    //       "SalesItemLineDetail": {
    //         "ItemRef": {
    //           "name": "Services",
    //           "value": "1"
    //         }
    //       }
    //     }
    //   ],
    //   "CustomerRef": {
    //     "value": "1"
    //   }
    // }
    // 
    // Use the this online tool to generate the code from sample JSON: 
    // Generate Code to Create JSON

    let jsonReq = CkoJsonObject()!
    jsonReq.update("Line[0].DetailType", value: "SalesItemLineDetail")
    jsonReq.updateNumber("Line[0].Amount", numericStr: "100.0")
    jsonReq.update("Line[0].SalesItemLineDetail.ItemRef.name", value: "Services")
    jsonReq.update("Line[0].SalesItemLineDetail.ItemRef.value", value: "1")
    jsonReq.update("CustomerRef.value", value: "1")

    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": {
    //     "DocNumber": "1069",
    //     "SyncToken": "0",
    //     "domain": "QBO",
    //     "Balance": 100.0,
    //     "BillAddr": {
    //       "City": "Bayshore",
    //       "Line1": "4581 Finch St.",
    //       "PostalCode": "94326",
    //       "Lat": "INVALID",
    //       "Long": "INVALID",
    //       "CountrySubDivisionCode": "CA",
    //       "Id": "2"
    //     },
    //     "TxnDate": "2015-07-24",
    //     "TotalAmt": 100.0,
    //     "CustomerRef": {
    //       "name": "Amy's Bird Sanctuary",
    //       "value": "1"
    //     },
    //     "ShipAddr": {
    //       "City": "Bayshore",
    //       "Line1": "4581 Finch St.",
    //       "PostalCode": "94326",
    //       "Lat": "INVALID",
    //       "Long": "INVALID",
    //       "CountrySubDivisionCode": "CA",
    //       "Id": "109"
    //     },
    //     "LinkedTxn": [
    //     ],
    //     "DueDate": "2015-08-23",
    //     "PrintStatus": "NeedToPrint",
    //     "Deposit": 0,
    //     "sparse": false,
    //     "EmailStatus": "NotSet",
    //     "Line": [
    //       {
    //         "LineNum": 1,
    //         "Amount": 100.0,
    //         "SalesItemLineDetail": {
    //           "TaxCodeRef": {
    //             "value": "NON"
    //           },
    //           "ItemRef": {
    //             "name": "Services",
    //             "value": "1"
    //           }
    //         },
    //         "Id": "1",
    //         "DetailType": "SalesItemLineDetail"
    //       },
    //       {
    //         "DetailType": "SubTotalLineDetail",
    //         "Amount": 100.0,
    //         "SubTotalLineDetail": {}
    //       }
    //     ],
    //     "ApplyTaxAfterDiscount": false,
    //     "CustomField": [
    //       {
    //         "DefinitionId": "1",
    //         "Type": "StringType",
    //         "Name": "Crew #"
    //       }
    //     ],
    //     "Id": "238",
    //     "TxnTaxDetail": {
    //       "TotalTax": 0
    //     },
    //     "MetaData": {
    //       "CreateTime": "2015-07-24T10:33:39-07:00",
    //       "LastUpdatedTime": "2015-07-24T10:33:39-07:00"
    //     }
    //   },
    //   "time": "2015-07-24T10:33:39.11-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 InvoiceDocNumber: String? = jsonResponse.string(of: "Invoice.DocNumber")
    var InvoiceSyncToken: String? = jsonResponse.string(of: "Invoice.SyncToken")
    var InvoiceDomain: String? = jsonResponse.string(of: "Invoice.domain")
    var InvoiceBalance: String? = jsonResponse.string(of: "Invoice.Balance")
    var InvoiceBillAddrCity: String? = jsonResponse.string(of: "Invoice.BillAddr.City")
    var InvoiceBillAddrLine1: String? = jsonResponse.string(of: "Invoice.BillAddr.Line1")
    var InvoiceBillAddrPostalCode: String? = jsonResponse.string(of: "Invoice.BillAddr.PostalCode")
    var InvoiceBillAddrLat: String? = jsonResponse.string(of: "Invoice.BillAddr.Lat")
    var InvoiceBillAddrLong: String? = jsonResponse.string(of: "Invoice.BillAddr.Long")
    var InvoiceBillAddrCountrySubDivisionCode: String? = jsonResponse.string(of: "Invoice.BillAddr.CountrySubDivisionCode")
    var InvoiceBillAddrId: String? = jsonResponse.string(of: "Invoice.BillAddr.Id")
    var InvoiceTxnDate: String? = jsonResponse.string(of: "Invoice.TxnDate")
    var InvoiceTotalAmt: String? = jsonResponse.string(of: "Invoice.TotalAmt")
    var InvoiceCustomerRefName: String? = jsonResponse.string(of: "Invoice.CustomerRef.name")
    var InvoiceCustomerRefValue: String? = jsonResponse.string(of: "Invoice.CustomerRef.value")
    var InvoiceShipAddrCity: String? = jsonResponse.string(of: "Invoice.ShipAddr.City")
    var InvoiceShipAddrLine1: String? = jsonResponse.string(of: "Invoice.ShipAddr.Line1")
    var InvoiceShipAddrPostalCode: String? = jsonResponse.string(of: "Invoice.ShipAddr.PostalCode")
    var InvoiceShipAddrLat: String? = jsonResponse.string(of: "Invoice.ShipAddr.Lat")
    var InvoiceShipAddrLong: String? = jsonResponse.string(of: "Invoice.ShipAddr.Long")
    var InvoiceShipAddrCountrySubDivisionCode: String? = jsonResponse.string(of: "Invoice.ShipAddr.CountrySubDivisionCode")
    var InvoiceShipAddrId: String? = jsonResponse.string(of: "Invoice.ShipAddr.Id")
    var InvoiceDueDate: String? = jsonResponse.string(of: "Invoice.DueDate")
    var InvoicePrintStatus: String? = jsonResponse.string(of: "Invoice.PrintStatus")
    var InvoiceDeposit: Int = jsonResponse.int(of: "Invoice.Deposit").intValue
    var InvoiceSparse: Bool = jsonResponse.bool(of: "Invoice.sparse")
    var InvoiceEmailStatus: String? = jsonResponse.string(of: "Invoice.EmailStatus")
    var InvoiceApplyTaxAfterDiscount: Bool = jsonResponse.bool(of: "Invoice.ApplyTaxAfterDiscount")
    var InvoiceId: String? = jsonResponse.string(of: "Invoice.Id")
    var InvoiceTxnTaxDetailTotalTax: Int = jsonResponse.int(of: "Invoice.TxnTaxDetail.TotalTax").intValue
    var InvoiceMetaDataCreateTime: String? = jsonResponse.string(of: "Invoice.MetaData.CreateTime")
    var InvoiceMetaDataLastUpdatedTime: String? = jsonResponse.string(of: "Invoice.MetaData.LastUpdatedTime")
    var time: String? = jsonResponse.string(of: "time")
    var i: Int = 0
    var count_i: Int = jsonResponse.size(ofArray: "Invoice.LinkedTxn").intValue
    while i < count_i {
        jsonResponse.i = i
        i = i + 1
    }

    i = 0
    count_i = jsonResponse.size(ofArray: "Invoice.Line").intValue
    while i < count_i {
        jsonResponse.i = i
        LineNum = jsonResponse.int(of: "Invoice.Line[i].LineNum").intValue
        Amount = jsonResponse.string(of: "Invoice.Line[i].Amount")
        SalesItemLineDetailTaxCodeRefValue = jsonResponse.string(of: "Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value")
        SalesItemLineDetailItemRefName = jsonResponse.string(of: "Invoice.Line[i].SalesItemLineDetail.ItemRef.name")
        SalesItemLineDetailItemRefValue = jsonResponse.string(of: "Invoice.Line[i].SalesItemLineDetail.ItemRef.value")
        Id = jsonResponse.string(of: "Invoice.Line[i].Id")
        DetailType = jsonResponse.string(of: "Invoice.Line[i].DetailType")
        i = i + 1
    }

    i = 0
    count_i = jsonResponse.size(ofArray: "Invoice.CustomField").intValue
    while i < count_i {
        jsonResponse.i = i
        DefinitionId = jsonResponse.string(of: "Invoice.CustomField[i].DefinitionId")
        invType = jsonResponse.string(of: "Invoice.CustomField[i].Type")
        Name = jsonResponse.string(of: "Invoice.CustomField[i].Name")
        i = i + 1
    }


}