C#

QuickBooks - Query a Customer

See more QuickBooks Examples

Demonstrates how to query QuickBooks customers.

A sample JSON response body is available at Sample Quickbooks Customer Query JSON Response

C#

bool success = false;

//  This example assumes the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

//  Get our previously obtained OAuth2 access token, which should contain JSON like this:
//  {
//    "expires_in": 3600,
//    "x_refresh_token_expires_in": 8726400,
//    "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
//    "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
//    "token_type": "bearer"
//  }

Chilkat.JsonObject jsonToken = new Chilkat.JsonObject();
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json");

Chilkat.Rest rest = new Chilkat.Rest();

//  Connect using TLS.
//  A single REST object, once connected, can be used for many Quickbooks REST API calls.
//  The auto-reconnect indicates that if the already-established HTTPS connection is closed,
//  then it will be automatically re-established as needed.
bool bAutoReconnect = true;
success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,true,bAutoReconnect);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

Chilkat.StringBuilder sbAuth = new Chilkat.StringBuilder();
sbAuth.Append("Bearer ");
sbAuth.Append(jsonToken.StringOf("access_token"));
rest.Authorization = sbAuth.GetAsString();

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

string query = "select * from Customer";
rest.AddQueryParam("query",query);
rest.AddQueryParam("minorversion","45");

//  The company ID is 123146096291789
string responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/query");
if (rest.LastMethodSuccess != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

//  We should expect a 200 response if successful.
if (rest.ResponseStatusCode != 200) {
    Debug.WriteLine("Request Header: ");
    Debug.WriteLine(rest.LastRequestHeader);
    Debug.WriteLine("----");
    Debug.WriteLine("Response StatusCode = " + Convert.ToString(rest.ResponseStatusCode));
    Debug.WriteLine("Response StatusLine: " + rest.ResponseStatusText);
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(rest.ResponseHeader);
    Debug.WriteLine(responseBody);
    return;
}

//  Load the JSON response into a JSON object for parsing.
//  A sample JSON response is shown below.
Chilkat.JsonObject json = new Chilkat.JsonObject();
json.EmitCompact = false;
json.Load(responseBody);

//  Use this online tool to generate parsing code from sample JSON: 
//  Generate Parsing Code from JSON

//  Iterate over each customer returned.
int numRecords = json.SizeOfArray("QueryResponse.Customer");
int i = 0;
while (i < numRecords) {

    json.I = i;
    Debug.WriteLine("Name: " + json.StringOf("QueryResponse.Customer[i].FullyQualifiedName"));
    Debug.WriteLine("Id: " + json.StringOf("QueryResponse.Customer[i].Id"));
    Debug.WriteLine("City: " + json.StringOf("QueryResponse.Customer[i].BillAddr.City"));
    Debug.WriteLine("----");
    i = i + 1;
}

Debug.WriteLine("Success.");