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

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

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

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

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

MixERP.Net.Entities.Core.TaxRateType	Get (string taxRateTypeCode)
	Returns an instance of tax rate type. More...

IEnumerable< MixERP.Net.Entities.Core.TaxRateType >	Get ([FromUri] string[] taxRateTypeCodes)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.TaxRateType taxRateType)
	Adds your instance of TaxRateType class. More...

void	Edit (string taxRateTypeCode, [FromBody] MixERP.Net.Entities.Core.TaxRateType taxRateType)
	Edits existing record with your instance of TaxRateType class. More...

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

void	Delete (string taxRateTypeCode)
	Deletes an existing instance of TaxRateType class via TaxRateTypeCode. 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 Rate Types.

Member Function Documentation

void MixERP.Net.Api.Core.TaxRateTypeController.Add ( MixERP.Net.Entities.Core.TaxRateType taxRateType )

Adds your instance of TaxRateType class.

Parameters

taxRateType Your instance of tax rate types class to add.

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

Adds or edits your instance of TaxRateType class.

Parameters

taxRateType Your instance of tax rate types class to add or edit.

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

Adds or edits multiple instances of TaxRateType class.

Parameters

collection Your collection of TaxRateType class to bulk import.

Returns: Returns list of imported taxRateTypeCodes.

Exceptions

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

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

Counts the number of tax rate types.

Returns: Returns the count of the tax rate types.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered tax rate types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered tax rate types.

void MixERP.Net.Api.Core.TaxRateTypeController.Delete ( string taxRateTypeCode )

Deletes an existing instance of TaxRateType class via TaxRateTypeCode.

Parameters

taxRateTypeCode Enter the value for TaxRateTypeCode in order to find and delete the existing record.

void MixERP.Net.Api.Core.TaxRateTypeController.Edit	(	string	taxRateTypeCode,
		[FromBody] MixERP.Net.Entities.Core.TaxRateType	taxRateType
	)

Edits existing record with your instance of TaxRateType class.

Parameters

taxRateType	Your instance of TaxRateType class to edit.
taxRateTypeCode	Enter the value for TaxRateTypeCode in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.TaxRateType> MixERP.Net.Api.Core.TaxRateTypeController.Get ( )

Returns collection of tax rate type for export.

Returns

MixERP.Net.Entities.Core.TaxRateType MixERP.Net.Api.Core.TaxRateTypeController.Get ( string taxRateTypeCode )

Returns an instance of tax rate type.

Parameters

taxRateTypeCode Enter TaxRateTypeCode to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "tax rate type" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.TaxRateType> MixERP.Net.Api.Core.TaxRateTypeController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation