How To Delete Employee From Quickbooks Online Using C#

In this article, we will learn how to delete an employee 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 employee permanently from Quickbooks online, we can only inactive it.

So, if we want to delete an employee then we have to inactive it by updating.

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

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

  • First, we have to create a ServiceContext with Auth tokens and realmId.
  • For that, we need access token and realmId
  • We have to get an employee from Quickbooks online by calling Employee API.
  • We are querying an employee by “familyName” and “givenName”.
  • For querying/get an employee we have to define QueryService
  • We need to pass a ServiceContext object into QueryService.
  • We will get an Employee object by querying from Quickbooks online using QueryService.
  • After getting an Employee 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 Employee object in DataService.Update<Employee>() for updating an employee.
  • It will update(delete/inactive) employee and return the newly updated Employee object, you can store the required details to the database according to your needs.
  • The code is as below.
public ActionResult DeleteEmployeeByName()
{
  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_EMPLOYEE_QUERYBYNAME = string.Format("select * from Employee where familyName = '{0}' and givenName='{1}'", "EmployeeEmployee", "Tabish");
    var queryService = new QueryService<Employee>(serviceContext);
    Employee objEmployeeFound = queryService.ExecuteIdsQuery(EXISTING_EMPLOYEE_QUERYBYNAME).FirstOrDefault<Employee>();

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

            DataService dataService = new DataService(serviceContext);

            Employee UpdateEntity = dataService.Update<Employee>(objEmployeeFound);
            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 employees in the employee list by enabling include inactive from the filter.

Also, See:

 

Submit a Comment

Your email address will not be published. Required fields are marked *

Subscribe

Select Categories