(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# 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.
jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

rest = Chilkat::CkRest.new()

# Connect to the REST server.
bTls = true
port = 443
bAutoReconnect = true
success = rest.Connect("sandbox-quickbooks.api.intuit.com",port,bTls,bAutoReconnect)

sbAuth = Chilkat::CkStringBuilder.new()
sbAuth.Append("Bearer ")
sbAuth.Append(jsonToken.stringOf("access_token"))
rest.put_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???)
rest.AddHeader("Content-Type","application/octet-stream")
rest.put_AllowHeaderFolding(false)

sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("POST","/v3/company/<realmID>/invoice/<invoiceId>/send?sendTo=<emailAddr>",sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()

# Success is indicated by a 200 response status code.
print "response status code = " + respStatusCode.to_s() + "\n";

jsonResponse = Chilkat::CkJsonObject.new()
jsonResponse.LoadSb(sbResponseBody)
jsonResponse.put_EmitCompact(false)
print jsonResponse.emit() + "\n";

if (rest.get_ResponseStatusCode() != 200)
    print "Failed." + "\n";
    exit
end

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

InvoiceTxnDate = jsonResponse.stringOf("Invoice.TxnDate")
InvoiceDomain = jsonResponse.stringOf("Invoice.domain")
InvoiceCurrencyRefName = jsonResponse.stringOf("Invoice.CurrencyRef.name")
InvoiceCurrencyRefValue = jsonResponse.stringOf("Invoice.CurrencyRef.value")
InvoiceShipDate = jsonResponse.stringOf("Invoice.ShipDate")
InvoiceTrackingNum = jsonResponse.stringOf("Invoice.TrackingNum")
InvoiceClassRefName = jsonResponse.stringOf("Invoice.ClassRef.name")
InvoiceClassRefValue = jsonResponse.stringOf("Invoice.ClassRef.value")
InvoicePrintStatus = jsonResponse.stringOf("Invoice.PrintStatus")
InvoiceSalesTermRefValue = jsonResponse.stringOf("Invoice.SalesTermRef.value")
InvoiceDeliveryInfoDeliveryType = jsonResponse.stringOf("Invoice.DeliveryInfo.DeliveryType")
InvoiceDeliveryInfoDeliveryTime = jsonResponse.stringOf("Invoice.DeliveryInfo.DeliveryTime")
InvoiceTotalAmt = jsonResponse.stringOf("Invoice.TotalAmt")
InvoiceDueDate = jsonResponse.stringOf("Invoice.DueDate")
InvoiceMetaDataCreateTime = jsonResponse.stringOf("Invoice.MetaData.CreateTime")
InvoiceMetaDataLastUpdatedTime = jsonResponse.stringOf("Invoice.MetaData.LastUpdatedTime")
InvoiceDocNumber = jsonResponse.stringOf("Invoice.DocNumber")
InvoicePrivateNote = jsonResponse.stringOf("Invoice.PrivateNote")
InvoiceSparse = jsonResponse.BoolOf("Invoice.sparse")
InvoiceDepositToAccountRefName = jsonResponse.stringOf("Invoice.DepositToAccountRef.name")
InvoiceDepositToAccountRefValue = jsonResponse.stringOf("Invoice.DepositToAccountRef.value")
InvoiceCustomerMemoValue = jsonResponse.stringOf("Invoice.CustomerMemo.value")
InvoiceEmailStatus = jsonResponse.stringOf("Invoice.EmailStatus")
InvoiceDeposit = jsonResponse.stringOf("Invoice.Deposit")
InvoiceBalance = jsonResponse.stringOf("Invoice.Balance")
InvoiceCustomerRefName = jsonResponse.stringOf("Invoice.CustomerRef.name")
InvoiceCustomerRefValue = jsonResponse.stringOf("Invoice.CustomerRef.value")
InvoiceTxnTaxDetailTxnTaxCodeRefValue = jsonResponse.stringOf("Invoice.TxnTaxDetail.TxnTaxCodeRef.value")
InvoiceTxnTaxDetailTotalTax = jsonResponse.stringOf("Invoice.TxnTaxDetail.TotalTax")
InvoiceSyncToken = jsonResponse.stringOf("Invoice.SyncToken")
InvoiceBillEmailAddress = jsonResponse.stringOf("Invoice.BillEmail.Address")
InvoiceShipAddrCity = jsonResponse.stringOf("Invoice.ShipAddr.City")
InvoiceShipAddrCountry = jsonResponse.stringOf("Invoice.ShipAddr.Country")
InvoiceShipAddrLine5 = jsonResponse.stringOf("Invoice.ShipAddr.Line5")
InvoiceShipAddrLine4 = jsonResponse.stringOf("Invoice.ShipAddr.Line4")
InvoiceShipAddrLine3 = jsonResponse.stringOf("Invoice.ShipAddr.Line3")
InvoiceShipAddrLine2 = jsonResponse.stringOf("Invoice.ShipAddr.Line2")
InvoiceShipAddrLine1 = jsonResponse.stringOf("Invoice.ShipAddr.Line1")
InvoiceShipAddrPostalCode = jsonResponse.stringOf("Invoice.ShipAddr.PostalCode")
InvoiceShipAddrLat = jsonResponse.stringOf("Invoice.ShipAddr.Lat")
InvoiceShipAddrLong = jsonResponse.stringOf("Invoice.ShipAddr.Long")
InvoiceShipAddrCountrySubDivisionCode = jsonResponse.stringOf("Invoice.ShipAddr.CountrySubDivisionCode")
InvoiceShipAddrId = jsonResponse.stringOf("Invoice.ShipAddr.Id")
InvoiceDepartmentRefName = jsonResponse.stringOf("Invoice.DepartmentRef.name")
InvoiceDepartmentRefValue = jsonResponse.stringOf("Invoice.DepartmentRef.value")
InvoiceShipMethodRefName = jsonResponse.stringOf("Invoice.ShipMethodRef.name")
InvoiceShipMethodRefValue = jsonResponse.stringOf("Invoice.ShipMethodRef.value")
InvoiceBillAddrCity = jsonResponse.stringOf("Invoice.BillAddr.City")
InvoiceBillAddrCountry = jsonResponse.stringOf("Invoice.BillAddr.Country")
InvoiceBillAddrLine5 = jsonResponse.stringOf("Invoice.BillAddr.Line5")
InvoiceBillAddrLine4 = jsonResponse.stringOf("Invoice.BillAddr.Line4")
InvoiceBillAddrLine3 = jsonResponse.stringOf("Invoice.BillAddr.Line3")
InvoiceBillAddrLine2 = jsonResponse.stringOf("Invoice.BillAddr.Line2")
InvoiceBillAddrLine1 = jsonResponse.stringOf("Invoice.BillAddr.Line1")
InvoiceBillAddrPostalCode = jsonResponse.stringOf("Invoice.BillAddr.PostalCode")
InvoiceBillAddrLat = jsonResponse.stringOf("Invoice.BillAddr.Lat")
InvoiceBillAddrLong = jsonResponse.stringOf("Invoice.BillAddr.Long")
InvoiceBillAddrCountrySubDivisionCode = jsonResponse.stringOf("Invoice.BillAddr.CountrySubDivisionCode")
InvoiceBillAddrId = jsonResponse.stringOf("Invoice.BillAddr.Id")
InvoiceApplyTaxAfterDiscount = jsonResponse.BoolOf("Invoice.ApplyTaxAfterDiscount")
InvoiceId = jsonResponse.stringOf("Invoice.Id")
time = jsonResponse.stringOf("time")
i = 0
count_i = jsonResponse.SizeOfArray("Invoice.Line")
while i < count_i
    jsonResponse.put_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
end
i = 0
count_i = jsonResponse.SizeOfArray("Invoice.TxnTaxDetail.TaxLine")
while i < count_i
    jsonResponse.put_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
end
i = 0
count_i = jsonResponse.SizeOfArray("Invoice.CustomField")
while i < count_i
    jsonResponse.put_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
end