(Visual FoxPro) Quickbooks Create an Invoice

Demonstrates how to create an invoice via the Quickbooks REST API.

For more information, see https://www.developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/invoice#create-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 lcInvoiceDocNumber
LOCAL lcInvoiceSyncToken
LOCAL lcInvoiceDomain
LOCAL lcInvoiceBalance
LOCAL lcInvoiceBillAddrCity
LOCAL lcInvoiceBillAddrLine1
LOCAL lcInvoiceBillAddrPostalCode
LOCAL lcInvoiceBillAddrLat
LOCAL lcInvoiceBillAddrLong
LOCAL lcInvoiceBillAddrCountrySubDivisionCode
LOCAL lcInvoiceBillAddrId
LOCAL lcInvoiceTxnDate
LOCAL lcInvoiceTotalAmt
LOCAL lcInvoiceCustomerRefName
LOCAL lcInvoiceCustomerRefValue
LOCAL lcInvoiceShipAddrCity
LOCAL lcInvoiceShipAddrLine1
LOCAL lcInvoiceShipAddrPostalCode
LOCAL lcInvoiceShipAddrLat
LOCAL lcInvoiceShipAddrLong
LOCAL lcInvoiceShipAddrCountrySubDivisionCode
LOCAL lcInvoiceShipAddrId
LOCAL lcInvoiceDueDate
LOCAL lcInvoicePrintStatus
LOCAL lnInvoiceDeposit
LOCAL lnInvoiceSparse
LOCAL lcInvoiceEmailStatus
LOCAL lnInvoiceApplyTaxAfterDiscount
LOCAL lcInvoiceId
LOCAL lnInvoiceTxnTaxDetailTotalTax
LOCAL lcInvoiceMetaDataCreateTime
LOCAL lcInvoiceMetaDataLastUpdatedTime
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.
loJsonToken = CreateObject('Chilkat_9_5_0.JsonObject')
lnSuccess = loJsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

loRest = CreateObject('Chilkat_9_5_0.Rest')

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

loSbAuth = CreateObject('Chilkat_9_5_0.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:

* {
*   "Line": [
*     {
*       "DetailType": "SalesItemLineDetail",
*       "Amount": 100.0,
*       "SalesItemLineDetail": {
*         "ItemRef": {
*           "name": "Services",
*           "value": "1"
*         }
*       }
*     }
*   ],
*   "CustomerRef": {
*     "value": "1"
*   }
* }
* 
* Use the this online tool to generate the code from sample JSON: 
* Generate Code to Create JSON

loJsonReq = CreateObject('Chilkat_9_5_0.JsonObject')
loJsonReq.UpdateString("Line[0].DetailType","SalesItemLineDetail")
loJsonReq.UpdateNumber("Line[0].Amount","100.0")
loJsonReq.UpdateString("Line[0].SalesItemLineDetail.ItemRef.name","Services")
loJsonReq.UpdateString("Line[0].SalesItemLineDetail.ItemRef.value","1")
loJsonReq.UpdateString("CustomerRef.value","1")

loSbRequestBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loJsonReq.EmitSb(loSbRequestBody)

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

loSbResponseBody = CreateObject('Chilkat_9_5_0.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)

loJsonResponse = CreateObject('Chilkat_9_5_0.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": {
*     "DocNumber": "1069",
*     "SyncToken": "0",
*     "domain": "QBO",
*     "Balance": 100.0,
*     "BillAddr": {
*       "City": "Bayshore",
*       "Line1": "4581 Finch St.",
*       "PostalCode": "94326",
*       "Lat": "INVALID",
*       "Long": "INVALID",
*       "CountrySubDivisionCode": "CA",
*       "Id": "2"
*     },
*     "TxnDate": "2015-07-24",
*     "TotalAmt": 100.0,
*     "CustomerRef": {
*       "name": "Amy's Bird Sanctuary",
*       "value": "1"
*     },
*     "ShipAddr": {
*       "City": "Bayshore",
*       "Line1": "4581 Finch St.",
*       "PostalCode": "94326",
*       "Lat": "INVALID",
*       "Long": "INVALID",
*       "CountrySubDivisionCode": "CA",
*       "Id": "109"
*     },
*     "LinkedTxn": [
*     ],
*     "DueDate": "2015-08-23",
*     "PrintStatus": "NeedToPrint",
*     "Deposit": 0,
*     "sparse": false,
*     "EmailStatus": "NotSet",
*     "Line": [
*       {
*         "LineNum": 1,
*         "Amount": 100.0,
*         "SalesItemLineDetail": {
*           "TaxCodeRef": {
*             "value": "NON"
*           },
*           "ItemRef": {
*             "name": "Services",
*             "value": "1"
*           }
*         },
*         "Id": "1",
*         "DetailType": "SalesItemLineDetail"
*       },
*       {
*         "DetailType": "SubTotalLineDetail",
*         "Amount": 100.0,
*         "SubTotalLineDetail": {}
*       }
*     ],
*     "ApplyTaxAfterDiscount": false,
*     "CustomField": [
*       {
*         "DefinitionId": "1",
*         "Type": "StringType",
*         "Name": "Crew #"
*       }
*     ],
*     "Id": "238",
*     "TxnTaxDetail": {
*       "TotalTax": 0
*     },
*     "MetaData": {
*       "CreateTime": "2015-07-24T10:33:39-07:00",
*       "LastUpdatedTime": "2015-07-24T10:33:39-07:00"
*     }
*   },
*   "time": "2015-07-24T10:33:39.11-07:00"
* }
* 

lcInvoiceDocNumber = loJsonResponse.StringOf("Invoice.DocNumber")
lcInvoiceSyncToken = loJsonResponse.StringOf("Invoice.SyncToken")
lcInvoiceDomain = loJsonResponse.StringOf("Invoice.domain")
lcInvoiceBalance = loJsonResponse.StringOf("Invoice.Balance")
lcInvoiceBillAddrCity = loJsonResponse.StringOf("Invoice.BillAddr.City")
lcInvoiceBillAddrLine1 = loJsonResponse.StringOf("Invoice.BillAddr.Line1")
lcInvoiceBillAddrPostalCode = loJsonResponse.StringOf("Invoice.BillAddr.PostalCode")
lcInvoiceBillAddrLat = loJsonResponse.StringOf("Invoice.BillAddr.Lat")
lcInvoiceBillAddrLong = loJsonResponse.StringOf("Invoice.BillAddr.Long")
lcInvoiceBillAddrCountrySubDivisionCode = loJsonResponse.StringOf("Invoice.BillAddr.CountrySubDivisionCode")
lcInvoiceBillAddrId = loJsonResponse.StringOf("Invoice.BillAddr.Id")
lcInvoiceTxnDate = loJsonResponse.StringOf("Invoice.TxnDate")
lcInvoiceTotalAmt = loJsonResponse.StringOf("Invoice.TotalAmt")
lcInvoiceCustomerRefName = loJsonResponse.StringOf("Invoice.CustomerRef.name")
lcInvoiceCustomerRefValue = loJsonResponse.StringOf("Invoice.CustomerRef.value")
lcInvoiceShipAddrCity = loJsonResponse.StringOf("Invoice.ShipAddr.City")
lcInvoiceShipAddrLine1 = loJsonResponse.StringOf("Invoice.ShipAddr.Line1")
lcInvoiceShipAddrPostalCode = loJsonResponse.StringOf("Invoice.ShipAddr.PostalCode")
lcInvoiceShipAddrLat = loJsonResponse.StringOf("Invoice.ShipAddr.Lat")
lcInvoiceShipAddrLong = loJsonResponse.StringOf("Invoice.ShipAddr.Long")
lcInvoiceShipAddrCountrySubDivisionCode = loJsonResponse.StringOf("Invoice.ShipAddr.CountrySubDivisionCode")
lcInvoiceShipAddrId = loJsonResponse.StringOf("Invoice.ShipAddr.Id")
lcInvoiceDueDate = loJsonResponse.StringOf("Invoice.DueDate")
lcInvoicePrintStatus = loJsonResponse.StringOf("Invoice.PrintStatus")
lnInvoiceDeposit = loJsonResponse.IntOf("Invoice.Deposit")
lnInvoiceSparse = loJsonResponse.BoolOf("Invoice.sparse")
lcInvoiceEmailStatus = loJsonResponse.StringOf("Invoice.EmailStatus")
lnInvoiceApplyTaxAfterDiscount = loJsonResponse.BoolOf("Invoice.ApplyTaxAfterDiscount")
lcInvoiceId = loJsonResponse.StringOf("Invoice.Id")
lnInvoiceTxnTaxDetailTotalTax = loJsonResponse.IntOf("Invoice.TxnTaxDetail.TotalTax")
lcInvoiceMetaDataCreateTime = loJsonResponse.StringOf("Invoice.MetaData.CreateTime")
lcInvoiceMetaDataLastUpdatedTime = loJsonResponse.StringOf("Invoice.MetaData.LastUpdatedTime")
lcTime = loJsonResponse.StringOf("time")
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.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.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