(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# 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.
jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

rest = Chilkat::CkRest.new()

# Connect to the REST server.
bTls = true
port = 443
bAutoReconnect = true
success = rest.Connect("sandbox-quickbooks.api.intuit.com",port,bTls,bAutoReconnect)

sbAuth = Chilkat::CkStringBuilder.new()
sbAuth.Append("Bearer ")
sbAuth.Append(jsonToken.stringOf("access_token"))
rest.put_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

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

sbRequestBody = Chilkat::CkStringBuilder.new()
jsonReq.EmitSb(sbRequestBody)

rest.AddHeader("Content-Type","application/json")
rest.AddHeader("Accept","application/json")
rest.put_AllowHeaderFolding(false)

sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/v3/company/<realmID>/invoice",sbRequestBody,sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()

# Success is indicated by a 200 response status code.
print "response status code = " + respStatusCode.to_s() + "\n";

jsonResponse = Chilkat::CkJsonObject.new()
jsonResponse.LoadSb(sbResponseBody)
jsonResponse.put_EmitCompact(false)
print jsonResponse.emit() + "\n";

if (rest.get_ResponseStatusCode() != 200)
    print "Failed." + "\n";
    exit
end

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

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