(C#) 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 .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

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

Chilkat.Rest rest = new Chilkat.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);

Chilkat.StringBuilder sbAuth = new Chilkat.StringBuilder();
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.
// --------------------------------------------------------------------------

// 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.AllowHeaderFolding = false;

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = rest.FullRequestNoBodySb("POST","/v3/company/<realmID>/invoice/<invoiceId>/send?sendTo=<emailAddr>",sbResponseBody);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

int respStatusCode = rest.ResponseStatusCode;

// Success is indicated by a 200 response status code.
Debug.WriteLine("response status code = " + Convert.ToString(respStatusCode));

Chilkat.JsonObject jsonResponse = new Chilkat.JsonObject();
jsonResponse.LoadSb(sbResponseBody);
jsonResponse.EmitCompact = false;
Debug.WriteLine(jsonResponse.Emit());

if (rest.ResponseStatusCode != 200) {
    Debug.WriteLine("Failed.");
    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"
// }
// 

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

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