MixERP.Net.Api.Core.TaxExemptTypeController Class Reference

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Tax Exempt Types. More...

Inheritance diagram for MixERP.Net.Api.Core.TaxExemptTypeController:

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "tax exempt type" entity. More...
 
long Count ()
 Counts the number of tax exempt types. More...
 
IEnumerable< MixERP.Net.Entities.Core.TaxExemptTypeGet ()
 Returns collection of tax exempt type for export. More...
 
MixERP.Net.Entities.Core.TaxExemptType Get (int taxExemptTypeId)
 Returns an instance of tax exempt type. More...
 
IEnumerable< MixERP.Net.Entities.Core.TaxExemptTypeGet ([FromUri] int[] taxExemptTypeIds)
 
IEnumerable< MixERP.Net.Entities.Core.TaxExemptTypeGetPagedResult ()
 Creates a paginated collection containing 25 tax exempt types on each page, sorted by the property TaxExemptTypeId. More...
 
IEnumerable< MixERP.Net.Entities.Core.TaxExemptTypeGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 tax exempt types on each page, sorted by the property TaxExemptTypeId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of tax exempt types using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Core.TaxExemptTypeGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 tax exempt types on each page, sorted by the property TaxExemptTypeId. More...
 
long CountFiltered (string filterName)
 Counts the number of tax exempt types using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Core.TaxExemptTypeGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 tax exempt types on each page, sorted by the property TaxExemptTypeId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of tax exempt types. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for tax exempt types. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for tax exempt types. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of TaxExemptType class. More...
 
void Add (MixERP.Net.Entities.Core.TaxExemptType taxExemptType)
 Adds your instance of TaxExemptType class. More...
 
void Edit (int taxExemptTypeId, [FromBody] MixERP.Net.Entities.Core.TaxExemptType taxExemptType)
 Edits existing record with your instance of TaxExemptType class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of TaxExemptType class. More...
 
void Delete (int taxExemptTypeId)
 Deletes an existing instance of TaxExemptType class via TaxExemptTypeId. More...
 

Properties

long LoginId [get]
 
int UserId [get]
 
int OfficeId [get]
 
string Catalog [get]
 

Detailed Description

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Tax Exempt Types.

Member Function Documentation

void MixERP.Net.Api.Core.TaxExemptTypeController.Add ( MixERP.Net.Entities.Core.TaxExemptType  taxExemptType)

Adds your instance of TaxExemptType class.

Parameters
taxExemptTypeYour instance of tax exempt types class to add.
void MixERP.Net.Api.Core.TaxExemptTypeController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of TaxExemptType class.

Parameters
taxExemptTypeYour instance of tax exempt types class to add or edit.
List<object> MixERP.Net.Api.Core.TaxExemptTypeController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of TaxExemptType class.

Parameters
collectionYour collection of TaxExemptType class to bulk import.
Returns
Returns list of imported taxExemptTypeIds.
Exceptions
MixERPExceptionThrown when your any TaxExemptType class in the collection is invalid or malformed.
long MixERP.Net.Api.Core.TaxExemptTypeController.Count ( )

Counts the number of tax exempt types.

Returns
Returns the count of the tax exempt types.
long MixERP.Net.Api.Core.TaxExemptTypeController.CountFiltered ( string  filterName)

Counts the number of tax exempt types using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered tax exempt types.
long MixERP.Net.Api.Core.TaxExemptTypeController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of tax exempt types using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered tax exempt types.
void MixERP.Net.Api.Core.TaxExemptTypeController.Delete ( int  taxExemptTypeId)

Deletes an existing instance of TaxExemptType class via TaxExemptTypeId.

Parameters
taxExemptTypeIdEnter the value for TaxExemptTypeId in order to find and delete the existing record.
void MixERP.Net.Api.Core.TaxExemptTypeController.Edit ( int  taxExemptTypeId,
[FromBody] MixERP.Net.Entities.Core.TaxExemptType  taxExemptType 
)

Edits existing record with your instance of TaxExemptType class.

Parameters
taxExemptTypeYour instance of TaxExemptType class to edit.
taxExemptTypeIdEnter the value for TaxExemptTypeId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Core.TaxExemptType> MixERP.Net.Api.Core.TaxExemptTypeController.Get ( )

Returns collection of tax exempt type for export.

Returns
MixERP.Net.Entities.Core.TaxExemptType MixERP.Net.Api.Core.TaxExemptTypeController.Get ( int  taxExemptTypeId)

Returns an instance of tax exempt type.

Parameters
taxExemptTypeIdEnter TaxExemptTypeId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.TaxExemptTypeController.GetCustomFields ( )

A custom field is a user defined field for tax exempt types.

Returns
Returns an enumerable custom field collection of tax exempt types.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.TaxExemptTypeController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for tax exempt types.

Returns
Returns an enumerable custom field collection of tax exempt types.
IEnumerable<DisplayField> MixERP.Net.Api.Core.TaxExemptTypeController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of tax exempt types.

Returns
Returns an enumerable key/value collection of tax exempt types.
EntityView MixERP.Net.Api.Core.TaxExemptTypeController.GetEntityView ( )

Creates meta information of "tax exempt type" entity.

Returns
Returns the "tax exempt type" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Core.TaxExemptType> MixERP.Net.Api.Core.TaxExemptTypeController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 tax exempt types on each page, sorted by the property TaxExemptTypeId.

Parameters
pageNumberEnter the page number to produce the resultset.
filterNameThe named filter.
Returns
Returns the requested page from the collection using the supplied filters.
IEnumerable<MixERP.Net.Entities.Core.TaxExemptType> MixERP.Net.Api.Core.TaxExemptTypeController.GetPagedResult ( )

Creates a paginated collection containing 25 tax exempt types on each page, sorted by the property TaxExemptTypeId.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Core.TaxExemptType> MixERP.Net.Api.Core.TaxExemptTypeController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 tax exempt types on each page, sorted by the property TaxExemptTypeId.

Parameters
pageNumberEnter the page number to produce the resultset.
Returns
Returns the requested page from the collection.
IEnumerable<MixERP.Net.Entities.Core.TaxExemptType> MixERP.Net.Api.Core.TaxExemptTypeController.GetWhere ( long  pageNumber,
[FromBody] dynamic  filters 
)

Creates a filtered and paginated collection containing 25 tax exempt types on each page, sorted by the property TaxExemptTypeId.

Parameters
pageNumberEnter the page number to produce the resultset.
filtersThe list of filter conditions.
Returns
Returns the requested page from the collection using the supplied filters.

The documentation for this class was generated from the following file: