Xbase++
Xbase++
Quickbooks Create an Invoice
See more QuickBooks Examples
Demonstrates how to create an invoice via the Quickbooks REST API.Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oJsonToken
LOCAL oRest
LOCAL nBTls
LOCAL nPort
LOCAL nBAutoReconnect
LOCAL oSbAuth
LOCAL oJsonReq
LOCAL oSbRequestBody
LOCAL oSbResponseBody
LOCAL nRespStatusCode
LOCAL oJsonResponse
LOCAL nLineNum
LOCAL cAmount
LOCAL cSalesItemLineDetailTaxCodeRefValue
LOCAL cSalesItemLineDetailItemRefName
LOCAL cSalesItemLineDetailItemRefValue
LOCAL cId
LOCAL cDetailType
LOCAL cDefinitionId
LOCAL cInvType
LOCAL cName
LOCAL cInvoiceDocNumber
LOCAL cInvoiceSyncToken
LOCAL cInvoiceDomain
LOCAL cInvoiceBalance
LOCAL cInvoiceBillAddrCity
LOCAL cInvoiceBillAddrLine1
LOCAL cInvoiceBillAddrPostalCode
LOCAL cInvoiceBillAddrLat
LOCAL cInvoiceBillAddrLong
LOCAL cInvoiceBillAddrCountrySubDivisionCode
LOCAL cInvoiceBillAddrId
LOCAL cInvoiceTxnDate
LOCAL cInvoiceTotalAmt
LOCAL cInvoiceCustomerRefName
LOCAL cInvoiceCustomerRefValue
LOCAL cInvoiceShipAddrCity
LOCAL cInvoiceShipAddrLine1
LOCAL cInvoiceShipAddrPostalCode
LOCAL cInvoiceShipAddrLat
LOCAL cInvoiceShipAddrLong
LOCAL cInvoiceShipAddrCountrySubDivisionCode
LOCAL cInvoiceShipAddrId
LOCAL cInvoiceDueDate
LOCAL cInvoicePrintStatus
LOCAL nInvoiceDeposit
LOCAL nInvoiceSparse
LOCAL cInvoiceEmailStatus
LOCAL nInvoiceApplyTaxAfterDiscount
LOCAL cInvoiceId
LOCAL nInvoiceTxnTaxDetailTotalTax
LOCAL cInvoiceMetaDataCreateTime
LOCAL cInvoiceMetaDataLastUpdatedTime
LOCAL cTime
LOCAL i
LOCAL nCount_i
nSuccess := 0
// 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.
oJsonToken := CreateObject("Chilkat.JsonObject")
nSuccess := oJsonToken:LoadFile("qa_data/tokens/qb-access-token.json")
oRest := CreateObject("Chilkat.Rest")
// Connect to the REST server.
nBTls := 1
nPort := 443
nBAutoReconnect := 1
nSuccess := oRest:Connect("sandbox-quickbooks.api.intuit.com", nPort, nBTls, nBAutoReconnect)
oSbAuth := CreateObject("Chilkat.StringBuilder")
oSbAuth:Append("Bearer ")
oSbAuth:Append(oJsonToken:StringOf("access_token"))
oRest:Authorization := oSbAuth: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
oJsonReq := CreateObject("Chilkat.JsonObject")
oJsonReq:UpdateString("Line[0].DetailType", "SalesItemLineDetail")
oJsonReq:UpdateNumber("Line[0].Amount", "100.0")
oJsonReq:UpdateString("Line[0].SalesItemLineDetail.ItemRef.name", "Services")
oJsonReq:UpdateString("Line[0].SalesItemLineDetail.ItemRef.value", "1")
oJsonReq:UpdateString("CustomerRef.value", "1")
oSbRequestBody := CreateObject("Chilkat.StringBuilder")
oJsonReq:EmitSb(oSbRequestBody)
oRest:AddHeader("Content-Type", "application/json")
oRest:AddHeader("Accept", "application/json")
oRest:AllowHeaderFolding := 0
oSbResponseBody := CreateObject("Chilkat.StringBuilder")
nSuccess := oRest:FullRequestSb("POST", "/v3/company/<realmID>/invoice", oSbRequestBody, oSbResponseBody)
IF (nSuccess != 1)
? oRest:LastErrorText
oJsonToken:destroy()
oRest:destroy()
oSbAuth:destroy()
oJsonReq:destroy()
oSbRequestBody:destroy()
oSbResponseBody:destroy()
RETURN
ENDIF
nRespStatusCode := oRest:ResponseStatusCode
// Success is indicated by a 200 response status code.
? "response status code = " + Str(nRespStatusCode)
oJsonResponse := CreateObject("Chilkat.JsonObject")
oJsonResponse:LoadSb(oSbResponseBody)
oJsonResponse:EmitCompact := 0
? oJsonResponse:Emit()
IF (oRest:ResponseStatusCode != 200)
? "Failed."
oJsonToken:destroy()
oRest:destroy()
oSbAuth:destroy()
oJsonReq:destroy()
oSbRequestBody:destroy()
oSbResponseBody:destroy()
oJsonResponse:destroy()
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": {
// "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"
// }
//
cInvoiceDocNumber := oJsonResponse:StringOf("Invoice.DocNumber")
cInvoiceSyncToken := oJsonResponse:StringOf("Invoice.SyncToken")
cInvoiceDomain := oJsonResponse:StringOf("Invoice.domain")
cInvoiceBalance := oJsonResponse:StringOf("Invoice.Balance")
cInvoiceBillAddrCity := oJsonResponse:StringOf("Invoice.BillAddr.City")
cInvoiceBillAddrLine1 := oJsonResponse:StringOf("Invoice.BillAddr.Line1")
cInvoiceBillAddrPostalCode := oJsonResponse:StringOf("Invoice.BillAddr.PostalCode")
cInvoiceBillAddrLat := oJsonResponse:StringOf("Invoice.BillAddr.Lat")
cInvoiceBillAddrLong := oJsonResponse:StringOf("Invoice.BillAddr.Long")
cInvoiceBillAddrCountrySubDivisionCode := oJsonResponse:StringOf("Invoice.BillAddr.CountrySubDivisionCode")
cInvoiceBillAddrId := oJsonResponse:StringOf("Invoice.BillAddr.Id")
cInvoiceTxnDate := oJsonResponse:StringOf("Invoice.TxnDate")
cInvoiceTotalAmt := oJsonResponse:StringOf("Invoice.TotalAmt")
cInvoiceCustomerRefName := oJsonResponse:StringOf("Invoice.CustomerRef.name")
cInvoiceCustomerRefValue := oJsonResponse:StringOf("Invoice.CustomerRef.value")
cInvoiceShipAddrCity := oJsonResponse:StringOf("Invoice.ShipAddr.City")
cInvoiceShipAddrLine1 := oJsonResponse:StringOf("Invoice.ShipAddr.Line1")
cInvoiceShipAddrPostalCode := oJsonResponse:StringOf("Invoice.ShipAddr.PostalCode")
cInvoiceShipAddrLat := oJsonResponse:StringOf("Invoice.ShipAddr.Lat")
cInvoiceShipAddrLong := oJsonResponse:StringOf("Invoice.ShipAddr.Long")
cInvoiceShipAddrCountrySubDivisionCode := oJsonResponse:StringOf("Invoice.ShipAddr.CountrySubDivisionCode")
cInvoiceShipAddrId := oJsonResponse:StringOf("Invoice.ShipAddr.Id")
cInvoiceDueDate := oJsonResponse:StringOf("Invoice.DueDate")
cInvoicePrintStatus := oJsonResponse:StringOf("Invoice.PrintStatus")
nInvoiceDeposit := oJsonResponse:IntOf("Invoice.Deposit")
nInvoiceSparse := oJsonResponse:BoolOf("Invoice.sparse")
cInvoiceEmailStatus := oJsonResponse:StringOf("Invoice.EmailStatus")
nInvoiceApplyTaxAfterDiscount := oJsonResponse:BoolOf("Invoice.ApplyTaxAfterDiscount")
cInvoiceId := oJsonResponse:StringOf("Invoice.Id")
nInvoiceTxnTaxDetailTotalTax := oJsonResponse:IntOf("Invoice.TxnTaxDetail.TotalTax")
cInvoiceMetaDataCreateTime := oJsonResponse:StringOf("Invoice.MetaData.CreateTime")
cInvoiceMetaDataLastUpdatedTime := oJsonResponse:StringOf("Invoice.MetaData.LastUpdatedTime")
cTime := oJsonResponse:StringOf("time")
i := 0
nCount_i := oJsonResponse:SizeOfArray("Invoice.LinkedTxn")
DO WHILE i < nCount_i
oJsonResponse:I := i
i := i + 1
ENDDO
i := 0
nCount_i := oJsonResponse:SizeOfArray("Invoice.Line")
DO WHILE i < nCount_i
oJsonResponse:I := i
nLineNum := oJsonResponse:IntOf("Invoice.Line[i].LineNum")
cAmount := oJsonResponse:StringOf("Invoice.Line[i].Amount")
cSalesItemLineDetailTaxCodeRefValue := oJsonResponse:StringOf("Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value")
cSalesItemLineDetailItemRefName := oJsonResponse:StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.name")
cSalesItemLineDetailItemRefValue := oJsonResponse:StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.value")
cId := oJsonResponse:StringOf("Invoice.Line[i].Id")
cDetailType := oJsonResponse:StringOf("Invoice.Line[i].DetailType")
i := i + 1
ENDDO
i := 0
nCount_i := oJsonResponse:SizeOfArray("Invoice.CustomField")
DO WHILE i < nCount_i
oJsonResponse:I := i
cDefinitionId := oJsonResponse:StringOf("Invoice.CustomField[i].DefinitionId")
cInvType := oJsonResponse:StringOf("Invoice.CustomField[i].Type")
cName := oJsonResponse:StringOf("Invoice.CustomField[i].Name")
i := i + 1
ENDDO
oJsonToken:destroy()
oRest:destroy()
oSbAuth:destroy()
oJsonReq:destroy()
oSbRequestBody:destroy()
oSbResponseBody:destroy()
oJsonResponse:destroy()