(Visual FoxPro) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loJsonToken
LOCAL lnSuccess
LOCAL loRest
LOCAL lnBTls
LOCAL lnPort
LOCAL lnBAutoReconnect
LOCAL lnSuccess
LOCAL loSbAuth
LOCAL loJsonReq
LOCAL loSbRequestBody
LOCAL loSbResponseBody
LOCAL lnRespStatusCode
LOCAL loJsonResponse
LOCAL lnLineNum
LOCAL lcAmount
LOCAL lcSalesItemLineDetailTaxCodeRefValue
LOCAL lcSalesItemLineDetailItemRefName
LOCAL lcSalesItemLineDetailItemRefValue
LOCAL lcId
LOCAL lcDetailType
LOCAL lcDefinitionId
LOCAL lcInvType
LOCAL lcName
LOCAL lcInvoiceTxnDate
LOCAL lcInvoiceDomain
LOCAL lcInvoicePrintStatus
LOCAL lcInvoiceTotalAmt
LOCAL lcInvoiceDueDate
LOCAL lnInvoiceApplyTaxAfterDiscount
LOCAL lcInvoiceDocNumber
LOCAL lnInvoiceSparse
LOCAL lcInvoiceCustomerMemoValue
LOCAL lnInvoiceDeposit
LOCAL lcInvoiceBalance
LOCAL lcInvoiceCustomerRefName
LOCAL lcInvoiceCustomerRefValue
LOCAL lnInvoiceTxnTaxDetailTotalTax
LOCAL lcInvoiceSyncToken
LOCAL lcInvoiceShipAddrCountrySubDivisionCode
LOCAL lcInvoiceShipAddrCity
LOCAL lcInvoiceShipAddrPostalCode
LOCAL lcInvoiceShipAddrId
LOCAL lcInvoiceShipAddrLine1
LOCAL lcInvoiceEmailStatus
LOCAL lcInvoiceBillAddrCountrySubDivisionCode
LOCAL lcInvoiceBillAddrCity
LOCAL lcInvoiceBillAddrPostalCode
LOCAL lcInvoiceBillAddrId
LOCAL lcInvoiceBillAddrLine1
LOCAL lcInvoiceMetaDataCreateTime
LOCAL lcInvoiceMetaDataLastUpdatedTime
LOCAL lcInvoiceId
LOCAL lcTime
LOCAL i
LOCAL lnCount_i

* 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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loJsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Rest')
loRest = CreateObject('Chilkat.Rest')

* Connect to the REST server.
lnBTls = 1
lnPort = 443
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("sandbox-quickbooks.api.intuit.com",lnPort,lnBTls,lnBAutoReconnect)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbAuth = CreateObject('Chilkat.StringBuilder')
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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonReq = CreateObject('Chilkat.JsonObject')
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",0)
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",0)
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")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJsonReq.EmitSb(loSbRequestBody)

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loRest.FullRequestSb("POST","/v3/company/<realmID>/invoice",loSbRequestBody,loSbResponseBody)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loRest
    RELEASE loSbAuth
    RELEASE loJsonReq
    RELEASE loSbRequestBody
    RELEASE loSbResponseBody
    CANCEL
ENDIF

lnRespStatusCode = loRest.ResponseStatusCode

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonResponse = CreateObject('Chilkat.JsonObject')
loJsonResponse.LoadSb(loSbResponseBody)
loJsonResponse.EmitCompact = 0
? loJsonResponse.Emit()

IF (loRest.ResponseStatusCode <> 200) THEN
    ? "Failed."
    RELEASE loJsonToken
    RELEASE loRest
    RELEASE loSbAuth
    RELEASE loJsonReq
    RELEASE loSbRequestBody
    RELEASE loSbResponseBody
    RELEASE loJsonResponse
    CANCEL
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")
lnInvoiceApplyTaxAfterDiscount = loJsonResponse.BoolOf("Invoice.ApplyTaxAfterDiscount")
lcInvoiceDocNumber = loJsonResponse.StringOf("Invoice.DocNumber")
lnInvoiceSparse = 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