PureBasic
PureBasic
Quickbooks Create an Invoice
See more QuickBooks Examples
Demonstrates how to create an invoice via the Quickbooks REST API.Chilkat PureBasic Downloads
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"
Procedure ChilkatExample()
success.i = 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.
jsonToken.i = CkJsonObject::ckCreate()
If jsonToken.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/qb-access-token.json")
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Connect to the REST server.
bTls.i = 1
port.i = 443
bAutoReconnect.i = 1
success = CkRest::ckConnect(rest,"sandbox-quickbooks.api.intuit.com",port,bTls,bAutoReconnect)
sbAuth.i = CkStringBuilder::ckCreate()
If sbAuth.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckAppend(sbAuth,"Bearer ")
CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"access_token"))
CkRest::setCkAuthorization(rest, CkStringBuilder::ckGetAsString(sbAuth))
; --------------------------------------------------------------------------
; 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
jsonReq.i = CkJsonObject::ckCreate()
If jsonReq.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(jsonReq,"Line[0].DetailType","SalesItemLineDetail")
CkJsonObject::ckUpdateNumber(jsonReq,"Line[0].Amount","100.0")
CkJsonObject::ckUpdateString(jsonReq,"Line[0].SalesItemLineDetail.ItemRef.name","Services")
CkJsonObject::ckUpdateString(jsonReq,"Line[0].SalesItemLineDetail.ItemRef.value","1")
CkJsonObject::ckUpdateString(jsonReq,"CustomerRef.value","1")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(jsonReq,sbRequestBody)
CkRest::ckAddHeader(rest,"Content-Type","application/json")
CkRest::ckAddHeader(rest,"Accept","application/json")
CkRest::setCkAllowHeaderFolding(rest, 0)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/v3/company/<realmID>/invoice",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkJsonObject::ckDispose(jsonToken)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbAuth)
CkJsonObject::ckDispose(jsonReq)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
; Success is indicated by a 200 response status code.
Debug "response status code = " + Str(respStatusCode)
jsonResponse.i = CkJsonObject::ckCreate()
If jsonResponse.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jsonResponse,sbResponseBody)
CkJsonObject::setCkEmitCompact(jsonResponse, 0)
Debug CkJsonObject::ckEmit(jsonResponse)
If CkRest::ckResponseStatusCode(rest) <> 200
Debug "Failed."
CkJsonObject::ckDispose(jsonToken)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbAuth)
CkJsonObject::ckDispose(jsonReq)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jsonResponse)
ProcedureReturn
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"
; }
;
LineNum.i
Amount.s
SalesItemLineDetailTaxCodeRefValue.s
SalesItemLineDetailItemRefName.s
SalesItemLineDetailItemRefValue.s
Id.s
DetailType.s
DefinitionId.s
invType.s
Name.s
InvoiceDocNumber.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.DocNumber")
InvoiceSyncToken.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.SyncToken")
InvoiceDomain.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.domain")
InvoiceBalance.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Balance")
InvoiceBillAddrCity.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.BillAddr.City")
InvoiceBillAddrLine1.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.BillAddr.Line1")
InvoiceBillAddrPostalCode.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.BillAddr.PostalCode")
InvoiceBillAddrLat.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.BillAddr.Lat")
InvoiceBillAddrLong.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.BillAddr.Long")
InvoiceBillAddrCountrySubDivisionCode.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.BillAddr.CountrySubDivisionCode")
InvoiceBillAddrId.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.BillAddr.Id")
InvoiceTxnDate.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.TxnDate")
InvoiceTotalAmt.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.TotalAmt")
InvoiceCustomerRefName.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.CustomerRef.name")
InvoiceCustomerRefValue.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.CustomerRef.value")
InvoiceShipAddrCity.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.ShipAddr.City")
InvoiceShipAddrLine1.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.ShipAddr.Line1")
InvoiceShipAddrPostalCode.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.ShipAddr.PostalCode")
InvoiceShipAddrLat.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.ShipAddr.Lat")
InvoiceShipAddrLong.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.ShipAddr.Long")
InvoiceShipAddrCountrySubDivisionCode.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.ShipAddr.CountrySubDivisionCode")
InvoiceShipAddrId.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.ShipAddr.Id")
InvoiceDueDate.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.DueDate")
InvoicePrintStatus.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.PrintStatus")
InvoiceDeposit.i = CkJsonObject::ckIntOf(jsonResponse,"Invoice.Deposit")
InvoiceSparse.i = CkJsonObject::ckBoolOf(jsonResponse,"Invoice.sparse")
InvoiceEmailStatus.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.EmailStatus")
InvoiceApplyTaxAfterDiscount.i = CkJsonObject::ckBoolOf(jsonResponse,"Invoice.ApplyTaxAfterDiscount")
InvoiceId.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Id")
InvoiceTxnTaxDetailTotalTax.i = CkJsonObject::ckIntOf(jsonResponse,"Invoice.TxnTaxDetail.TotalTax")
InvoiceMetaDataCreateTime.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.MetaData.CreateTime")
InvoiceMetaDataLastUpdatedTime.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.MetaData.LastUpdatedTime")
time.s = CkJsonObject::ckStringOf(jsonResponse,"time")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jsonResponse,"Invoice.LinkedTxn")
While i < count_i
CkJsonObject::setCkI(jsonResponse, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jsonResponse,"Invoice.Line")
While i < count_i
CkJsonObject::setCkI(jsonResponse, i)
LineNum = CkJsonObject::ckIntOf(jsonResponse,"Invoice.Line[i].LineNum")
Amount = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Line[i].Amount")
SalesItemLineDetailTaxCodeRefValue = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value")
SalesItemLineDetailItemRefName = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Line[i].SalesItemLineDetail.ItemRef.name")
SalesItemLineDetailItemRefValue = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Line[i].SalesItemLineDetail.ItemRef.value")
Id = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Line[i].Id")
DetailType = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Line[i].DetailType")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jsonResponse,"Invoice.CustomField")
While i < count_i
CkJsonObject::setCkI(jsonResponse, i)
DefinitionId = CkJsonObject::ckStringOf(jsonResponse,"Invoice.CustomField[i].DefinitionId")
invType = CkJsonObject::ckStringOf(jsonResponse,"Invoice.CustomField[i].Type")
Name = CkJsonObject::ckStringOf(jsonResponse,"Invoice.CustomField[i].Name")
i = i + 1
Wend
CkJsonObject::ckDispose(jsonToken)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbAuth)
CkJsonObject::ckDispose(jsonReq)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jsonResponse)
ProcedureReturn
EndProcedure