(Xojo Plugin) Quickbooks Send an Invoice

Demonstrates how to send 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#send-an-invoice

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// 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.
Dim jsonToken As New Chilkat.JsonObject
Dim success As Boolean
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

Dim rest As New Chilkat.Rest

// Connect to the REST server.
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
bAutoReconnect = True
Dim success As Boolean
success = rest.Connect("sandbox-quickbooks.api.intuit.com",port,bTls,bAutoReconnect)

Dim sbAuth As New Chilkat.StringBuilder
success = sbAuth.Append("Bearer ")
success = sbAuth.Append(jsonToken.StringOf("access_token"))
rest.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.
// --------------------------------------------------------------------------

// Technically, the POST has an empty request body, but the Quickbooks documentation indicates that 
// the Content-Type header should be set to "application/octet-stream", which really makes no sense
// because there is not content. (How can no content have a type???)
success = rest.AddHeader("Content-Type","application/octet-stream")
rest.AllowHeaderFolding = False

Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("POST","/v3/company/<realmID>/invoice/<invoiceId>/send?sendTo=<emailAddr>",sbResponseBody)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim respStatusCode As Int32
respStatusCode = rest.ResponseStatusCode

// Success is indicated by a 200 response status code.
System.DebugLog("response status code = " + Str(respStatusCode))

Dim jsonResponse As New Chilkat.JsonObject
success = jsonResponse.LoadSb(sbResponseBody)
jsonResponse.EmitCompact = False
System.DebugLog(jsonResponse.Emit())

If (rest.ResponseStatusCode <> 200) Then
    System.DebugLog("Failed.")
    Return
End If

// 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": "2013-03-14",
//     "domain": "QBO",
//     "CurrencyRef": {
//       "name": "United States Dollar",
//       "value": "USD"
//     },
//     "ShipDate": "2013-03-01",
//     "TrackingNum": "123456789",
//     "ClassRef": {
//       "name": "Class 1",
//       "value": "200900000000000003901"
//     },
//     "PrintStatus": "NeedToPrint",
//     "SalesTermRef": {
//       "value": "4"
//     },
//     "DeliveryInfo": {
//       "DeliveryType": "Email",
//       "DeliveryTime": "2014-12-17T11:50:52-08:00"
//     },
//     "TotalAmt": 52.0,
//     "Line": [
//       {
//         "Description": "Sample invoice create request",
//         "DetailType": "SalesItemLineDetail",
//         "SalesItemLineDetail": {
//           "TaxCodeRef": {
//             "value": "TAX"
//           },
//           "Qty": 1,
//           "UnitPrice": 50,
//           "ServiceDate": "2013-03-04",
//           "ItemRef": {
//             "name": "Hours",
//             "value": "2"
//           }
//         },
//         "LineNum": 1,
//         "Amount": 50.0,
//         "Id": "1"
//       },
//       {
//         "DetailType": "SubTotalLineDetail",
//         "Amount": 50.0,
//         "SubTotalLineDetail": {}
//       },
//       {
//         "DetailType": "DiscountLineDetail",
//         "Amount": 5.0,
//         "DiscountLineDetail": {
//           "DiscountAccountRef": {
//             "name": "Discounts given",
//             "value": "30"
//           },
//           "PercentBased": true,
//           "DiscountPercent": 10
//         }
//       },
//       {
//         "DetailType": "SalesItemLineDetail",
//         "Amount": 2.0,
//         "SalesItemLineDetail": {
//           "ItemRef": {
//             "value": "SHIPPING_ITEM_ID"
//           }
//         }
//       }
//     ],
//     "DueDate": "2013-05-13",
//     "MetaData": {
//       "CreateTime": "2013-03-14T01:42:16-07:00",
//       "LastUpdatedTime": "2014-12-17T11:50:58-08:00"
//     },
//     "DocNumber": "Sample_Inv#2",
//     "PrivateNote": "Summary for sample invoice",
//     "sparse": false,
//     "DepositToAccountRef": {
//       "name": "Undeposited Funds",
//       "value": "4"
//     },
//     "CustomerMemo": {
//       "value": "This is the customer message"
//     },
//     "EmailStatus": "EmailSent",
//     "Deposit": 12.0,
//     "Balance": 40.0,
//     "CustomerRef": {
//       "name": "Mr V3 Service Customer Jr2",
//       "value": "15"
//     },
//     "TxnTaxDetail": {
//       "TxnTaxCodeRef": {
//         "value": "5"
//       },
//       "TotalTax": 5.0,
//       "TaxLine": [
//         {
//           "DetailType": "TaxLineDetail",
//           "Amount": 5.0,
//           "TaxLineDetail": {
//             "NetAmountTaxable": 50.0,
//             "TaxPercent": 10,
//             "TaxRateRef": {
//               "value": "2"
//             },
//             "PercentBased": true
//           }
//         }
//       ]
//     },
//     "SyncToken": "0",
//     "BillEmail": {
//       "Address": "test@intuit.com"
//     },
//     "ShipAddr": {
//       "City": "San Jose",
//       "Country": "USA",
//       "Line5": "Cube 999",
//       "Line4": "Dept 12",
//       "Line3": "123 street",
//       "Line2": "Building 1",
//       "Line1": "Intuit",
//       "PostalCode": "95123",
//       "Lat": "37.2374847",
//       "Long": "-121.8277925",
//       "CountrySubDivisionCode": "CA",
//       "Id": "36"
//     },
//     "DepartmentRef": {
//       "name": "Mountain View",
//       "value": "1"
//     },
//     "ShipMethodRef": {
//       "name": "UPS",
//       "value": "UPS"
//     },
//     "BillAddr": {
//       "City": "Mountain View",
//       "Country": "USA",
//       "Line5": "Cube 999",
//       "Line4": "Dept 12",
//       "Line3": "123 street",
//       "Line2": "Building 1",
//       "Line1": "Google",
//       "PostalCode": "95123",
//       "Lat": "37.2374847",
//       "Long": "-121.8277925",
//       "CountrySubDivisionCode": "CA",
//       "Id": "35"
//     },
//     "ApplyTaxAfterDiscount": false,
//     "CustomField": [
//       {
//         "StringValue": "Custom1",
//         "Type": "StringType",
//         "Name": "Custom 1"
//       },
//       {
//         "StringValue": "Custom2",
//         "Type": "StringType",
//         "Name": "Custom 2"
//       },
//       {
//         "StringValue": "Custom3",
//         "Type": "StringType",
//         "Name": "Custom 3"
//       }
//     ],
//     "Id": "96"
//   },
//   "time": "2013-03-14T13:32:04.895-07:00"
// }
// 

Dim Description As String
Dim DetailType As String
Dim SalesItemLineDetailTaxCodeRefValue As String
Dim SalesItemLineDetailQty As Int32
Dim SalesItemLineDetailUnitPrice As Int32
Dim SalesItemLineDetailServiceDate As String
Dim SalesItemLineDetailItemRefName As String
Dim SalesItemLineDetailItemRefValue As String
Dim LineNum As Int32
Dim Amount As String
Dim Id As String
Dim DiscountLineDetailDiscountAccountRefName As String
Dim DiscountLineDetailDiscountAccountRefValue As String
Dim DiscountLineDetailPercentBased As Boolean
Dim DiscountLineDetailDiscountPercent As Int32
Dim TaxLineDetailNetAmountTaxable As String
Dim TaxLineDetailTaxPercent As Int32
Dim TaxLineDetailTaxRateRefValue As String
Dim TaxLineDetailPercentBased As Boolean
Dim StringValue As String
Dim Type As String
Dim Name As String

Dim InvoiceTxnDate As String
InvoiceTxnDate = jsonResponse.StringOf("Invoice.TxnDate")
Dim InvoiceDomain As String
InvoiceDomain = jsonResponse.StringOf("Invoice.domain")
Dim InvoiceCurrencyRefName As String
InvoiceCurrencyRefName = jsonResponse.StringOf("Invoice.CurrencyRef.name")
Dim InvoiceCurrencyRefValue As String
InvoiceCurrencyRefValue = jsonResponse.StringOf("Invoice.CurrencyRef.value")
Dim InvoiceShipDate As String
InvoiceShipDate = jsonResponse.StringOf("Invoice.ShipDate")
Dim InvoiceTrackingNum As String
InvoiceTrackingNum = jsonResponse.StringOf("Invoice.TrackingNum")
Dim InvoiceClassRefName As String
InvoiceClassRefName = jsonResponse.StringOf("Invoice.ClassRef.name")
Dim InvoiceClassRefValue As String
InvoiceClassRefValue = jsonResponse.StringOf("Invoice.ClassRef.value")
Dim InvoicePrintStatus As String
InvoicePrintStatus = jsonResponse.StringOf("Invoice.PrintStatus")
Dim InvoiceSalesTermRefValue As String
InvoiceSalesTermRefValue = jsonResponse.StringOf("Invoice.SalesTermRef.value")
Dim InvoiceDeliveryInfoDeliveryType As String
InvoiceDeliveryInfoDeliveryType = jsonResponse.StringOf("Invoice.DeliveryInfo.DeliveryType")
Dim InvoiceDeliveryInfoDeliveryTime As String
InvoiceDeliveryInfoDeliveryTime = jsonResponse.StringOf("Invoice.DeliveryInfo.DeliveryTime")
Dim InvoiceTotalAmt As String
InvoiceTotalAmt = jsonResponse.StringOf("Invoice.TotalAmt")
Dim InvoiceDueDate As String
InvoiceDueDate = jsonResponse.StringOf("Invoice.DueDate")
Dim InvoiceMetaDataCreateTime As String
InvoiceMetaDataCreateTime = jsonResponse.StringOf("Invoice.MetaData.CreateTime")
Dim InvoiceMetaDataLastUpdatedTime As String
InvoiceMetaDataLastUpdatedTime = jsonResponse.StringOf("Invoice.MetaData.LastUpdatedTime")
Dim InvoiceDocNumber As String
InvoiceDocNumber = jsonResponse.StringOf("Invoice.DocNumber")
Dim InvoicePrivateNote As String
InvoicePrivateNote = jsonResponse.StringOf("Invoice.PrivateNote")
Dim InvoiceSparse As Boolean
InvoiceSparse = jsonResponse.BoolOf("Invoice.sparse")
Dim InvoiceDepositToAccountRefName As String
InvoiceDepositToAccountRefName = jsonResponse.StringOf("Invoice.DepositToAccountRef.name")
Dim InvoiceDepositToAccountRefValue As String
InvoiceDepositToAccountRefValue = jsonResponse.StringOf("Invoice.DepositToAccountRef.value")
Dim InvoiceCustomerMemoValue As String
InvoiceCustomerMemoValue = jsonResponse.StringOf("Invoice.CustomerMemo.value")
Dim InvoiceEmailStatus As String
InvoiceEmailStatus = jsonResponse.StringOf("Invoice.EmailStatus")
Dim InvoiceDeposit As String
InvoiceDeposit = jsonResponse.StringOf("Invoice.Deposit")
Dim InvoiceBalance As String
InvoiceBalance = jsonResponse.StringOf("Invoice.Balance")
Dim InvoiceCustomerRefName As String
InvoiceCustomerRefName = jsonResponse.StringOf("Invoice.CustomerRef.name")
Dim InvoiceCustomerRefValue As String
InvoiceCustomerRefValue = jsonResponse.StringOf("Invoice.CustomerRef.value")
Dim InvoiceTxnTaxDetailTxnTaxCodeRefValue As String
InvoiceTxnTaxDetailTxnTaxCodeRefValue = jsonResponse.StringOf("Invoice.TxnTaxDetail.TxnTaxCodeRef.value")
Dim InvoiceTxnTaxDetailTotalTax As String
InvoiceTxnTaxDetailTotalTax = jsonResponse.StringOf("Invoice.TxnTaxDetail.TotalTax")
Dim InvoiceSyncToken As String
InvoiceSyncToken = jsonResponse.StringOf("Invoice.SyncToken")
Dim InvoiceBillEmailAddress As String
InvoiceBillEmailAddress = jsonResponse.StringOf("Invoice.BillEmail.Address")
Dim InvoiceShipAddrCity As String
InvoiceShipAddrCity = jsonResponse.StringOf("Invoice.ShipAddr.City")
Dim InvoiceShipAddrCountry As String
InvoiceShipAddrCountry = jsonResponse.StringOf("Invoice.ShipAddr.Country")
Dim InvoiceShipAddrLine5 As String
InvoiceShipAddrLine5 = jsonResponse.StringOf("Invoice.ShipAddr.Line5")
Dim InvoiceShipAddrLine4 As String
InvoiceShipAddrLine4 = jsonResponse.StringOf("Invoice.ShipAddr.Line4")
Dim InvoiceShipAddrLine3 As String
InvoiceShipAddrLine3 = jsonResponse.StringOf("Invoice.ShipAddr.Line3")
Dim InvoiceShipAddrLine2 As String
InvoiceShipAddrLine2 = jsonResponse.StringOf("Invoice.ShipAddr.Line2")
Dim InvoiceShipAddrLine1 As String
InvoiceShipAddrLine1 = jsonResponse.StringOf("Invoice.ShipAddr.Line1")
Dim InvoiceShipAddrPostalCode As String
InvoiceShipAddrPostalCode = jsonResponse.StringOf("Invoice.ShipAddr.PostalCode")
Dim InvoiceShipAddrLat As String
InvoiceShipAddrLat = jsonResponse.StringOf("Invoice.ShipAddr.Lat")
Dim InvoiceShipAddrLong As String
InvoiceShipAddrLong = jsonResponse.StringOf("Invoice.ShipAddr.Long")
Dim InvoiceShipAddrCountrySubDivisionCode As String
InvoiceShipAddrCountrySubDivisionCode = jsonResponse.StringOf("Invoice.ShipAddr.CountrySubDivisionCode")
Dim InvoiceShipAddrId As String
InvoiceShipAddrId = jsonResponse.StringOf("Invoice.ShipAddr.Id")
Dim InvoiceDepartmentRefName As String
InvoiceDepartmentRefName = jsonResponse.StringOf("Invoice.DepartmentRef.name")
Dim InvoiceDepartmentRefValue As String
InvoiceDepartmentRefValue = jsonResponse.StringOf("Invoice.DepartmentRef.value")
Dim InvoiceShipMethodRefName As String
InvoiceShipMethodRefName = jsonResponse.StringOf("Invoice.ShipMethodRef.name")
Dim InvoiceShipMethodRefValue As String
InvoiceShipMethodRefValue = jsonResponse.StringOf("Invoice.ShipMethodRef.value")
Dim InvoiceBillAddrCity As String
InvoiceBillAddrCity = jsonResponse.StringOf("Invoice.BillAddr.City")
Dim InvoiceBillAddrCountry As String
InvoiceBillAddrCountry = jsonResponse.StringOf("Invoice.BillAddr.Country")
Dim InvoiceBillAddrLine5 As String
InvoiceBillAddrLine5 = jsonResponse.StringOf("Invoice.BillAddr.Line5")
Dim InvoiceBillAddrLine4 As String
InvoiceBillAddrLine4 = jsonResponse.StringOf("Invoice.BillAddr.Line4")
Dim InvoiceBillAddrLine3 As String
InvoiceBillAddrLine3 = jsonResponse.StringOf("Invoice.BillAddr.Line3")
Dim InvoiceBillAddrLine2 As String
InvoiceBillAddrLine2 = jsonResponse.StringOf("Invoice.BillAddr.Line2")
Dim InvoiceBillAddrLine1 As String
InvoiceBillAddrLine1 = jsonResponse.StringOf("Invoice.BillAddr.Line1")
Dim InvoiceBillAddrPostalCode As String
InvoiceBillAddrPostalCode = jsonResponse.StringOf("Invoice.BillAddr.PostalCode")
Dim InvoiceBillAddrLat As String
InvoiceBillAddrLat = jsonResponse.StringOf("Invoice.BillAddr.Lat")
Dim InvoiceBillAddrLong As String
InvoiceBillAddrLong = jsonResponse.StringOf("Invoice.BillAddr.Long")
Dim InvoiceBillAddrCountrySubDivisionCode As String
InvoiceBillAddrCountrySubDivisionCode = jsonResponse.StringOf("Invoice.BillAddr.CountrySubDivisionCode")
Dim InvoiceBillAddrId As String
InvoiceBillAddrId = jsonResponse.StringOf("Invoice.BillAddr.Id")
Dim InvoiceApplyTaxAfterDiscount As Boolean
InvoiceApplyTaxAfterDiscount = jsonResponse.BoolOf("Invoice.ApplyTaxAfterDiscount")
Dim InvoiceId As String
InvoiceId = jsonResponse.StringOf("Invoice.Id")
Dim time As String
time = jsonResponse.StringOf("time")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jsonResponse.SizeOfArray("Invoice.Line")
While i < count_i
    jsonResponse.I = i
    Description = jsonResponse.StringOf("Invoice.Line[i].Description")
    DetailType = jsonResponse.StringOf("Invoice.Line[i].DetailType")
    SalesItemLineDetailTaxCodeRefValue = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value")
    SalesItemLineDetailQty = jsonResponse.IntOf("Invoice.Line[i].SalesItemLineDetail.Qty")
    SalesItemLineDetailUnitPrice = jsonResponse.IntOf("Invoice.Line[i].SalesItemLineDetail.UnitPrice")
    SalesItemLineDetailServiceDate = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ServiceDate")
    SalesItemLineDetailItemRefName = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.name")
    SalesItemLineDetailItemRefValue = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.value")
    LineNum = jsonResponse.IntOf("Invoice.Line[i].LineNum")
    Amount = jsonResponse.StringOf("Invoice.Line[i].Amount")
    Id = jsonResponse.StringOf("Invoice.Line[i].Id")
    DiscountLineDetailDiscountAccountRefName = jsonResponse.StringOf("Invoice.Line[i].DiscountLineDetail.DiscountAccountRef.name")
    DiscountLineDetailDiscountAccountRefValue = jsonResponse.StringOf("Invoice.Line[i].DiscountLineDetail.DiscountAccountRef.value")
    DiscountLineDetailPercentBased = jsonResponse.BoolOf("Invoice.Line[i].DiscountLineDetail.PercentBased")
    DiscountLineDetailDiscountPercent = jsonResponse.IntOf("Invoice.Line[i].DiscountLineDetail.DiscountPercent")
    i = i + 1
Wend
i = 0
count_i = jsonResponse.SizeOfArray("Invoice.TxnTaxDetail.TaxLine")
While i < count_i
    jsonResponse.I = i
    DetailType = jsonResponse.StringOf("Invoice.TxnTaxDetail.TaxLine[i].DetailType")
    Amount = jsonResponse.StringOf("Invoice.TxnTaxDetail.TaxLine[i].Amount")
    TaxLineDetailNetAmountTaxable = jsonResponse.StringOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.NetAmountTaxable")
    TaxLineDetailTaxPercent = jsonResponse.IntOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.TaxPercent")
    TaxLineDetailTaxRateRefValue = jsonResponse.StringOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.TaxRateRef.value")
    TaxLineDetailPercentBased = jsonResponse.BoolOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.PercentBased")
    i = i + 1
Wend
i = 0
count_i = jsonResponse.SizeOfArray("Invoice.CustomField")
While i < count_i
    jsonResponse.I = i
    StringValue = jsonResponse.StringOf("Invoice.CustomField[i].StringValue")
    Type = jsonResponse.StringOf("Invoice.CustomField[i].Type")
    Name = jsonResponse.StringOf("Invoice.CustomField[i].Name")
    i = i + 1
Wend