(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 C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkJsonObject.h>
#include <C_CkRest.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkJsonObject jsonToken;
    BOOL success;
    HCkRest rest;
    BOOL bTls;
    int port;
    BOOL bAutoReconnect;
    BOOL success;
    HCkStringBuilder sbAuth;
    HCkJsonObject jsonReq;
    HCkStringBuilder sbRequestBody;
    HCkStringBuilder sbResponseBody;
    int respStatusCode;
    HCkJsonObject jsonResponse;
    int LineNum;
    const char *Amount;
    const char *SalesItemLineDetailTaxCodeRefValue;
    const char *SalesItemLineDetailItemRefName;
    const char *SalesItemLineDetailItemRefValue;
    const char *Id;
    const char *DetailType;
    const char *DefinitionId;
    const char *invType;
    const char *Name;
    const char *InvoiceTxnDate;
    const char *InvoiceDomain;
    const char *InvoicePrintStatus;
    const char *InvoiceTotalAmt;
    const char *InvoiceDueDate;
    BOOL InvoiceApplyTaxAfterDiscount;
    const char *InvoiceDocNumber;
    BOOL InvoiceSparse;
    const char *InvoiceCustomerMemoValue;
    int InvoiceDeposit;
    const char *InvoiceBalance;
    const char *InvoiceCustomerRefName;
    const char *InvoiceCustomerRefValue;
    int InvoiceTxnTaxDetailTotalTax;
    const char *InvoiceSyncToken;
    const char *InvoiceShipAddrCountrySubDivisionCode;
    const char *InvoiceShipAddrCity;
    const char *InvoiceShipAddrPostalCode;
    const char *InvoiceShipAddrId;
    const char *InvoiceShipAddrLine1;
    const char *InvoiceEmailStatus;
    const char *InvoiceBillAddrCountrySubDivisionCode;
    const char *InvoiceBillAddrCity;
    const char *InvoiceBillAddrPostalCode;
    const char *InvoiceBillAddrId;
    const char *InvoiceBillAddrLine1;
    const char *InvoiceMetaDataCreateTime;
    const char *InvoiceMetaDataLastUpdatedTime;
    const char *InvoiceId;
    const char *time;
    int i;
    int count_i;

    // 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 = CkJsonObject_Create();
    success = CkJsonObject_LoadFile(jsonToken,"qa_data/tokens/qb-access-token.json");

    rest = CkRest_Create();

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

    sbAuth = CkStringBuilder_Create();
    CkStringBuilder_Append(sbAuth,"Bearer ");
    CkStringBuilder_Append(sbAuth,CkJsonObject_stringOf(jsonToken,"access_token"));
    CkRest_putAuthorization(rest,CkStringBuilder_getAsString(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:

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

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

    sbRequestBody = CkStringBuilder_Create();
    CkJsonObject_EmitSb(jsonReq,sbRequestBody);

    CkRest_AddHeader(rest,"Content-Type","application/json");
    CkRest_AddHeader(rest,"Accept","application/json");
    CkRest_putAllowHeaderFolding(rest,FALSE);

    sbResponseBody = CkStringBuilder_Create();
    success = CkRest_FullRequestSb(rest,"POST","/v3/company/<realmID>/invoice",sbRequestBody,sbResponseBody);
    if (success != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkJsonObject_Dispose(jsonToken);
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbAuth);
        CkJsonObject_Dispose(jsonReq);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    respStatusCode = CkRest_getResponseStatusCode(rest);

    // Success is indicated by a 200 response status code.
    printf("response status code = %d\n",respStatusCode);

    jsonResponse = CkJsonObject_Create();
    CkJsonObject_LoadSb(jsonResponse,sbResponseBody);
    CkJsonObject_putEmitCompact(jsonResponse,FALSE);
    printf("%s\n",CkJsonObject_emit(jsonResponse));

    if (CkRest_getResponseStatusCode(rest) != 200) {
        printf("Failed.\n");
        CkJsonObject_Dispose(jsonToken);
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbAuth);
        CkJsonObject_Dispose(jsonReq);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jsonResponse);
        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"
    // }
    // 

    // 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.

    InvoiceTxnDate = CkJsonObject_stringOf(jsonResponse,"Invoice.TxnDate");
    InvoiceDomain = CkJsonObject_stringOf(jsonResponse,"Invoice.domain");
    InvoicePrintStatus = CkJsonObject_stringOf(jsonResponse,"Invoice.PrintStatus");
    InvoiceTotalAmt = CkJsonObject_stringOf(jsonResponse,"Invoice.TotalAmt");
    InvoiceDueDate = CkJsonObject_stringOf(jsonResponse,"Invoice.DueDate");
    InvoiceApplyTaxAfterDiscount = CkJsonObject_BoolOf(jsonResponse,"Invoice.ApplyTaxAfterDiscount");
    InvoiceDocNumber = CkJsonObject_stringOf(jsonResponse,"Invoice.DocNumber");
    InvoiceSparse = CkJsonObject_BoolOf(jsonResponse,"Invoice.sparse");
    InvoiceCustomerMemoValue = CkJsonObject_stringOf(jsonResponse,"Invoice.CustomerMemo.value");
    InvoiceDeposit = CkJsonObject_IntOf(jsonResponse,"Invoice.Deposit");
    InvoiceBalance = CkJsonObject_stringOf(jsonResponse,"Invoice.Balance");
    InvoiceCustomerRefName = CkJsonObject_stringOf(jsonResponse,"Invoice.CustomerRef.name");
    InvoiceCustomerRefValue = CkJsonObject_stringOf(jsonResponse,"Invoice.CustomerRef.value");
    InvoiceTxnTaxDetailTotalTax = CkJsonObject_IntOf(jsonResponse,"Invoice.TxnTaxDetail.TotalTax");
    InvoiceSyncToken = CkJsonObject_stringOf(jsonResponse,"Invoice.SyncToken");
    InvoiceShipAddrCountrySubDivisionCode = CkJsonObject_stringOf(jsonResponse,"Invoice.ShipAddr.CountrySubDivisionCode");
    InvoiceShipAddrCity = CkJsonObject_stringOf(jsonResponse,"Invoice.ShipAddr.City");
    InvoiceShipAddrPostalCode = CkJsonObject_stringOf(jsonResponse,"Invoice.ShipAddr.PostalCode");
    InvoiceShipAddrId = CkJsonObject_stringOf(jsonResponse,"Invoice.ShipAddr.Id");
    InvoiceShipAddrLine1 = CkJsonObject_stringOf(jsonResponse,"Invoice.ShipAddr.Line1");
    InvoiceEmailStatus = CkJsonObject_stringOf(jsonResponse,"Invoice.EmailStatus");
    InvoiceBillAddrCountrySubDivisionCode = CkJsonObject_stringOf(jsonResponse,"Invoice.BillAddr.CountrySubDivisionCode");
    InvoiceBillAddrCity = CkJsonObject_stringOf(jsonResponse,"Invoice.BillAddr.City");
    InvoiceBillAddrPostalCode = CkJsonObject_stringOf(jsonResponse,"Invoice.BillAddr.PostalCode");
    InvoiceBillAddrId = CkJsonObject_stringOf(jsonResponse,"Invoice.BillAddr.Id");
    InvoiceBillAddrLine1 = CkJsonObject_stringOf(jsonResponse,"Invoice.BillAddr.Line1");
    InvoiceMetaDataCreateTime = CkJsonObject_stringOf(jsonResponse,"Invoice.MetaData.CreateTime");
    InvoiceMetaDataLastUpdatedTime = CkJsonObject_stringOf(jsonResponse,"Invoice.MetaData.LastUpdatedTime");
    InvoiceId = CkJsonObject_stringOf(jsonResponse,"Invoice.Id");
    time = CkJsonObject_stringOf(jsonResponse,"time");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jsonResponse,"Invoice.Line");
    while (i < count_i) {
        CkJsonObject_putI(jsonResponse,i);
        LineNum = CkJsonObject_IntOf(jsonResponse,"Invoice.Line[i].LineNum");
        Amount = CkJsonObject_stringOf(jsonResponse,"Invoice.Line[i].Amount");
        SalesItemLineDetailTaxCodeRefValue = CkJsonObject_stringOf(jsonResponse,"Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value");
        SalesItemLineDetailItemRefName = CkJsonObject_stringOf(jsonResponse,"Invoice.Line[i].SalesItemLineDetail.ItemRef.name");
        SalesItemLineDetailItemRefValue = CkJsonObject_stringOf(jsonResponse,"Invoice.Line[i].SalesItemLineDetail.ItemRef.value");
        Id = CkJsonObject_stringOf(jsonResponse,"Invoice.Line[i].Id");
        DetailType = CkJsonObject_stringOf(jsonResponse,"Invoice.Line[i].DetailType");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jsonResponse,"Invoice.LinkedTxn");
    while (i < count_i) {
        CkJsonObject_putI(jsonResponse,i);
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jsonResponse,"Invoice.CustomField");
    while (i < count_i) {
        CkJsonObject_putI(jsonResponse,i);
        DefinitionId = CkJsonObject_stringOf(jsonResponse,"Invoice.CustomField[i].DefinitionId");
        invType = CkJsonObject_stringOf(jsonResponse,"Invoice.CustomField[i].Type");
        Name = CkJsonObject_stringOf(jsonResponse,"Invoice.CustomField[i].Name");
        i = i + 1;
    }



    CkJsonObject_Dispose(jsonToken);
    CkRest_Dispose(rest);
    CkStringBuilder_Dispose(sbAuth);
    CkJsonObject_Dispose(jsonReq);
    CkStringBuilder_Dispose(sbRequestBody);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jsonResponse);

    }