ItemDiscounts

5 min read
    ''' <summary>
    ''' QuickBooks connection needs to be open first.
    ''' Get ItemDiscount Record Count. Returns number of records in QuickBooks
    ''' In case of error returns: will return -1
    ''' </summary>
    ''' <param name="MaxReturned">max number of records to get</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function GetItemDiscountRecordCount(Optional ByVal MaxReturned As Integer = 0, Optional ByRef errorMsg As String = "") As Integer

   ''' <summary>
    ''' QuickBooks connection needs to be open first.
    ''' Get All ItemDiscount. Returns List(Of ItemDiscount)
    ''' In case of error returns: new List(Of ItemDiscount)
    ''' NOTE: IF YOU HAVE TOO MANY RECORDS GET ItemDiscount BY DATERANGE
    ''' </summary>
    ''' <param name="ActiveStatus">qbActiveStatus enum. Values (ActiveOnly [DEFAULT], InactiveOnly, All)</param>
    ''' <param name="MaxReturned">max number of records to get</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function GetAllItemDiscount(Optional ByVal ActiveStatus As qbActiveStatus = qbActiveStatus.All, Optional ByVal MaxReturned As Integer = 0, Optional ByRef errorMsg As String = "") As List(Of ItemDiscount)

    ''' <summary>
    ''' QuickBooks connection needs to be open first.
    ''' Get ItemDiscount By ListIDs. Returns List(Of ItemDiscount)
    ''' In case of error returns: new List(Of ItemDiscount)
    ''' NOTE: IF YOU HAVE TOO MANY RECORDS GET ItemDiscount BY DATERANGE
    ''' </summary>
    ''' <param name="ListIDs">ListIDs of the ItemDiscount. If it is one ListIDs, just add one ListID to the List(Of String)</param>
    ''' <param name="MaxReturned">max number of records to get</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function GetItemDiscountByListIDs(ByVal ListIDs As List(Of String), Optional ByVal MaxReturned As Integer = 0, Optional ByRef errorMsg As String = "") As List(Of ItemDiscount)

    ''' <summary>
    ''' QuickBooks connection needs to be open first.
    ''' Get ItemDiscount By FullNames. Returns List(Of ItemDiscount)
    ''' In case of error returns: new List(Of ItemDiscount)
    ''' NOTE: IF YOU HAVE TOO MANY RECORDS GET ItemDiscount BY DATERANGE
    ''' </summary>
    ''' <param name="FullNames">FullNames of the ItemDiscount. If it is one FullNames, just add one FullNames to the List(Of String)</param>
    ''' <param name="MaxReturned">max number of records to get</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function GetItemDiscountByFullNames(ByVal FullNames As List(Of String), Optional ByVal MaxReturned As Integer = 0, Optional ByRef errorMsg As String = "") As List(Of ItemDiscount)

    ''' <summary>
    ''' QuickBooks connection needs to be open first.
    ''' Get ItemDiscounts By DateRange. Returns List(Of ItemDiscount)
    ''' In case of error returns: new List(Of ItemDiscount)
    ''' </summary>
    ''' <param name="FromModifiedDate">FromDate</param>
    ''' <param name="ToModifiedDate">ToDate</param>
    ''' <param name="MaxReturned">max number of records to get</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function GetItemDiscountsByDateRange(ByVal FromModifiedDate As DateTime, ByVal ToModifiedDate As DateTime, Optional ByVal MaxReturned As Integer = 0, Optional ByRef errorMsg As String = "") As List(Of ItemDiscount)

    ''' <summary>
    ''' QuickBooks connection needs to be open first.
    ''' Get ItemDiscounts By Name. Returns List(Of ItemDiscount)
    ''' In case of error returns: new List(Of ItemDiscount)
    ''' </summary>
    ''' <param name="Name">ItemDiscount Name</param>
    ''' <param name="MatchCriterion">qbMatchCriterion enum. Values(StartsWith, Contains, EndsWith)</param>
    ''' <param name="MaxReturned">max number of records to get</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function GetItemDiscountByName(ByVal Name As String, ByVal MatchCriterion As qbMatchCriterion, Optional ByVal MaxReturned As Integer = 0, Optional ByRef errorMsg As String = "") As List(Of ItemDiscount)

   ''' <summary>
    ''' QuickBooks connection needs to be open first.
    ''' Get ItemDiscounts By NameRange. Returns List(Of ItemDiscount)
    ''' In case of error returns: new List(Of ItemDiscount)
    ''' </summary>
    ''' <param name="FromName">FromName value</param>
    ''' <param name="ToName">ToName value.</param>
    ''' <param name="MaxReturned">max number of records to get</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function GetItemDiscountByNameRange(ByVal FromName As String, ByVal ToName As String, Optional ByVal MaxReturned As Integer = 0, Optional ByRef errorMsg As String = "") As List(Of ItemDiscount)

   ''' <summary>
    ''' QuickBooks connection needs to be open first.
    ''' Get ItemDiscountBy Class ListIDs. Returns List(Of ItemDiscount)
    ''' In case of error returns: new List(Of ItemDiscount)
    ''' </summary>
    ''' <param name="ListIDs">Entities ListIDs</param>
    ''' <param name="MaxReturned">max number of records to get</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function GetItemDiscountByClassListIDs(ByVal ListIDs As List(Of String), Optional ByVal MaxReturned As Integer = 0, Optional ByRef errorMsg As String = "") As List(Of ItemDiscount)

    ''' <summary>
    ''' QuickBooks connection needs to be open first.
    ''' Get ItemDiscountBy Class FullNames. Returns List(Of ItemDiscount)
    ''' In case of error returns: new List(Of ItemDiscount)
    ''' </summary>
    ''' <param name="FullNames">Entities FullNames</param>
    ''' <param name="MaxReturned">max number of records to get</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function GetItemDiscountByClassFullNames(ByVal FullNames As List(Of String), Optional ByVal MaxReturned As Integer = 0, Optional ByRef errorMsg As String = "") As List(Of ItemDiscount)

    ''' <summary>
    ''' QuickBooks connection needs to be open first.
    ''' Get ItemDiscountBy Class ListIDWithChildren. Returns List(Of ItemDiscount)
    ''' In case of error returns: new List(Of ItemDiscount)
    ''' </summary>
    ''' <param name="ListIDWithChildren">Class ListIDWithChildren</param>
    ''' <param name="MaxReturned">max number of records to get</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function GetItemDiscountByClassListIDWithChildren(ByVal ListIDWithChildren As String, Optional ByVal MaxReturned As Integer = 0, Optional ByRef errorMsg As String = "") As List(Of ItemDiscount)

   ''' <summary>
    ''' QuickBooks connection needs to be open first.
    ''' Get ItemDiscountBy Class FullNameWithChildren. Returns List(Of ItemDiscount)
    ''' In case of error returns: new List(Of ItemDiscount)
    ''' </summary>
    ''' <param name="FullNameWithChildren">Class FullNameWithChildren</param>
    ''' <param name="MaxReturned">max number of records to get</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function GetItemDiscountByClassFullNameWithChildren(ByVal FullNameWithChildren As String, Optional ByVal MaxReturned As Integer = 0, Optional ByRef errorMsg As String = "") As List(Of ItemDiscount)

   ''' <summary>
    ''' It will delete the record from QuickBooks.
    ''' Once deleted, there is no way to retrieve
    ''' </summary>
    ''' <param name="ListID">to add new records to QB set ListID to a temporal one</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function DeleteItemDiscountFromQuickBooksByListID(ByVal ListID As String, Optional ByRef errorMsg As String = "") As Boolean

    ''' <summary>
    ''' It will add a new ItemDiscount to ItemDiscountList.
    ''' CustomField1-CustomField15: Fotmat[CustomFieldName:CustomFieldValue]
    ''' </summary>
    ''' <param name="_ListID">to add new records to QB set ListID to a temporal one</param>
    ''' <param name="_Operation">set to empty, update, add, or delete</param>
    ''' <param name="errorMsg">returned error message</param>
Public Function AddToItemDiscountList(_ListID As String, _Name As String, Optional ByVal _TimeCreated As String = "", Optional ByVal _TimeModified As String = "", Optional ByVal _EditSequence As String = "", Optional ByVal _FullName As String = "", Optional ByVal _IsActive As String = "", Optional ByVal _BarCodeValue As String = "", Optional ByVal _AssignEvenIfUsed As String = "", Optional ByVal _AllowOverride As String = "", Optional ByVal _ParentRef_ListID As String = "", Optional ByVal _ParentRef_FullName As String = "", Optional ByVal _ClassRef_ListID As String = "", Optional ByVal _ClassRef_FullName As String = "", Optional ByVal _Sublevel As String = "", Optional ByVal _ItemDesc As String = "", Optional ByVal _SalesTaxCodeRef_ListID As String = "", Optional ByVal _SalesTaxCodeRef_FullName As String = "", Optional ByVal _DiscountRate As String = "", Optional ByVal _DiscountRatePercent As String = "", Optional ByVal _AccountRef_ListID As String = "", Optional ByVal _AccountRef_FullName As String = "", Optional ByVal _ApplyAccountRefToExistingTxns As String = "", Optional ByVal _CustomField1 As String = "", Optional ByVal _CustomField2 As String = "", Optional ByVal _CustomField3 As String = "", Optional ByVal _CustomField4 As String = "", Optional ByVal _CustomField5 As String = "", Optional ByVal _CustomField6 As String = "", Optional ByVal _CustomField7 As String = "", Optional ByVal _CustomField8 As String = "", Optional ByVal _CustomField9 As String = "", Optional ByVal _CustomField10 As String = "", Optional ByVal _CustomField11 As String = "", Optional ByVal _CustomField12 As String = "", Optional ByVal _CustomField13 As String = "", Optional ByVal _CustomField14 As String = "", Optional ByVal _CustomField15 As String = "", Optional ByVal _ExternalGUID As String = "", Optional ByVal _UserData As String = "", Optional ByVal _Operation As String = "", Optional ByRef errorMsg As String = "") As ItemDiscount