How To Delete Vendor From Quickbooks Online Using C#

In this article, we will learn how to delete vendor from Quickbooks online from .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.

We can not delete vendor permanently from Quickbooks online, we can only inactive it.

So, if we want to delete any vendor then we have to inactive it by updating.

We are going to delete the vendor by its “familyName” and “givenName”.

The following are a few steps for delete(inactive) vendors.

• First, we have to create a ServiceContext with Auth tokens and realmId.
• For that, we need access token and realmId
• We have to get a vendor from Quickbooks online by calling Vendor API.
• We are querying a vendor by “familyName” and “givenName”.
• For querying/get a vendor we have to define QueryService
• We need to pass a ServiceContext object into QueryService.
• We will get a Vendor object by querying from Quickbooks online using QueryService.
• After getting a Vendor object we will change its Active property to false.
• After that, We have to create a DataService object by passing a ServiceContext object as a parameter.
• Add Vendor object in DataService.Update<Vendor >() for updating a vendor.
• It will update(delete/inactive) vendor and return the newly updated Vendor object, you can store the required details to the database according to your needs.
• The code is as below.

public ActionResult DeleteVendorByName()
{
  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;

    //Make select query
    string EXISTING_VENDOR_QUERYBYNAME = string.Format("select * from Vendor where familyName = '{0}' and givenName='{1}'", "VENDORVENDOR", "Tabish");

    var queryService = new QueryService<Vendor>(serviceContext);
    Vendor objVendorFound = queryService.ExecuteIdsQuery(EXISTING_VENDOR_QUERYBYNAME).FirstOrDefault<Vendor>();

    //if Vendor found from quickbooks online
    if (objVendorFound != null)
    {
        //if Vendor is active
        if (objVendorFound.Active == true)
        {
            objVendorFound.Active = false;

            DataService dataService = new DataService(serviceContext);

            Vendor UpdateEntity = dataService.Update<Vendor>(objVendorFound);
            if (UpdateEntity != null && !string.IsNullOrEmpty(UpdateEntity.Id))
            {
                ViewBag.IsSuccess = true;
            }
        }
        else
        {
            ViewBag.IsSuccess = true;
        }
    }

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

 

In Quickbooks online, We can find deleted vendors in the vendor list by enabling include inactive from the filter.