Swift
Swift
Quickbooks Update an Invoice
See more QuickBooks Examples
Demonstrates how to update an invoice using the Quickbooks REST API.Chilkat Swift Downloads
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:
// {
// "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(jsonPath: "DocNumber", value: "1070")
jsonReq.updateString(jsonPath: "SyncToken", value: "0")
jsonReq.updateString(jsonPath: "domain", value: "QBO")
jsonReq.updateNumber(jsonPath: "Balance", numericStr: "150.0")
jsonReq.updateString(jsonPath: "BillAddr.City", value: "Bayshore")
jsonReq.updateString(jsonPath: "BillAddr.Line1", value: "4581 Finch St.")
jsonReq.updateString(jsonPath: "BillAddr.PostalCode", value: "94326")
jsonReq.updateString(jsonPath: "BillAddr.Lat", value: "INVALID")
jsonReq.updateString(jsonPath: "BillAddr.Long", value: "INVALID")
jsonReq.updateString(jsonPath: "BillAddr.CountrySubDivisionCode", value: "CA")
jsonReq.updateString(jsonPath: "BillAddr.Id", value: "2")
jsonReq.updateString(jsonPath: "TxnDate", value: "2015-07-24")
jsonReq.updateNumber(jsonPath: "TotalAmt", numericStr: "150.0")
jsonReq.updateString(jsonPath: "CustomerRef.name", value: "Amy's Bird Sanctuary")
jsonReq.updateString(jsonPath: "CustomerRef.value", value: "1")
jsonReq.updateString(jsonPath: "CustomerMemo.value", value: "Added customer memo.")
jsonReq.updateString(jsonPath: "ShipAddr.City", value: "Bayshore")
jsonReq.updateString(jsonPath: "ShipAddr.Line1", value: "4581 Finch St.")
jsonReq.updateString(jsonPath: "ShipAddr.PostalCode", value: "94326")
jsonReq.updateString(jsonPath: "ShipAddr.Lat", value: "INVALID")
jsonReq.updateString(jsonPath: "ShipAddr.Long", value: "INVALID")
jsonReq.updateString(jsonPath: "ShipAddr.CountrySubDivisionCode", value: "CA")
jsonReq.updateString(jsonPath: "ShipAddr.Id", value: "109")
jsonReq.updateNewArray(jsonPath: "LinkedTxn")
jsonReq.updateString(jsonPath: "DueDate", value: "2015-08-23")
jsonReq.updateString(jsonPath: "PrintStatus", value: "NeedToPrint")
jsonReq.updateString(jsonPath: "EmailStatus", value: "NotSet")
jsonReq.updateBool(jsonPath: "sparse", value: false)
jsonReq.updateInt(jsonPath: "Line[0].LineNum", value: 1)
jsonReq.updateNumber(jsonPath: "Line[0].Amount", numericStr: "150.0")
jsonReq.updateString(jsonPath: "Line[0].SalesItemLineDetail.TaxCodeRef.value", value: "NON")
jsonReq.updateString(jsonPath: "Line[0].SalesItemLineDetail.ItemRef.name", value: "Services")
jsonReq.updateString(jsonPath: "Line[0].SalesItemLineDetail.ItemRef.value", value: "1")
jsonReq.updateString(jsonPath: "Line[0].Id", value: "1")
jsonReq.updateString(jsonPath: "Line[0].DetailType", value: "SalesItemLineDetail")
jsonReq.updateString(jsonPath: "Line[1].DetailType", value: "SubTotalLineDetail")
jsonReq.updateNumber(jsonPath: "Line[1].Amount", numericStr: "150.0")
jsonReq.updateNew(jsonPath: "Line[1].SubTotalLineDetail")
jsonReq.updateBool(jsonPath: "ApplyTaxAfterDiscount", value: false)
jsonReq.updateString(jsonPath: "CustomField[0].DefinitionId", value: "1")
jsonReq.updateString(jsonPath: "CustomField[0].Type", value: "StringType")
jsonReq.updateString(jsonPath: "CustomField[0].Name", value: "Crew #")
jsonReq.updateString(jsonPath: "Id", value: "239")
jsonReq.updateInt(jsonPath: "TxnTaxDetail.TotalTax", value: 0)
jsonReq.updateString(jsonPath: "MetaData.CreateTime", value: "2015-07-24T10:35:08-07:00")
jsonReq.updateString(jsonPath: "MetaData.LastUpdatedTime", value: "2015-07-24T10:35:08-07:00")
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", 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": {
// "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.string(of: "Invoice.TxnDate")
var InvoiceDomain: String? = jsonResponse.string(of: "Invoice.domain")
var InvoicePrintStatus: String? = jsonResponse.string(of: "Invoice.PrintStatus")
var InvoiceTotalAmt: String? = jsonResponse.string(of: "Invoice.TotalAmt")
var InvoiceDueDate: String? = jsonResponse.string(of: "Invoice.DueDate")
var InvoiceApplyTaxAfterDiscount: Bool = jsonResponse.bool(of: "Invoice.ApplyTaxAfterDiscount")
var InvoiceDocNumber: String? = jsonResponse.string(of: "Invoice.DocNumber")
var InvoiceSparse: Bool = jsonResponse.bool(of: "Invoice.sparse")
var InvoiceCustomerMemoValue: String? = jsonResponse.string(of: "Invoice.CustomerMemo.value")
var InvoiceDeposit: Int = jsonResponse.int(of: "Invoice.Deposit").intValue
var InvoiceBalance: String? = jsonResponse.string(of: "Invoice.Balance")
var InvoiceCustomerRefName: String? = jsonResponse.string(of: "Invoice.CustomerRef.name")
var InvoiceCustomerRefValue: String? = jsonResponse.string(of: "Invoice.CustomerRef.value")
var InvoiceTxnTaxDetailTotalTax: Int = jsonResponse.int(of: "Invoice.TxnTaxDetail.TotalTax").intValue
var InvoiceSyncToken: String? = jsonResponse.string(of: "Invoice.SyncToken")
var InvoiceShipAddrCountrySubDivisionCode: String? = jsonResponse.string(of: "Invoice.ShipAddr.CountrySubDivisionCode")
var InvoiceShipAddrCity: String? = jsonResponse.string(of: "Invoice.ShipAddr.City")
var InvoiceShipAddrPostalCode: String? = jsonResponse.string(of: "Invoice.ShipAddr.PostalCode")
var InvoiceShipAddrId: String? = jsonResponse.string(of: "Invoice.ShipAddr.Id")
var InvoiceShipAddrLine1: String? = jsonResponse.string(of: "Invoice.ShipAddr.Line1")
var InvoiceEmailStatus: String? = jsonResponse.string(of: "Invoice.EmailStatus")
var InvoiceBillAddrCountrySubDivisionCode: String? = jsonResponse.string(of: "Invoice.BillAddr.CountrySubDivisionCode")
var InvoiceBillAddrCity: String? = jsonResponse.string(of: "Invoice.BillAddr.City")
var InvoiceBillAddrPostalCode: String? = jsonResponse.string(of: "Invoice.BillAddr.PostalCode")
var InvoiceBillAddrId: String? = jsonResponse.string(of: "Invoice.BillAddr.Id")
var InvoiceBillAddrLine1: String? = jsonResponse.string(of: "Invoice.BillAddr.Line1")
var InvoiceMetaDataCreateTime: String? = jsonResponse.string(of: "Invoice.MetaData.CreateTime")
var InvoiceMetaDataLastUpdatedTime: String? = jsonResponse.string(of: "Invoice.MetaData.LastUpdatedTime")
var InvoiceId: String? = jsonResponse.string(of: "Invoice.Id")
var time: String? = jsonResponse.string(of: "time")
var i: Int = 0
var count_i: Int = 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.LinkedTxn").intValue
while i < count_i {
jsonResponse.i = i
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
}
}