In this article, we will learn how to get customers from Quickbooks online in .NET MVC web application using SDK.

Before using any Quickbooks online API we need access token, if you don’t know how to get access token then you can find it here.

  • First, we have to create a ServiceContext with Auth tokens and realmId.
  • For that, we need access token and realmId
  • For getting customers, we have to define a QueryService object.
  • QueryService object needs a ServiceContext object as parameter.
  • So we have to create a Quickbooks QueryService using ServiceContext.
  • Here we are getting all customer from Quickbooks online, code is as below.
public ActionResult GetCustomer()
{
    List<Customer> CustomerList = new List<Customer>();
    try
    {
        OAuth2RequestValidator oauthValidator = new OAuth2RequestValidator(Access_token);
        // Create a ServiceContext with Auth tokens and realmId
        ServiceContext serviceContext = new ServiceContext(RealmId, IntuitServicesType.QBO, oauthValidator);
        serviceContext.IppConfiguration.MinorVersion.Qbo = "23";
        serviceContext.IppConfiguration.BaseUrl.Qbo = QboBaseUrl;

        // Create a QuickBooks QueryService using ServiceContext
        QueryService<Customer> querySvc = new QueryService<Customer>(serviceContext);
        CustomerList = querySvc.ExecuteIdsQuery("SELECT * FROM Customer").ToList();

        return View(CustomerList);
    }
    catch (IdsException ex)
    {
        return View(CustomerList);
    }
    catch (Exception ex)
    {
        return View(CustomerList);
    }

}
  • We will get all the customers list in the CustomerList object.
  • View Code is as below,
@model List<Intuit.Ipp.Data.Customer>

@{
    ViewBag.Title = "GetCustomer";
}

<h2>Quickbooks online Customer List</h2>

<div>
    <table class="table table-bordered">
        <tr>
            <th>QBO ID</th>
            <th>Display Name</th>
            <th>Given Name</th>
            <th>Family Name</th>
            <th>Email</th>
            <th>Primary Phone</th>
        </tr>

        @foreach (var Cust in Model)
        {
            <tr>
                <td>@Cust.Id</td>
                <td>@Cust.DisplayName</td>
                <td>@Cust.GivenName</td>
                <td>@Cust.FamilyName</td>
                @if (Cust.PrimaryEmailAddr != null && !string.IsNullOrEmpty(Cust.PrimaryEmailAddr.Address))
                {
                    <td>@Cust.PrimaryEmailAddr.Address</td>
                }
                else
                {
                    <td></td>
                }

                @if (Cust.PrimaryPhone != null &&  !string.IsNullOrEmpty(Cust.PrimaryPhone.FreeFormNumber))
                {
                    <td>@Cust.PrimaryPhone.FreeFormNumber</td>
                }
                else
                {
                    <td></td>
                }

            </tr>
        }

    </table>
</div>
  • We can also write a query according to our requirements, as like below
string EXISTING_CUSTOMER_QUERYBYID = string.Format("select * from customer where DisplayName = '{0}'", "Tabish Rangrej");
Customer objCustomerFound = queryService.ExecuteIdsQuery(EXISTING_CUSTOMER_QUERYBYID).FirstOrDefault<Customer>();
  • it will return a customer by DisplayName.
  • We will get a customer which DisplayName=”Tabish Rangrej” in the objCustomerFound object.

So that’s how we can get customers or query customers from Quickbooks online.

Output: