B4X
B4X
Quickbooks Create an Invoice
See more QuickBooks Examples
Demonstrates how to create an invoice via the Quickbooks REST API.Chilkat B4X Downloads
Dim success As Boolean = False
' 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 ChilkatJsonObject
jsonToken.Initialize
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")
Dim rest As ChilkatRest
rest.Initialize("rest")
' Connect to the REST server.
Dim bTls As Boolean = True
Dim port As Int = 443
Dim bAutoReconnect As Boolean = True
success = rest.Connect("sandbox-quickbooks.api.intuit.com", port, bTls, bAutoReconnect)
Dim sbAuth As ChilkatStringBuilder
sbAuth.Initialize
sbAuth.Append("Bearer ")
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.
' --------------------------------------------------------------------------
' 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
Dim jsonReq As ChilkatJsonObject
jsonReq.Initialize
jsonReq.UpdateString("Line[0].DetailType", "SalesItemLineDetail")
jsonReq.UpdateNumber("Line[0].Amount", "100.0")
jsonReq.UpdateString("Line[0].SalesItemLineDetail.ItemRef.name", "Services")
jsonReq.UpdateString("Line[0].SalesItemLineDetail.ItemRef.value", "1")
jsonReq.UpdateString("CustomerRef.value", "1")
Dim sbRequestBody As ChilkatStringBuilder
sbRequestBody.Initialize
jsonReq.EmitSb(sbRequestBody)
rest.AddHeader("Content-Type", "application/json")
rest.AddHeader("Accept", "application/json")
rest.AllowHeaderFolding = False
Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize
success = rest.FullRequestSb("POST", "/v3/company/<realmID>/invoice", sbRequestBody, sbResponseBody)
If success <> True Then
Log(rest.LastErrorText)
Return
End If
Dim respStatusCode As Int = rest.ResponseStatusCode
' Success is indicated by a 200 response status code.
Log("response status code = " & respStatusCode)
Dim jsonResponse As ChilkatJsonObject
jsonResponse.Initialize
jsonResponse.LoadSb(sbResponseBody)
jsonResponse.EmitCompact = False
Log(jsonResponse.Emit)
If rest.ResponseStatusCode <> 200 Then
Log("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": {
' "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"
' }
'
Dim LineNum As Int
Dim Amount As String
Dim SalesItemLineDetailTaxCodeRefValue As String
Dim SalesItemLineDetailItemRefName As String
Dim SalesItemLineDetailItemRefValue As String
Dim Id As String
Dim DetailType As String
Dim DefinitionId As String
Dim invType As String
Dim Name As String
Dim InvoiceDocNumber As String = jsonResponse.StringOf("Invoice.DocNumber")
Dim InvoiceSyncToken As String = jsonResponse.StringOf("Invoice.SyncToken")
Dim InvoiceDomain As String = jsonResponse.StringOf("Invoice.domain")
Dim InvoiceBalance As String = jsonResponse.StringOf("Invoice.Balance")
Dim InvoiceBillAddrCity As String = jsonResponse.StringOf("Invoice.BillAddr.City")
Dim InvoiceBillAddrLine1 As String = jsonResponse.StringOf("Invoice.BillAddr.Line1")
Dim InvoiceBillAddrPostalCode As String = jsonResponse.StringOf("Invoice.BillAddr.PostalCode")
Dim InvoiceBillAddrLat As String = jsonResponse.StringOf("Invoice.BillAddr.Lat")
Dim InvoiceBillAddrLong As String = jsonResponse.StringOf("Invoice.BillAddr.Long")
Dim InvoiceBillAddrCountrySubDivisionCode As String = jsonResponse.StringOf("Invoice.BillAddr.CountrySubDivisionCode")
Dim InvoiceBillAddrId As String = jsonResponse.StringOf("Invoice.BillAddr.Id")
Dim InvoiceTxnDate As String = jsonResponse.StringOf("Invoice.TxnDate")
Dim InvoiceTotalAmt As String = jsonResponse.StringOf("Invoice.TotalAmt")
Dim InvoiceCustomerRefName As String = jsonResponse.StringOf("Invoice.CustomerRef.name")
Dim InvoiceCustomerRefValue As String = jsonResponse.StringOf("Invoice.CustomerRef.value")
Dim InvoiceShipAddrCity As String = jsonResponse.StringOf("Invoice.ShipAddr.City")
Dim InvoiceShipAddrLine1 As String = jsonResponse.StringOf("Invoice.ShipAddr.Line1")
Dim InvoiceShipAddrPostalCode As String = jsonResponse.StringOf("Invoice.ShipAddr.PostalCode")
Dim InvoiceShipAddrLat As String = jsonResponse.StringOf("Invoice.ShipAddr.Lat")
Dim InvoiceShipAddrLong As String = jsonResponse.StringOf("Invoice.ShipAddr.Long")
Dim InvoiceShipAddrCountrySubDivisionCode As String = jsonResponse.StringOf("Invoice.ShipAddr.CountrySubDivisionCode")
Dim InvoiceShipAddrId As String = jsonResponse.StringOf("Invoice.ShipAddr.Id")
Dim InvoiceDueDate As String = jsonResponse.StringOf("Invoice.DueDate")
Dim InvoicePrintStatus As String = jsonResponse.StringOf("Invoice.PrintStatus")
Dim InvoiceDeposit As Int = jsonResponse.IntOf("Invoice.Deposit")
Dim InvoiceSparse As Boolean = jsonResponse.BoolOf("Invoice.sparse")
Dim InvoiceEmailStatus As String = jsonResponse.StringOf("Invoice.EmailStatus")
Dim InvoiceApplyTaxAfterDiscount As Boolean = jsonResponse.BoolOf("Invoice.ApplyTaxAfterDiscount")
Dim InvoiceId As String = jsonResponse.StringOf("Invoice.Id")
Dim InvoiceTxnTaxDetailTotalTax As Int = jsonResponse.IntOf("Invoice.TxnTaxDetail.TotalTax")
Dim InvoiceMetaDataCreateTime As String = jsonResponse.StringOf("Invoice.MetaData.CreateTime")
Dim InvoiceMetaDataLastUpdatedTime As String = jsonResponse.StringOf("Invoice.MetaData.LastUpdatedTime")
Dim time As String = jsonResponse.StringOf("time")
Dim i As Int = 0
Dim count_i As Int = jsonResponse.SizeOfArray("Invoice.LinkedTxn")
Do While i < count_i
jsonResponse.I = i
i = i + 1
Loop
i = 0
count_i = jsonResponse.SizeOfArray("Invoice.Line")
Do While i < count_i
jsonResponse.I = i
LineNum = jsonResponse.IntOf("Invoice.Line[i].LineNum")
Amount = jsonResponse.StringOf("Invoice.Line[i].Amount")
SalesItemLineDetailTaxCodeRefValue = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value")
SalesItemLineDetailItemRefName = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.name")
SalesItemLineDetailItemRefValue = jsonResponse.StringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.value")
Id = jsonResponse.StringOf("Invoice.Line[i].Id")
DetailType = jsonResponse.StringOf("Invoice.Line[i].DetailType")
i = i + 1
Loop
i = 0
count_i = jsonResponse.SizeOfArray("Invoice.CustomField")
Do While i < count_i
jsonResponse.I = i
DefinitionId = jsonResponse.StringOf("Invoice.CustomField[i].DefinitionId")
invType = jsonResponse.StringOf("Invoice.CustomField[i].Type")
Name = jsonResponse.StringOf("Invoice.CustomField[i].Name")
i = i + 1
Loop