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

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

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

long	Count ()
	Counts the number of sales tax types. More...

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

MixERP.Net.Entities.Core.SalesTaxType	Get (int salesTaxTypeId)
	Returns an instance of sales tax type. More...

IEnumerable< MixERP.Net.Entities.Core.SalesTaxType >	Get ([FromUri] int[] salesTaxTypeIds)

IEnumerable< MixERP.Net.Entities.Core.SalesTaxType >	GetPagedResult ()
	Creates a paginated collection containing 25 sales tax types on each page, sorted by the property SalesTaxTypeId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.SalesTaxType salesTaxType)
	Adds your instance of SalesTaxType class. More...

void	Edit (int salesTaxTypeId, [FromBody] MixERP.Net.Entities.Core.SalesTaxType salesTaxType)
	Edits existing record with your instance of SalesTaxType class. More...

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

void	Delete (int salesTaxTypeId)
	Deletes an existing instance of SalesTaxType class via SalesTaxTypeId. 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 Tax Types.

Member Function Documentation

void MixERP.Net.Api.Core.SalesTaxTypeController.Add ( MixERP.Net.Entities.Core.SalesTaxType salesTaxType )

Adds your instance of SalesTaxType class.

Parameters

salesTaxType Your instance of sales tax types class to add.

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

Adds or edits your instance of SalesTaxType class.

Parameters

salesTaxType Your instance of sales tax types class to add or edit.

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

Adds or edits multiple instances of SalesTaxType class.

Parameters

collection Your collection of SalesTaxType class to bulk import.

Returns: Returns list of imported salesTaxTypeIds.

Exceptions

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

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

Counts the number of sales tax types.

Returns: Returns the count of the sales tax types.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered sales tax types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered sales tax types.

void MixERP.Net.Api.Core.SalesTaxTypeController.Delete ( int salesTaxTypeId )

Deletes an existing instance of SalesTaxType class via SalesTaxTypeId.

Parameters

salesTaxTypeId Enter the value for SalesTaxTypeId in order to find and delete the existing record.

void MixERP.Net.Api.Core.SalesTaxTypeController.Edit	(	int	salesTaxTypeId,
		[FromBody] MixERP.Net.Entities.Core.SalesTaxType	salesTaxType
	)

Edits existing record with your instance of SalesTaxType class.

Parameters

salesTaxType	Your instance of SalesTaxType class to edit.
salesTaxTypeId	Enter the value for SalesTaxTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.SalesTaxType> MixERP.Net.Api.Core.SalesTaxTypeController.Get ( )

Returns collection of sales tax type for export.

Returns

MixERP.Net.Entities.Core.SalesTaxType MixERP.Net.Api.Core.SalesTaxTypeController.Get ( int salesTaxTypeId )

Returns an instance of sales tax type.

Parameters

salesTaxTypeId Enter SalesTaxTypeId to search for.

Returns

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

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

Returns: Returns an enumerable custom field collection of sales tax types.

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

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

Returns: Returns an enumerable custom field collection of sales tax types.

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

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

Returns: Returns an enumerable key/value collection of sales tax types.

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

Creates meta information of "sales tax type" entity.

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

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

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

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.SalesTaxType> MixERP.Net.Api.Core.SalesTaxTypeController.GetPagedResult ( )

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.SalesTaxType> MixERP.Net.Api.Core.SalesTaxTypeController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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/SalesTaxTypeController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation