(Swift 2) Quickbooks Send an Invoice

Demonstrates how to send 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#send-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.
    // --------------------------------------------------------------------------

    // Technically, the POST has an empty request body, but the Quickbooks documentation indicates that 
    // the Content-Type header should be set to "application/octet-stream", which really makes no sense
    // because there is not content. (How can no content have a type???)
    rest.AddHeader("Content-Type", value: "application/octet-stream")
    rest.AllowHeaderFolding = false

    let sbResponseBody = CkoStringBuilder()
    success = rest.FullRequestNoBodySb("POST", uriPath: "/v3/company/<realmID>/invoice/<invoiceId>/send?sendTo=<emailAddr>", sb: 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": "2013-03-14",
    //     "domain": "QBO",
    //     "CurrencyRef": {
    //       "name": "United States Dollar",
    //       "value": "USD"
    //     },
    //     "ShipDate": "2013-03-01",
    //     "TrackingNum": "123456789",
    //     "ClassRef": {
    //       "name": "Class 1",
    //       "value": "200900000000000003901"
    //     },
    //     "PrintStatus": "NeedToPrint",
    //     "SalesTermRef": {
    //       "value": "4"
    //     },
    //     "DeliveryInfo": {
    //       "DeliveryType": "Email",
    //       "DeliveryTime": "2014-12-17T11:50:52-08:00"
    //     },
    //     "TotalAmt": 52.0,
    //     "Line": [
    //       {
    //         "Description": "Sample invoice create request",
    //         "DetailType": "SalesItemLineDetail",
    //         "SalesItemLineDetail": {
    //           "TaxCodeRef": {
    //             "value": "TAX"
    //           },
    //           "Qty": 1,
    //           "UnitPrice": 50,
    //           "ServiceDate": "2013-03-04",
    //           "ItemRef": {
    //             "name": "Hours",
    //             "value": "2"
    //           }
    //         },
    //         "LineNum": 1,
    //         "Amount": 50.0,
    //         "Id": "1"
    //       },
    //       {
    //         "DetailType": "SubTotalLineDetail",
    //         "Amount": 50.0,
    //         "SubTotalLineDetail": {}
    //       },
    //       {
    //         "DetailType": "DiscountLineDetail",
    //         "Amount": 5.0,
    //         "DiscountLineDetail": {
    //           "DiscountAccountRef": {
    //             "name": "Discounts given",
    //             "value": "30"
    //           },
    //           "PercentBased": true,
    //           "DiscountPercent": 10
    //         }
    //       },
    //       {
    //         "DetailType": "SalesItemLineDetail",
    //         "Amount": 2.0,
    //         "SalesItemLineDetail": {
    //           "ItemRef": {
    //             "value": "SHIPPING_ITEM_ID"
    //           }
    //         }
    //       }
    //     ],
    //     "DueDate": "2013-05-13",
    //     "MetaData": {
    //       "CreateTime": "2013-03-14T01:42:16-07:00",
    //       "LastUpdatedTime": "2014-12-17T11:50:58-08:00"
    //     },
    //     "DocNumber": "Sample_Inv#2",
    //     "PrivateNote": "Summary for sample invoice",
    //     "sparse": false,
    //     "DepositToAccountRef": {
    //       "name": "Undeposited Funds",
    //       "value": "4"
    //     },
    //     "CustomerMemo": {
    //       "value": "This is the customer message"
    //     },
    //     "EmailStatus": "EmailSent",
    //     "Deposit": 12.0,
    //     "Balance": 40.0,
    //     "CustomerRef": {
    //       "name": "Mr V3 Service Customer Jr2",
    //       "value": "15"
    //     },
    //     "TxnTaxDetail": {
    //       "TxnTaxCodeRef": {
    //         "value": "5"
    //       },
    //       "TotalTax": 5.0,
    //       "TaxLine": [
    //         {
    //           "DetailType": "TaxLineDetail",
    //           "Amount": 5.0,
    //           "TaxLineDetail": {
    //             "NetAmountTaxable": 50.0,
    //             "TaxPercent": 10,
    //             "TaxRateRef": {
    //               "value": "2"
    //             },
    //             "PercentBased": true
    //           }
    //         }
    //       ]
    //     },
    //     "SyncToken": "0",
    //     "BillEmail": {
    //       "Address": "test@intuit.com"
    //     },
    //     "ShipAddr": {
    //       "City": "San Jose",
    //       "Country": "USA",
    //       "Line5": "Cube 999",
    //       "Line4": "Dept 12",
    //       "Line3": "123 street",
    //       "Line2": "Building 1",
    //       "Line1": "Intuit",
    //       "PostalCode": "95123",
    //       "Lat": "37.2374847",
    //       "Long": "-121.8277925",
    //       "CountrySubDivisionCode": "CA",
    //       "Id": "36"
    //     },
    //     "DepartmentRef": {
    //       "name": "Mountain View",
    //       "value": "1"
    //     },
    //     "ShipMethodRef": {
    //       "name": "UPS",
    //       "value": "UPS"
    //     },
    //     "BillAddr": {
    //       "City": "Mountain View",
    //       "Country": "USA",
    //       "Line5": "Cube 999",
    //       "Line4": "Dept 12",
    //       "Line3": "123 street",
    //       "Line2": "Building 1",
    //       "Line1": "Google",
    //       "PostalCode": "95123",
    //       "Lat": "37.2374847",
    //       "Long": "-121.8277925",
    //       "CountrySubDivisionCode": "CA",
    //       "Id": "35"
    //     },
    //     "ApplyTaxAfterDiscount": false,
    //     "CustomField": [
    //       {
    //         "StringValue": "Custom1",
    //         "Type": "StringType",
    //         "Name": "Custom 1"
    //       },
    //       {
    //         "StringValue": "Custom2",
    //         "Type": "StringType",
    //         "Name": "Custom 2"
    //       },
    //       {
    //         "StringValue": "Custom3",
    //         "Type": "StringType",
    //         "Name": "Custom 3"
    //       }
    //     ],
    //     "Id": "96"
    //   },
    //   "time": "2013-03-14T13:32:04.895-07:00"
    // }
    // 

    var Description: String?
    var DetailType: String?
    var SalesItemLineDetailTaxCodeRefValue: String?
    var SalesItemLineDetailQty: Int
    var SalesItemLineDetailUnitPrice: Int
    var SalesItemLineDetailServiceDate: String?
    var SalesItemLineDetailItemRefName: String?
    var SalesItemLineDetailItemRefValue: String?
    var LineNum: Int
    var Amount: String?
    var Id: String?
    var DiscountLineDetailDiscountAccountRefName: String?
    var DiscountLineDetailDiscountAccountRefValue: String?
    var DiscountLineDetailPercentBased: Bool
    var DiscountLineDetailDiscountPercent: Int
    var TaxLineDetailNetAmountTaxable: String?
    var TaxLineDetailTaxPercent: Int
    var TaxLineDetailTaxRateRefValue: String?
    var TaxLineDetailPercentBased: Bool
    var StringValue: String?
    var Type: String?
    var Name: String?

    var InvoiceTxnDate: String? = jsonResponse.StringOf("Invoice.TxnDate")
    var InvoiceDomain: String? = jsonResponse.StringOf("Invoice.domain")
    var InvoiceCurrencyRefName: String? = jsonResponse.StringOf("Invoice.CurrencyRef.name")
    var InvoiceCurrencyRefValue: String? = jsonResponse.StringOf("Invoice.CurrencyRef.value")
    var InvoiceShipDate: String? = jsonResponse.StringOf("Invoice.ShipDate")
    var InvoiceTrackingNum: String? = jsonResponse.StringOf("Invoice.TrackingNum")
    var InvoiceClassRefName: String? = jsonResponse.StringOf("Invoice.ClassRef.name")
    var InvoiceClassRefValue: String? = jsonResponse.StringOf("Invoice.ClassRef.value")
    var InvoicePrintStatus: String? = jsonResponse.StringOf("Invoice.PrintStatus")
    var InvoiceSalesTermRefValue: String? = jsonResponse.StringOf("Invoice.SalesTermRef.value")
    var InvoiceDeliveryInfoDeliveryType: String? = jsonResponse.StringOf("Invoice.DeliveryInfo.DeliveryType")
    var InvoiceDeliveryInfoDeliveryTime: String? = jsonResponse.StringOf("Invoice.DeliveryInfo.DeliveryTime")
    var InvoiceTotalAmt: String? = jsonResponse.StringOf("Invoice.TotalAmt")
    var InvoiceDueDate: String? = jsonResponse.StringOf("Invoice.DueDate")
    var InvoiceMetaDataCreateTime: String? = jsonResponse.StringOf("Invoice.MetaData.CreateTime")
    var InvoiceMetaDataLastUpdatedTime: String? = jsonResponse.StringOf("Invoice.MetaData.LastUpdatedTime")
    var InvoiceDocNumber: String? = jsonResponse.StringOf("Invoice.DocNumber")
    var InvoicePrivateNote: String? = jsonResponse.StringOf("Invoice.PrivateNote")
    var InvoiceSparse: Bool = jsonResponse.BoolOf("Invoice.sparse")
    var InvoiceDepositToAccountRefName: String? = jsonResponse.StringOf("Invoice.DepositToAccountRef.name")
    var InvoiceDepositToAccountRefValue: String? = jsonResponse.StringOf("Invoice.DepositToAccountRef.value")
    var InvoiceCustomerMemoValue: String? = jsonResponse.StringOf("Invoice.CustomerMemo.value")
    var InvoiceEmailStatus: String? = jsonResponse.StringOf("Invoice.EmailStatus")
    var InvoiceDeposit: String? = jsonResponse.StringOf("Invoice.Deposit")
    var InvoiceBalance: String? = jsonResponse.StringOf("Invoice.Balance")
    var InvoiceCustomerRefName: String? = jsonResponse.StringOf("Invoice.CustomerRef.name")
    var InvoiceCustomerRefValue: String? = jsonResponse.StringOf("Invoice.CustomerRef.value")
    var InvoiceTxnTaxDetailTxnTaxCodeRefValue: String? = jsonResponse.StringOf("Invoice.TxnTaxDetail.TxnTaxCodeRef.value")
    var InvoiceTxnTaxDetailTotalTax: String? = jsonResponse.StringOf("Invoice.TxnTaxDetail.TotalTax")
    var InvoiceSyncToken: String? = jsonResponse.StringOf("Invoice.SyncToken")
    var InvoiceBillEmailAddress: String? = jsonResponse.StringOf("Invoice.BillEmail.Address")
    var InvoiceShipAddrCity: String? = jsonResponse.StringOf("Invoice.ShipAddr.City")
    var InvoiceShipAddrCountry: String? = jsonResponse.StringOf("Invoice.ShipAddr.Country")
    var InvoiceShipAddrLine5: String? = jsonResponse.StringOf("Invoice.ShipAddr.Line5")
    var InvoiceShipAddrLine4: String? = jsonResponse.StringOf("Invoice.ShipAddr.Line4")
    var InvoiceShipAddrLine3: String? = jsonResponse.StringOf("Invoice.ShipAddr.Line3")
    var InvoiceShipAddrLine2: String? = jsonResponse.StringOf("Invoice.ShipAddr.Line2")
    var InvoiceShipAddrLine1: String? = jsonResponse.StringOf("Invoice.ShipAddr.Line1")
    var InvoiceShipAddrPostalCode: String? = jsonResponse.StringOf("Invoice.ShipAddr.PostalCode")
    var InvoiceShipAddrLat: String? = jsonResponse.StringOf("Invoice.ShipAddr.Lat")
    var InvoiceShipAddrLong: String? = jsonResponse.StringOf("Invoice.ShipAddr.Long")
    var InvoiceShipAddrCountrySubDivisionCode: String? = jsonResponse.StringOf("Invoice.ShipAddr.CountrySubDivisionCode")
    var InvoiceShipAddrId: String? = jsonResponse.StringOf("Invoice.ShipAddr.Id")
    var InvoiceDepartmentRefName: String? = jsonResponse.StringOf("Invoice.DepartmentRef.name")
    var InvoiceDepartmentRefValue: String? = jsonResponse.StringOf("Invoice.DepartmentRef.value")
    var InvoiceShipMethodRefName: String? = jsonResponse.StringOf("Invoice.ShipMethodRef.name")
    var InvoiceShipMethodRefValue: String? = jsonResponse.StringOf("Invoice.ShipMethodRef.value")
    var InvoiceBillAddrCity: String? = jsonResponse.StringOf("Invoice.BillAddr.City")
    var InvoiceBillAddrCountry: String? = jsonResponse.StringOf("Invoice.BillAddr.Country")
    var InvoiceBillAddrLine5: String? = jsonResponse.StringOf("Invoice.BillAddr.Line5")
    var InvoiceBillAddrLine4: String? = jsonResponse.StringOf("Invoice.BillAddr.Line4")
    var InvoiceBillAddrLine3: String? = jsonResponse.StringOf("Invoice.BillAddr.Line3")
    var InvoiceBillAddrLine2: String? = jsonResponse.StringOf("Invoice.BillAddr.Line2")
    var InvoiceBillAddrLine1: String? = jsonResponse.StringOf("Invoice.BillAddr.Line1")
    var InvoiceBillAddrPostalCode: String? = jsonResponse.StringOf("Invoice.BillAddr.PostalCode")
    var InvoiceBillAddrLat: String? = jsonResponse.StringOf("Invoice.BillAddr.Lat")
    var InvoiceBillAddrLong: String? = jsonResponse.StringOf("Invoice.BillAddr.Long")
    var InvoiceBillAddrCountrySubDivisionCode: String? = jsonResponse.StringOf("Invoice.BillAddr.CountrySubDivisionCode")
    var InvoiceBillAddrId: String? = jsonResponse.StringOf("Invoice.BillAddr.Id")
    var InvoiceApplyTaxAfterDiscount: Bool = jsonResponse.BoolOf("Invoice.ApplyTaxAfterDiscount")
    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
        Description = jsonResponse.StringOf("Invoice.Line[i].Description")
        DetailType = jsonResponse.StringOf("Invoice.Line[i].DetailType")
        SalesItemLineDetailTaxCodeRefValue = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value")
        SalesItemLineDetailQty = jsonResponse.IntOf("Invoice.Line[i].SalesItemLineDetail.Qty").intValue
        SalesItemLineDetailUnitPrice = jsonResponse.IntOf("Invoice.Line[i].SalesItemLineDetail.UnitPrice").intValue
        SalesItemLineDetailServiceDate = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ServiceDate")
        SalesItemLineDetailItemRefName = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.name")
        SalesItemLineDetailItemRefValue = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.value")
        LineNum = jsonResponse.IntOf("Invoice.Line[i].LineNum").intValue
        Amount = jsonResponse.StringOf("Invoice.Line[i].Amount")
        Id = jsonResponse.StringOf("Invoice.Line[i].Id")
        DiscountLineDetailDiscountAccountRefName = jsonResponse.StringOf("Invoice.Line[i].DiscountLineDetail.DiscountAccountRef.name")
        DiscountLineDetailDiscountAccountRefValue = jsonResponse.StringOf("Invoice.Line[i].DiscountLineDetail.DiscountAccountRef.value")
        DiscountLineDetailPercentBased = jsonResponse.BoolOf("Invoice.Line[i].DiscountLineDetail.PercentBased")
        DiscountLineDetailDiscountPercent = jsonResponse.IntOf("Invoice.Line[i].DiscountLineDetail.DiscountPercent").intValue
        i = i + 1
    }

    i = 0
    count_i = jsonResponse.SizeOfArray("Invoice.TxnTaxDetail.TaxLine").intValue
    while i < count_i {
        jsonResponse.I = i
        DetailType = jsonResponse.StringOf("Invoice.TxnTaxDetail.TaxLine[i].DetailType")
        Amount = jsonResponse.StringOf("Invoice.TxnTaxDetail.TaxLine[i].Amount")
        TaxLineDetailNetAmountTaxable = jsonResponse.StringOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.NetAmountTaxable")
        TaxLineDetailTaxPercent = jsonResponse.IntOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.TaxPercent").intValue
        TaxLineDetailTaxRateRefValue = jsonResponse.StringOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.TaxRateRef.value")
        TaxLineDetailPercentBased = jsonResponse.BoolOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.PercentBased")
        i = i + 1
    }

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


}