(MFC) 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 C/C++ Library Downloads MS Visual C/C++ Libs

See Also: Using MFC CString in Chilkat

#include <CkJsonObject.h>
#include <CkRest.h>
#include <CkStringBuilder.h>

void ChilkatSample(void)
    {
    CkString strOut;

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

    CkRest rest;

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

    CkStringBuilder sbAuth;
    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);

    CkStringBuilder sbResponseBody;
    success = rest.FullRequestNoBodySb("POST","/v3/company/<realmID>/invoice/<invoiceId>/send?sendTo=<emailAddr>",sbResponseBody);
    if (success != true) {
        strOut.append(rest.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    int respStatusCode = rest.get_ResponseStatusCode();

    // Success is indicated by a 200 response status code.
    strOut.append("response status code = ");
    strOut.appendInt(respStatusCode);
    strOut.append("\r\n");

    CkJsonObject jsonResponse;
    jsonResponse.LoadSb(sbResponseBody);
    jsonResponse.put_EmitCompact(false);
    strOut.append(jsonResponse.emit());
    strOut.append("\r\n");

    if (rest.get_ResponseStatusCode() != 200) {
        strOut.append("Failed.");
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
    // See this example explaining how this memory should be used: const char * functions.

    const char *Description = 0;
    const char *DetailType = 0;
    const char *SalesItemLineDetailTaxCodeRefValue = 0;
    int SalesItemLineDetailQty;
    int SalesItemLineDetailUnitPrice;
    const char *SalesItemLineDetailServiceDate = 0;
    const char *SalesItemLineDetailItemRefName = 0;
    const char *SalesItemLineDetailItemRefValue = 0;
    int LineNum;
    const char *Amount = 0;
    const char *Id = 0;
    const char *DiscountLineDetailDiscountAccountRefName = 0;
    const char *DiscountLineDetailDiscountAccountRefValue = 0;
    bool DiscountLineDetailPercentBased;
    int DiscountLineDetailDiscountPercent;
    const char *TaxLineDetailNetAmountTaxable = 0;
    int TaxLineDetailTaxPercent;
    const char *TaxLineDetailTaxRateRefValue = 0;
    bool TaxLineDetailPercentBased;
    const char *StringValue = 0;
    const char *Type = 0;
    const char *Name = 0;

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

    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;
    }

    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;
    }



    SetDlgItemText(IDC_EDIT1,strOut.getUnicode());

    }