Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Sales Taxes. More...

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "sales tax" entity. More...

long	Count ()
	Counts the number of sales taxes. More...

IEnumerable< MixERP.Net.Entities.Core.SalesTax >	Get ()
	Returns collection of sales tax for export. More...

MixERP.Net.Entities.Core.SalesTax	Get (int salesTaxId)
	Returns an instance of sales tax. More...

IEnumerable< MixERP.Net.Entities.Core.SalesTax >	Get ([FromUri] int[] salesTaxIds)

IEnumerable< MixERP.Net.Entities.Core.SalesTax >	GetPagedResult ()
	Creates a paginated collection containing 25 sales taxes on each page, sorted by the property SalesTaxId. More...

IEnumerable< MixERP.Net.Entities.Core.SalesTax >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 sales taxes on each page, sorted by the property SalesTaxId. More...

long	CountWhere ([FromBody]dynamic filters)
	Counts the number of sales taxes using the supplied filter(s). More...

IEnumerable< MixERP.Net.Entities.Core.SalesTax >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 sales taxes on each page, sorted by the property SalesTaxId. More...

long	CountFiltered (string filterName)
	Counts the number of sales taxes using the supplied filter name. More...

IEnumerable< MixERP.Net.Entities.Core.SalesTax >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 sales taxes on each page, sorted by the property SalesTaxId. More...

IEnumerable< DisplayField >	GetDisplayFields ()
	Displayfield is a lightweight key/value collection of sales taxes. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields ()
	A custom field is a user defined field for sales taxes. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields (string resourceId)
	A custom field is a user defined field for sales taxes. More...

void	AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
	Adds or edits your instance of SalesTax class. More...

void	Add (MixERP.Net.Entities.Core.SalesTax salesTax)
	Adds your instance of SalesTax class. More...

void	Edit (int salesTaxId, [FromBody] MixERP.Net.Entities.Core.SalesTax salesTax)
	Edits existing record with your instance of SalesTax class. More...

List< object >	BulkImport ([FromBody]dynamic collection)
	Adds or edits multiple instances of SalesTax class. More...

void	Delete (int salesTaxId)
	Deletes an existing instance of SalesTax class via SalesTaxId. 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 Sales Taxes.

Member Function Documentation

void MixERP.Net.Api.Core.SalesTaxController.Add ( MixERP.Net.Entities.Core.SalesTax salesTax )

Adds your instance of SalesTax class.

Parameters

salesTax Your instance of sales taxes class to add.

void MixERP.Net.Api.Core.SalesTaxController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray form )

Adds or edits your instance of SalesTax class.

Parameters

salesTax Your instance of sales taxes class to add or edit.

List<object> MixERP.Net.Api.Core.SalesTaxController.BulkImport ( [FromBody] dynamic collection )

Adds or edits multiple instances of SalesTax class.

Parameters

collection Your collection of SalesTax class to bulk import.

Returns: Returns list of imported salesTaxIds.

Exceptions

MixERPException Thrown when your any SalesTax class in the collection is invalid or malformed.

long MixERP.Net.Api.Core.SalesTaxController.Count ( )

Counts the number of sales taxes.

Returns: Returns the count of the sales taxes.

long MixERP.Net.Api.Core.SalesTaxController.CountFiltered ( string filterName )

Counts the number of sales taxes using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered sales taxes.

long MixERP.Net.Api.Core.SalesTaxController.CountWhere ( [FromBody] dynamic filters )

Counts the number of sales taxes using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered sales taxes.

void MixERP.Net.Api.Core.SalesTaxController.Delete ( int salesTaxId )

Deletes an existing instance of SalesTax class via SalesTaxId.

Parameters

salesTaxId Enter the value for SalesTaxId in order to find and delete the existing record.

void MixERP.Net.Api.Core.SalesTaxController.Edit	(	int	salesTaxId,
		[FromBody] MixERP.Net.Entities.Core.SalesTax	salesTax
	)

Edits existing record with your instance of SalesTax class.

Parameters

salesTax	Your instance of SalesTax class to edit.
salesTaxId	Enter the value for SalesTaxId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.SalesTax> MixERP.Net.Api.Core.SalesTaxController.Get ( )

Returns collection of sales tax for export.

Returns

MixERP.Net.Entities.Core.SalesTax MixERP.Net.Api.Core.SalesTaxController.Get ( int salesTaxId )

Returns an instance of sales tax.

Parameters

salesTaxId Enter SalesTaxId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.SalesTaxController.GetCustomFields ( )

A custom field is a user defined field for sales taxes.

Returns: Returns an enumerable custom field collection of sales taxes.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.SalesTaxController.GetCustomFields ( string resourceId )

A custom field is a user defined field for sales taxes.

Returns: Returns an enumerable custom field collection of sales taxes.

IEnumerable<DisplayField> MixERP.Net.Api.Core.SalesTaxController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of sales taxes.

Returns: Returns an enumerable key/value collection of sales taxes.

EntityView MixERP.Net.Api.Core.SalesTaxController.GetEntityView ( )

Creates meta information of "sales tax" entity.

Returns: Returns the "sales tax" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Core.SalesTax> MixERP.Net.Api.Core.SalesTaxController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 sales taxes on each page, sorted by the property SalesTaxId.

Parameters

pageNumber	Enter the page number to produce the resultset.
filterName	The named filter.

Returns: Returns the requested page from the collection using the supplied filters.

IEnumerable<MixERP.Net.Entities.Core.SalesTax> MixERP.Net.Api.Core.SalesTaxController.GetPagedResult ( )

Creates a paginated collection containing 25 sales taxes on each page, sorted by the property SalesTaxId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.SalesTax> MixERP.Net.Api.Core.SalesTaxController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 sales taxes on each page, sorted by the property SalesTaxId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Core.SalesTax> MixERP.Net.Api.Core.SalesTaxController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 sales taxes on each page, sorted by the property SalesTaxId.

Parameters

pageNumber	Enter the page number to produce the resultset.
filters	The 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:

C:/Users/nirvan/Desktop/mixerp/0. GitHub/src/Libraries/Web API/Core/SalesTaxController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation