In this article, we will learn how to delete a payment 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 payment by its “Id”.

The following are a few steps for the deleting payment.

  • 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 payment from Quickbooks online by calling payment API.
  • We are querying a payment by “Id”.
  • For querying/get a payment we have to define QueryService
  • We need to pass a ServiceContext object into QueryService.
  • We will get a payment 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 payment object in DataService.Delete<Payment>() for deleting a payment.
  • It will delete the payment and return the Id of the payment, status as Deleted in payment object, you can store the required details to the database according to your needs.
  • The code is as below.
public ActionResult DeletePaymentById()
{
  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_PAYMENT_QUERYBYID = string.Format("select * from Payment where id = '{0}'", "157");
    var queryService = new QueryService<Payment>(serviceContext);
    Payment objPaymentFound = queryService.ExecuteIdsQuery(EXISTING_PAYMENT_QUERYBYID).FirstOrDefault<Payment>();

    //If Payment Order found on Quickbooks online
    if (objPaymentFound != null)
    {
        DataService dataService = new DataService(serviceContext);

        Payment DeleteEntity = dataService.Delete<Payment>(objPaymentFound);
        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();
  }
}
  • View code is as below,
@{
    ViewBag.Title = "DeletePaymentById";
}

<h2>Delete Payment By Id</h2>


@if (ViewBag.IsSuccess != null && ViewBag.IsSuccess == true)
{
    <div class="row">
        <label class="label label-success"> Payment Deleted 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 permanently delete the payment from Quickbooks Online.