(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// 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.
Dim jsonToken As New Chilkat.JsonObject
Dim success As Boolean
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

Dim rest As New Chilkat.Rest

// Connect to the REST server.
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
bAutoReconnect = True
Dim success As Boolean
success = rest.Connect("sandbox-quickbooks.api.intuit.com",port,bTls,bAutoReconnect)

Dim sbAuth As New Chilkat.StringBuilder
success = sbAuth.Append("Bearer ")
success = 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

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

Dim sbRequestBody As New Chilkat.StringBuilder
success = jsonReq.EmitSb(sbRequestBody)

success = rest.AddHeader("Content-Type","application/json")
success = rest.AddHeader("Accept","application/json")
rest.AllowHeaderFolding = False

Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestSb("POST","/v3/company/<realmID>/invoice",sbRequestBody,sbResponseBody)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim respStatusCode As Int32
respStatusCode = rest.ResponseStatusCode

// Success is indicated by a 200 response status code.
System.DebugLog("response status code = " + Str(respStatusCode))

Dim jsonResponse As New Chilkat.JsonObject
success = jsonResponse.LoadSb(sbResponseBody)
jsonResponse.EmitCompact = False
System.DebugLog(jsonResponse.Emit())

If (rest.ResponseStatusCode <> 200) Then
    System.DebugLog("Failed.")
    Return
End If

// 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"
// }
// 

Dim LineNum As Int32
Dim Amount As String
Dim SalesItemLineDetailTaxCodeRefValue As String
Dim SalesItemLineDetailItemRefName As String
Dim SalesItemLineDetailItemRefValue As String
Dim Id As String
Dim DetailType As String
Dim DefinitionId As String
Dim invType As String
Dim Name As String

Dim InvoiceTxnDate As String
InvoiceTxnDate = jsonResponse.StringOf("Invoice.TxnDate")
Dim InvoiceDomain As String
InvoiceDomain = jsonResponse.StringOf("Invoice.domain")
Dim InvoicePrintStatus As String
InvoicePrintStatus = jsonResponse.StringOf("Invoice.PrintStatus")
Dim InvoiceTotalAmt As String
InvoiceTotalAmt = jsonResponse.StringOf("Invoice.TotalAmt")
Dim InvoiceDueDate As String
InvoiceDueDate = jsonResponse.StringOf("Invoice.DueDate")
Dim InvoiceApplyTaxAfterDiscount As Boolean
InvoiceApplyTaxAfterDiscount = jsonResponse.BoolOf("Invoice.ApplyTaxAfterDiscount")
Dim InvoiceDocNumber As String
InvoiceDocNumber = jsonResponse.StringOf("Invoice.DocNumber")
Dim InvoiceSparse As Boolean
InvoiceSparse = jsonResponse.BoolOf("Invoice.sparse")
Dim InvoiceCustomerMemoValue As String
InvoiceCustomerMemoValue = jsonResponse.StringOf("Invoice.CustomerMemo.value")
Dim InvoiceDeposit As Int32
InvoiceDeposit = jsonResponse.IntOf("Invoice.Deposit")
Dim InvoiceBalance As String
InvoiceBalance = jsonResponse.StringOf("Invoice.Balance")
Dim InvoiceCustomerRefName As String
InvoiceCustomerRefName = jsonResponse.StringOf("Invoice.CustomerRef.name")
Dim InvoiceCustomerRefValue As String
InvoiceCustomerRefValue = jsonResponse.StringOf("Invoice.CustomerRef.value")
Dim InvoiceTxnTaxDetailTotalTax As Int32
InvoiceTxnTaxDetailTotalTax = jsonResponse.IntOf("Invoice.TxnTaxDetail.TotalTax")
Dim InvoiceSyncToken As String
InvoiceSyncToken = jsonResponse.StringOf("Invoice.SyncToken")
Dim InvoiceShipAddrCountrySubDivisionCode As String
InvoiceShipAddrCountrySubDivisionCode = jsonResponse.StringOf("Invoice.ShipAddr.CountrySubDivisionCode")
Dim InvoiceShipAddrCity As String
InvoiceShipAddrCity = jsonResponse.StringOf("Invoice.ShipAddr.City")
Dim InvoiceShipAddrPostalCode As String
InvoiceShipAddrPostalCode = jsonResponse.StringOf("Invoice.ShipAddr.PostalCode")
Dim InvoiceShipAddrId As String
InvoiceShipAddrId = jsonResponse.StringOf("Invoice.ShipAddr.Id")
Dim InvoiceShipAddrLine1 As String
InvoiceShipAddrLine1 = jsonResponse.StringOf("Invoice.ShipAddr.Line1")
Dim InvoiceEmailStatus As String
InvoiceEmailStatus = jsonResponse.StringOf("Invoice.EmailStatus")
Dim InvoiceBillAddrCountrySubDivisionCode As String
InvoiceBillAddrCountrySubDivisionCode = jsonResponse.StringOf("Invoice.BillAddr.CountrySubDivisionCode")
Dim InvoiceBillAddrCity As String
InvoiceBillAddrCity = jsonResponse.StringOf("Invoice.BillAddr.City")
Dim InvoiceBillAddrPostalCode As String
InvoiceBillAddrPostalCode = jsonResponse.StringOf("Invoice.BillAddr.PostalCode")
Dim InvoiceBillAddrId As String
InvoiceBillAddrId = jsonResponse.StringOf("Invoice.BillAddr.Id")
Dim InvoiceBillAddrLine1 As String
InvoiceBillAddrLine1 = jsonResponse.StringOf("Invoice.BillAddr.Line1")
Dim InvoiceMetaDataCreateTime As String
InvoiceMetaDataCreateTime = jsonResponse.StringOf("Invoice.MetaData.CreateTime")
Dim InvoiceMetaDataLastUpdatedTime As String
InvoiceMetaDataLastUpdatedTime = jsonResponse.StringOf("Invoice.MetaData.LastUpdatedTime")
Dim InvoiceId As String
InvoiceId = jsonResponse.StringOf("Invoice.Id")
Dim time As String
time = jsonResponse.StringOf("time")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jsonResponse.SizeOfArray("Invoice.Line")
While i < count_i
    jsonResponse.I = i
    LineNum = jsonResponse.IntOf("Invoice.Line[i].LineNum")
    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
Wend
i = 0
count_i = jsonResponse.SizeOfArray("Invoice.LinkedTxn")
While i < count_i
    jsonResponse.I = i
    i = i + 1
Wend
i = 0
count_i = jsonResponse.SizeOfArray("Invoice.CustomField")
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
Wend