In this article, we will learn how to add an estimate in 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.
CustomerRef and Line elements are required for creating an estimate, we will use these two required elements for creating an estimate.
We have to give the customer reference in CustomerRef, and items or item reference with other details (like quantity) in Line.
Item must be already added in Quickbooks before adding it to the estimate.
Also If we do not provide the shipping address and billing address, then the address from the referenced Customer object is used.
Let’s create an Estimate.
- First, we have to create a ServiceContext with Auth tokens and realmId.
- For that, we need access token and realmId
- Then, we have to create an Estimate object and assign data into an object, the following are some required data information that we have to give.
- CustomerRef: we have to give Quickbooks online Customer ID as a reference for the customer.
- Line: we have to give items details as a reference for the estimate item or line item, we need to provide at least one item reference. for reference, we have to specify Quickbooks online Item ID. we also have to define the amount and quantity of a particular item.
- After that, We have to create a DataService object by passing a ServiceContext object as a parameter.
- Add Estimate object in DataService.Add() for adding an estimate.
- If an estimate created successfully, it will return the newly-created estimate object, from this object you can store details like estimate Id, estimate number in the database if you want to.
- The code is as below.
public ActionResult CreateEstimate() { 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; Estimate ObjEstimate = new Estimate(); ObjEstimate.CustomerRef = new ReferenceType(); ObjEstimate.CustomerRef.Value = "58"; //Quickbooks online Customer Id List<Line> LineList = new List<Line>(); Line objLine = new Line(); objLine.DetailTypeSpecified = true; objLine.DetailType = LineDetailTypeEnum.SalesItemLineDetail; objLine.AmountSpecified = true; objLine.Amount = 100; SalesItemLineDetail salesItemLineDetail = new SalesItemLineDetail(); salesItemLineDetail.QtySpecified = true; salesItemLineDetail.Qty = 1; salesItemLineDetail.ItemRef = new ReferenceType(); salesItemLineDetail.ItemRef.Value = "19"; //Quickbooks online Item Id objLine.AnyIntuitObject = salesItemLineDetail; LineList.Add(objLine); ObjEstimate.Line = LineList.ToArray(); DataService dataService = new DataService(serviceContext); Estimate EstimateAdd = dataService.Add(ObjEstimate); if (EstimateAdd != null && !string.IsNullOrEmpty(EstimateAdd.Id)) { //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(); } }
- View code is as below
@{ ViewBag.Title = "CreateEstimate"; } <h2>Create Estimate</h2> @if (ViewBag.IsSuccess != null && ViewBag.IsSuccess == true) { <div class="row"> <label class="label label-success"> Estimate Created Successfully </label> </div> } else if (ViewBag.IsSuccess != null && ViewBag.IsSuccess == false) { <div class="row"> <label class="label label-danger">@ViewBag.Message</label> </div> }
- The above code will add an estimate in Quickbooks Online. we can define more than one line item and add it in LineList List, it will add a list of items in the estimate.
- Before Adding the estimate, we have to make sure one thing that the Customer ID and Item ID we gave as a reference must exist on Quickbooks online.
- You can also query/get Customer and Item before adding the estimate and then add it references. or you can store it in the database at the time of add Customer/Item and use it accordingly.
- So this way we can add an estimate in Quickbooks Online.
OUTPUT:(estimate preview on Quickbook online)
How to link estimate and invoice using c#?