(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

// 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.
loJsonToken = createobject("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

loRest = createobject("CkRest")

// Connect to the REST server.
llBTls = .T.
lnPort = 443
llBAutoReconnect = .T.
llSuccess = loRest.Connect("sandbox-quickbooks.api.intuit.com",lnPort,llBTls,llBAutoReconnect)

loSbAuth = createobject("CkStringBuilder")
loSbAuth.Append("Bearer ")
loSbAuth.Append(loJsonToken.StringOf("access_token"))
loRest.Authorization = loSbAuth.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

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

loSbRequestBody = createobject("CkStringBuilder")
loJsonReq.EmitSb(loSbRequestBody)

loRest.AddHeader("Content-Type","application/json")
loRest.AddHeader("Accept","application/json")
loRest.AllowHeaderFolding = .F.

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loRest.FullRequestSb("POST","/v3/company/<realmID>/invoice",loSbRequestBody,loSbResponseBody)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loRest
    release loSbAuth
    release loJsonReq
    release loSbRequestBody
    release loSbResponseBody
    return
endif

lnRespStatusCode = loRest.ResponseStatusCode

// Success is indicated by a 200 response status code.
? "response status code = " + str(lnRespStatusCode)

loJsonResponse = createobject("CkJsonObject")
loJsonResponse.LoadSb(loSbResponseBody)
loJsonResponse.EmitCompact = .F.
? loJsonResponse.Emit()

if (loRest.ResponseStatusCode <> 200) then
    ? "Failed."
    release loJsonToken
    release loRest
    release loSbAuth
    release loJsonReq
    release loSbRequestBody
    release loSbResponseBody
    release loJsonResponse
    return
endif

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

lcInvoiceTxnDate = loJsonResponse.StringOf("Invoice.TxnDate")
lcInvoiceDomain = loJsonResponse.StringOf("Invoice.domain")
lcInvoicePrintStatus = loJsonResponse.StringOf("Invoice.PrintStatus")
lcInvoiceTotalAmt = loJsonResponse.StringOf("Invoice.TotalAmt")
lcInvoiceDueDate = loJsonResponse.StringOf("Invoice.DueDate")
llInvoiceApplyTaxAfterDiscount = loJsonResponse.BoolOf("Invoice.ApplyTaxAfterDiscount")
lcInvoiceDocNumber = loJsonResponse.StringOf("Invoice.DocNumber")
llInvoiceSparse = loJsonResponse.BoolOf("Invoice.sparse")
lcInvoiceCustomerMemoValue = loJsonResponse.StringOf("Invoice.CustomerMemo.value")
lnInvoiceDeposit = loJsonResponse.IntOf("Invoice.Deposit")
lcInvoiceBalance = loJsonResponse.StringOf("Invoice.Balance")
lcInvoiceCustomerRefName = loJsonResponse.StringOf("Invoice.CustomerRef.name")
lcInvoiceCustomerRefValue = loJsonResponse.StringOf("Invoice.CustomerRef.value")
lnInvoiceTxnTaxDetailTotalTax = loJsonResponse.IntOf("Invoice.TxnTaxDetail.TotalTax")
lcInvoiceSyncToken = loJsonResponse.StringOf("Invoice.SyncToken")
lcInvoiceShipAddrCountrySubDivisionCode = loJsonResponse.StringOf("Invoice.ShipAddr.CountrySubDivisionCode")
lcInvoiceShipAddrCity = loJsonResponse.StringOf("Invoice.ShipAddr.City")
lcInvoiceShipAddrPostalCode = loJsonResponse.StringOf("Invoice.ShipAddr.PostalCode")
lcInvoiceShipAddrId = loJsonResponse.StringOf("Invoice.ShipAddr.Id")
lcInvoiceShipAddrLine1 = loJsonResponse.StringOf("Invoice.ShipAddr.Line1")
lcInvoiceEmailStatus = loJsonResponse.StringOf("Invoice.EmailStatus")
lcInvoiceBillAddrCountrySubDivisionCode = loJsonResponse.StringOf("Invoice.BillAddr.CountrySubDivisionCode")
lcInvoiceBillAddrCity = loJsonResponse.StringOf("Invoice.BillAddr.City")
lcInvoiceBillAddrPostalCode = loJsonResponse.StringOf("Invoice.BillAddr.PostalCode")
lcInvoiceBillAddrId = loJsonResponse.StringOf("Invoice.BillAddr.Id")
lcInvoiceBillAddrLine1 = loJsonResponse.StringOf("Invoice.BillAddr.Line1")
lcInvoiceMetaDataCreateTime = loJsonResponse.StringOf("Invoice.MetaData.CreateTime")
lcInvoiceMetaDataLastUpdatedTime = loJsonResponse.StringOf("Invoice.MetaData.LastUpdatedTime")
lcInvoiceId = loJsonResponse.StringOf("Invoice.Id")
lcTime = loJsonResponse.StringOf("time")
i = 0
lnCount_i = loJsonResponse.SizeOfArray("Invoice.Line")
do while i < lnCount_i
    loJsonResponse.I = i
    lnLineNum = loJsonResponse.IntOf("Invoice.Line[i].LineNum")
    lcAmount = loJsonResponse.StringOf("Invoice.Line[i].Amount")
    lcSalesItemLineDetailTaxCodeRefValue = loJsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value")
    lcSalesItemLineDetailItemRefName = loJsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.name")
    lcSalesItemLineDetailItemRefValue = loJsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.value")
    lcId = loJsonResponse.StringOf("Invoice.Line[i].Id")
    lcDetailType = loJsonResponse.StringOf("Invoice.Line[i].DetailType")
    i = i + 1
enddo
i = 0
lnCount_i = loJsonResponse.SizeOfArray("Invoice.LinkedTxn")
do while i < lnCount_i
    loJsonResponse.I = i
    i = i + 1
enddo
i = 0
lnCount_i = loJsonResponse.SizeOfArray("Invoice.CustomField")
do while i < lnCount_i
    loJsonResponse.I = i
    lcDefinitionId = loJsonResponse.StringOf("Invoice.CustomField[i].DefinitionId")
    lcInvType = loJsonResponse.StringOf("Invoice.CustomField[i].Type")
    lcName = loJsonResponse.StringOf("Invoice.CustomField[i].Name")
    i = i + 1
enddo


release loJsonToken
release loRest
release loSbAuth
release loJsonReq
release loSbRequestBody
release loSbResponseBody
release loJsonResponse