(Delphi ActiveX) Quickbooks Create an Invoice

Demonstrates how to create an invoice via the Quickbooks REST API.

For more information, see https://www.developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/invoice#create-an-invoice

Chilkat for Delphi Downloads Chilkat ActiveX DLL for Delphi Chilkat non-ActiveX DLL for Delphi * The examples here use the ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
jsonToken: TChilkatJsonObject;
success: Integer;
rest: TChilkatRest;
bTls: Integer;
port: Integer;
bAutoReconnect: Integer;
success: Integer;
sbAuth: TChilkatStringBuilder;
jsonReq: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
sbResponseBody: TChilkatStringBuilder;
respStatusCode: Integer;
jsonResponse: TChilkatJsonObject;
LineNum: Integer;
Amount: WideString;
SalesItemLineDetailTaxCodeRefValue: WideString;
SalesItemLineDetailItemRefName: WideString;
SalesItemLineDetailItemRefValue: WideString;
Id: WideString;
DetailType: WideString;
DefinitionId: WideString;
invType: WideString;
Name: WideString;
InvoiceDocNumber: WideString;
InvoiceSyncToken: WideString;
InvoiceDomain: WideString;
InvoiceBalance: WideString;
InvoiceBillAddrCity: WideString;
InvoiceBillAddrLine1: WideString;
InvoiceBillAddrPostalCode: WideString;
InvoiceBillAddrLat: WideString;
InvoiceBillAddrLong: WideString;
InvoiceBillAddrCountrySubDivisionCode: WideString;
InvoiceBillAddrId: WideString;
InvoiceTxnDate: WideString;
InvoiceTotalAmt: WideString;
InvoiceCustomerRefName: WideString;
InvoiceCustomerRefValue: WideString;
InvoiceShipAddrCity: WideString;
InvoiceShipAddrLine1: WideString;
InvoiceShipAddrPostalCode: WideString;
InvoiceShipAddrLat: WideString;
InvoiceShipAddrLong: WideString;
InvoiceShipAddrCountrySubDivisionCode: WideString;
InvoiceShipAddrId: WideString;
InvoiceDueDate: WideString;
InvoicePrintStatus: WideString;
InvoiceDeposit: Integer;
InvoiceSparse: Integer;
InvoiceEmailStatus: WideString;
InvoiceApplyTaxAfterDiscount: Integer;
InvoiceId: WideString;
InvoiceTxnTaxDetailTotalTax: Integer;
InvoiceMetaDataCreateTime: WideString;
InvoiceMetaDataLastUpdatedTime: WideString;
time: WideString;
i: Integer;
count_i: Integer;

begin
// 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 := TChilkatJsonObject.Create(Self);
success := jsonToken.LoadFile('qa_data/tokens/qb-access-token.json');

rest := TChilkatRest.Create(Self);

// Connect to the REST server.
bTls := 1;
port := 443;
bAutoReconnect := 1;
success := rest.Connect('sandbox-quickbooks.api.intuit.com',port,bTls,bAutoReconnect);

sbAuth := TChilkatStringBuilder.Create(Self);
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

jsonReq := TChilkatJsonObject.Create(Self);
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');

sbRequestBody := TChilkatStringBuilder.Create(Self);
jsonReq.EmitSb(sbRequestBody.ControlInterface);

rest.AddHeader('Content-Type','application/json');
rest.AddHeader('Accept','application/json');
rest.AllowHeaderFolding := 0;

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := rest.FullRequestSb('POST','/v3/company/<realmID>/invoice',sbRequestBody.ControlInterface,sbResponseBody.ControlInterface);
if (success <> 1) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

respStatusCode := rest.ResponseStatusCode;

// Success is indicated by a 200 response status code.
Memo1.Lines.Add('response status code = ' + IntToStr(respStatusCode));

jsonResponse := TChilkatJsonObject.Create(Self);
jsonResponse.LoadSb(sbResponseBody.ControlInterface);
jsonResponse.EmitCompact := 0;
Memo1.Lines.Add(jsonResponse.Emit());

if (rest.ResponseStatusCode <> 200) then
  begin
    Memo1.Lines.Add('Failed.');
    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": {
//     "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"
// }
// 

InvoiceDocNumber := jsonResponse.StringOf('Invoice.DocNumber');
InvoiceSyncToken := jsonResponse.StringOf('Invoice.SyncToken');
InvoiceDomain := jsonResponse.StringOf('Invoice.domain');
InvoiceBalance := jsonResponse.StringOf('Invoice.Balance');
InvoiceBillAddrCity := jsonResponse.StringOf('Invoice.BillAddr.City');
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');
InvoiceTxnDate := jsonResponse.StringOf('Invoice.TxnDate');
InvoiceTotalAmt := jsonResponse.StringOf('Invoice.TotalAmt');
InvoiceCustomerRefName := jsonResponse.StringOf('Invoice.CustomerRef.name');
InvoiceCustomerRefValue := jsonResponse.StringOf('Invoice.CustomerRef.value');
InvoiceShipAddrCity := jsonResponse.StringOf('Invoice.ShipAddr.City');
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');
InvoiceDueDate := jsonResponse.StringOf('Invoice.DueDate');
InvoicePrintStatus := jsonResponse.StringOf('Invoice.PrintStatus');
InvoiceDeposit := jsonResponse.IntOf('Invoice.Deposit');
InvoiceSparse := jsonResponse.BoolOf('Invoice.sparse');
InvoiceEmailStatus := jsonResponse.StringOf('Invoice.EmailStatus');
InvoiceApplyTaxAfterDiscount := jsonResponse.BoolOf('Invoice.ApplyTaxAfterDiscount');
InvoiceId := jsonResponse.StringOf('Invoice.Id');
InvoiceTxnTaxDetailTotalTax := jsonResponse.IntOf('Invoice.TxnTaxDetail.TotalTax');
InvoiceMetaDataCreateTime := jsonResponse.StringOf('Invoice.MetaData.CreateTime');
InvoiceMetaDataLastUpdatedTime := jsonResponse.StringOf('Invoice.MetaData.LastUpdatedTime');
time := jsonResponse.StringOf('time');
i := 0;
count_i := jsonResponse.SizeOfArray('Invoice.LinkedTxn');
while i < count_i do
  begin
    jsonResponse.I := i;
    i := i + 1;
  end;

i := 0;
count_i := jsonResponse.SizeOfArray('Invoice.Line');
while i < count_i do
  begin
    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;
  end;

i := 0;
count_i := jsonResponse.SizeOfArray('Invoice.CustomField');
while i < count_i do
  begin
    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;
  end;
end;