In this article, we will learn how to delete a purchase order 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 are going to delete the purchase order by its “Id”.
The following are a few steps for the deleting purchase order.
- 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 purchase order from Quickbooks online by calling purchase order API.
- We are querying a purchase order by “Id”.
- For querying/get a purchase order we have to define QueryService
- We need to pass a ServiceContext object into QueryService.
- We will get a purchase order object by querying from Quickbooks online using QueryService.
- After that, We have to create a DataService object by passing a ServiceContext object as a parameter.
- Add purchase order object in DataService.Delete<PurchaseOrder>() for deleting a purchase order.
- It will delete the purchase order and return the Id of the purchase order, status as Deleted in purchase order object, you can store the required details to the database according to your needs.
- The code is as below.
public ActionResult DeletePurchaseOrderById() { 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; string EXISTING_PURCHASEORDER_QUERYBYID = string.Format("select * from PurchaseOrder where id = '{0}'", "155"); var queryService = new QueryService<PurchaseOrder>(serviceContext); PurchaseOrder objPurchaseOrderFound = queryService.ExecuteIdsQuery(EXISTING_PURCHASEORDER_QUERYBYID).FirstOrDefault<PurchaseOrder>(); //If Purchase Order found on Quickbooks online if (objPurchaseOrderFound != null) { DataService dataService = new DataService(serviceContext); PurchaseOrder DeleteEntity = dataService.Delete<PurchaseOrder>(objPurchaseOrderFound); if (DeleteEntity != null && !string.IsNullOrEmpty(DeleteEntity.Id) && DeleteEntity.status == EntityStatusEnum.Deleted) { //you can write Database code here ViewBag.IsSuccess = true; } } return View(); } catch (IdsException ex) { ViewBag.IsSuccess = false; if (ex.InnerException != null && !string.IsNullOrEmpty(ex.InnerException.Message)) { ViewBag.Message = ex.InnerException.Message; } else if (!string.IsNullOrEmpty(ex.Message)) { ViewBag.Message = ex.Message; } else { ViewBag.Message = "Something went wrong,IdsException occurs"; } return View(); } catch (Exception ex) { ViewBag.IsSuccess = false; if (ex.InnerException != null && !string.IsNullOrEmpty(ex.InnerException.Message)) { ViewBag.Message = ex.InnerException.Message; } else if (!string.IsNullOrEmpty(ex.Message)) { ViewBag.Message = ex.Message; } else { ViewBag.Message = "Something went wrong,Exception occurs"; } return View(); } }
- The above code will permanently delete the purchase order from Quickbooks Online.