(C#) Quickbooks Update an Invoice

Demonstrates how to update 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#full-update-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.
// --------------------------------------------------------------------------

// Create the following JSON:

// {
//   "DocNumber": "1070",
//   "SyncToken": "0",
//   "domain": "QBO",
//   "Balance": 150.0,
//   "BillAddr": {
//     "City": "Bayshore",
//     "Line1": "4581 Finch St.",
//     "PostalCode": "94326",
//     "Lat": "INVALID",
//     "Long": "INVALID",
//     "CountrySubDivisionCode": "CA",
//     "Id": "2"
//   },
//   "TxnDate": "2015-07-24",
//   "TotalAmt": 150.0,
//   "CustomerRef": {
//     "name": "Amy's Bird Sanctuary",
//     "value": "1"
//   },
//   "CustomerMemo": {
//     "value": "Added customer memo."
//   },
//   "ShipAddr": {
//     "City": "Bayshore",
//     "Line1": "4581 Finch St.",
//     "PostalCode": "94326",
//     "Lat": "INVALID",
//     "Long": "INVALID",
//     "CountrySubDivisionCode": "CA",
//     "Id": "109"
//   },
//   "LinkedTxn": [
//   ],
//   "DueDate": "2015-08-23",
//   "PrintStatus": "NeedToPrint",
//   "EmailStatus": "NotSet",
//   "sparse": false,
//   "Line": [
//     {
//       "LineNum": 1,
//       "Amount": 150.0,
//       "SalesItemLineDetail": {
//         "TaxCodeRef": {
//           "value": "NON"
//         },
//         "ItemRef": {
//           "name": "Services",
//           "value": "1"
//         }
//       },
//       "Id": "1",
//       "DetailType": "SalesItemLineDetail"
//     },
//     {
//       "DetailType": "SubTotalLineDetail",
//       "Amount": 150.0,
//       "SubTotalLineDetail": {}
//     }
//   ],
//   "ApplyTaxAfterDiscount": false,
//   "CustomField": [
//     {
//       "DefinitionId": "1",
//       "Type": "StringType",
//       "Name": "Crew #"
//     }
//   ],
//   "Id": "239",
//   "TxnTaxDetail": {
//     "TotalTax": 0
//   },
//   "MetaData": {
//     "CreateTime": "2015-07-24T10:35:08-07:00",
//     "LastUpdatedTime": "2015-07-24T10:35:08-07:00"
//   }
// }
// 
// Use the this online tool to generate the code from sample JSON: 
// Generate Code to Create JSON

Chilkat.JsonObject jsonReq = new Chilkat.JsonObject();
jsonReq.UpdateString("DocNumber","1070");
jsonReq.UpdateString("SyncToken","0");
jsonReq.UpdateString("domain","QBO");
jsonReq.UpdateNumber("Balance","150.0");
jsonReq.UpdateString("BillAddr.City","Bayshore");
jsonReq.UpdateString("BillAddr.Line1","4581 Finch St.");
jsonReq.UpdateString("BillAddr.PostalCode","94326");
jsonReq.UpdateString("BillAddr.Lat","INVALID");
jsonReq.UpdateString("BillAddr.Long","INVALID");
jsonReq.UpdateString("BillAddr.CountrySubDivisionCode","CA");
jsonReq.UpdateString("BillAddr.Id","2");
jsonReq.UpdateString("TxnDate","2015-07-24");
jsonReq.UpdateNumber("TotalAmt","150.0");
jsonReq.UpdateString("CustomerRef.name","Amy's Bird Sanctuary");
jsonReq.UpdateString("CustomerRef.value","1");
jsonReq.UpdateString("CustomerMemo.value","Added customer memo.");
jsonReq.UpdateString("ShipAddr.City","Bayshore");
jsonReq.UpdateString("ShipAddr.Line1","4581 Finch St.");
jsonReq.UpdateString("ShipAddr.PostalCode","94326");
jsonReq.UpdateString("ShipAddr.Lat","INVALID");
jsonReq.UpdateString("ShipAddr.Long","INVALID");
jsonReq.UpdateString("ShipAddr.CountrySubDivisionCode","CA");
jsonReq.UpdateString("ShipAddr.Id","109");
jsonReq.UpdateNewArray("LinkedTxn");
jsonReq.UpdateString("DueDate","2015-08-23");
jsonReq.UpdateString("PrintStatus","NeedToPrint");
jsonReq.UpdateString("EmailStatus","NotSet");
jsonReq.UpdateBool("sparse",false);
jsonReq.UpdateInt("Line[0].LineNum",1);
jsonReq.UpdateNumber("Line[0].Amount","150.0");
jsonReq.UpdateString("Line[0].SalesItemLineDetail.TaxCodeRef.value","NON");
jsonReq.UpdateString("Line[0].SalesItemLineDetail.ItemRef.name","Services");
jsonReq.UpdateString("Line[0].SalesItemLineDetail.ItemRef.value","1");
jsonReq.UpdateString("Line[0].Id","1");
jsonReq.UpdateString("Line[0].DetailType","SalesItemLineDetail");
jsonReq.UpdateString("Line[1].DetailType","SubTotalLineDetail");
jsonReq.UpdateNumber("Line[1].Amount","150.0");
jsonReq.UpdateNewObject("Line[1].SubTotalLineDetail");
jsonReq.UpdateBool("ApplyTaxAfterDiscount",false);
jsonReq.UpdateString("CustomField[0].DefinitionId","1");
jsonReq.UpdateString("CustomField[0].Type","StringType");
jsonReq.UpdateString("CustomField[0].Name","Crew #");
jsonReq.UpdateString("Id","239");
jsonReq.UpdateInt("TxnTaxDetail.TotalTax",0);
jsonReq.UpdateString("MetaData.CreateTime","2015-07-24T10:35:08-07:00");
jsonReq.UpdateString("MetaData.LastUpdatedTime","2015-07-24T10:35:08-07:00");

Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
jsonReq.EmitSb(sbRequestBody);

rest.AddHeader("Content-Type","application/json");
rest.AddHeader("Accept","application/json");
rest.AllowHeaderFolding = false;

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = rest.FullRequestSb("POST","/v3/company/<realmID>/invoice",sbRequestBody,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": "2015-07-24",
//     "domain": "QBO",
//     "PrintStatus": "NeedToPrint",
//     "TotalAmt": 150.0,
//     "Line": [
//       {
//         "LineNum": 1,
//         "Amount": 150.0,
//         "SalesItemLineDetail": {
//           "TaxCodeRef": {
//             "value": "NON"
//           },
//           "ItemRef": {
//             "name": "Services",
//             "value": "1"
//           }
//         },
//         "Id": "1",
//         "DetailType": "SalesItemLineDetail"
//       },
//       {
//         "DetailType": "SubTotalLineDetail",
//         "Amount": 150.0,
//         "SubTotalLineDetail": {}
//       }
//     ],
//     "DueDate": "2015-08-23",
//     "ApplyTaxAfterDiscount": false,
//     "DocNumber": "1070",
//     "sparse": false,
//     "CustomerMemo": {
//       "value": "Added customer memo."
//     },
//     "Deposit": 0,
//     "Balance": 150.0,
//     "CustomerRef": {
//       "name": "Amy's Bird Sanctuary",
//       "value": "1"
//     },
//     "TxnTaxDetail": {
//       "TotalTax": 0
//     },
//     "SyncToken": "1",
//     "LinkedTxn": [
//     ],
//     "ShipAddr": {
//       "CountrySubDivisionCode": "CA",
//       "City": "Bayshore",
//       "PostalCode": "94326",
//       "Id": "118",
//       "Line1": "4581 Finch St."
//     },
//     "EmailStatus": "NotSet",
//     "BillAddr": {
//       "CountrySubDivisionCode": "CA",
//       "City": "Bayshore",
//       "PostalCode": "94326",
//       "Id": "117",
//       "Line1": "4581 Finch St."
//     },
//     "MetaData": {
//       "CreateTime": "2015-07-24T10:35:08-07:00",
//       "LastUpdatedTime": "2015-07-24T10:53:39-07:00"
//     },
//     "CustomField": [
//       {
//         "DefinitionId": "1",
//         "Type": "StringType",
//         "Name": "Crew #"
//       }
//     ],
//     "Id": "239"
//   },
//   "time": "2015-07-24T10:53:39.287-07:00"
// }
// 

int LineNum;
string Amount;
string SalesItemLineDetailTaxCodeRefValue;
string SalesItemLineDetailItemRefName;
string SalesItemLineDetailItemRefValue;
string Id;
string DetailType;
string DefinitionId;
string invType;
string Name;

string InvoiceTxnDate = jsonResponse.StringOf("Invoice.TxnDate");
string InvoiceDomain = jsonResponse.StringOf("Invoice.domain");
string InvoicePrintStatus = jsonResponse.StringOf("Invoice.PrintStatus");
string InvoiceTotalAmt = jsonResponse.StringOf("Invoice.TotalAmt");
string InvoiceDueDate = jsonResponse.StringOf("Invoice.DueDate");
bool InvoiceApplyTaxAfterDiscount = jsonResponse.BoolOf("Invoice.ApplyTaxAfterDiscount");
string InvoiceDocNumber = jsonResponse.StringOf("Invoice.DocNumber");
bool InvoiceSparse = jsonResponse.BoolOf("Invoice.sparse");
string InvoiceCustomerMemoValue = jsonResponse.StringOf("Invoice.CustomerMemo.value");
int InvoiceDeposit = jsonResponse.IntOf("Invoice.Deposit");
string InvoiceBalance = jsonResponse.StringOf("Invoice.Balance");
string InvoiceCustomerRefName = jsonResponse.StringOf("Invoice.CustomerRef.name");
string InvoiceCustomerRefValue = jsonResponse.StringOf("Invoice.CustomerRef.value");
int InvoiceTxnTaxDetailTotalTax = jsonResponse.IntOf("Invoice.TxnTaxDetail.TotalTax");
string InvoiceSyncToken = jsonResponse.StringOf("Invoice.SyncToken");
string InvoiceShipAddrCountrySubDivisionCode = jsonResponse.StringOf("Invoice.ShipAddr.CountrySubDivisionCode");
string InvoiceShipAddrCity = jsonResponse.StringOf("Invoice.ShipAddr.City");
string InvoiceShipAddrPostalCode = jsonResponse.StringOf("Invoice.ShipAddr.PostalCode");
string InvoiceShipAddrId = jsonResponse.StringOf("Invoice.ShipAddr.Id");
string InvoiceShipAddrLine1 = jsonResponse.StringOf("Invoice.ShipAddr.Line1");
string InvoiceEmailStatus = jsonResponse.StringOf("Invoice.EmailStatus");
string InvoiceBillAddrCountrySubDivisionCode = jsonResponse.StringOf("Invoice.BillAddr.CountrySubDivisionCode");
string InvoiceBillAddrCity = jsonResponse.StringOf("Invoice.BillAddr.City");
string InvoiceBillAddrPostalCode = jsonResponse.StringOf("Invoice.BillAddr.PostalCode");
string InvoiceBillAddrId = jsonResponse.StringOf("Invoice.BillAddr.Id");
string InvoiceBillAddrLine1 = jsonResponse.StringOf("Invoice.BillAddr.Line1");
string InvoiceMetaDataCreateTime = jsonResponse.StringOf("Invoice.MetaData.CreateTime");
string InvoiceMetaDataLastUpdatedTime = jsonResponse.StringOf("Invoice.MetaData.LastUpdatedTime");
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;
    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;
}

i = 0;
count_i = jsonResponse.SizeOfArray("Invoice.LinkedTxn");
while (i < count_i) {
    jsonResponse.I = i;
    i = i + 1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("Invoice.CustomField");
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;
}