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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "account master" entity. More...

long	Count ()
	Counts the number of account masters. More...

IEnumerable< MixERP.Net.Entities.Core.AccountMaster >	Get ()
	Returns collection of account master for export. More...

MixERP.Net.Entities.Core.AccountMaster	Get (short accountMasterId)
	Returns an instance of account master. More...

IEnumerable< MixERP.Net.Entities.Core.AccountMaster >	Get ([FromUri] short[] accountMasterIds)

IEnumerable< MixERP.Net.Entities.Core.AccountMaster >	GetPagedResult ()
	Creates a paginated collection containing 25 account masters on each page, sorted by the property AccountMasterId. More...

IEnumerable< MixERP.Net.Entities.Core.AccountMaster >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 account masters on each page, sorted by the property AccountMasterId. More...

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.AccountMaster accountMaster)
	Adds your instance of AccountMaster class. More...

void	Edit (short accountMasterId, [FromBody] MixERP.Net.Entities.Core.AccountMaster accountMaster)
	Edits existing record with your instance of AccountMaster class. More...

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

void	Delete (short accountMasterId)
	Deletes an existing instance of AccountMaster class via AccountMasterId. 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 Account Masters.

Member Function Documentation

void MixERP.Net.Api.Core.AccountMasterController.Add ( MixERP.Net.Entities.Core.AccountMaster accountMaster )

Adds your instance of AccountMaster class.

Parameters

accountMaster Your instance of account masters class to add.

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

Adds or edits your instance of AccountMaster class.

Parameters

accountMaster Your instance of account masters class to add or edit.

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

Adds or edits multiple instances of AccountMaster class.

Parameters

collection Your collection of AccountMaster class to bulk import.

Returns: Returns list of imported accountMasterIds.

Exceptions

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

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

Counts the number of account masters.

Returns: Returns the count of the account masters.

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

Counts the number of account masters using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered account masters.

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

Counts the number of account masters using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered account masters.

void MixERP.Net.Api.Core.AccountMasterController.Delete ( short accountMasterId )

Deletes an existing instance of AccountMaster class via AccountMasterId.

Parameters

accountMasterId Enter the value for AccountMasterId in order to find and delete the existing record.

void MixERP.Net.Api.Core.AccountMasterController.Edit	(	short	accountMasterId,
		[FromBody] MixERP.Net.Entities.Core.AccountMaster	accountMaster
	)

Edits existing record with your instance of AccountMaster class.

Parameters

accountMaster	Your instance of AccountMaster class to edit.
accountMasterId	Enter the value for AccountMasterId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.AccountMaster> MixERP.Net.Api.Core.AccountMasterController.Get ( )

Returns collection of account master for export.

Returns

MixERP.Net.Entities.Core.AccountMaster MixERP.Net.Api.Core.AccountMasterController.Get ( short accountMasterId )

Returns an instance of account master.

Parameters

accountMasterId Enter AccountMasterId to search for.

Returns

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

A custom field is a user defined field for account masters.

Returns: Returns an enumerable custom field collection of account masters.

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

A custom field is a user defined field for account masters.

Returns: Returns an enumerable custom field collection of account masters.

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

Displayfield is a lightweight key/value collection of account masters.

Returns: Returns an enumerable key/value collection of account masters.

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

Creates meta information of "account master" entity.

Returns: Returns the "account master" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 account masters on each page, sorted by the property AccountMasterId.

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

Creates a paginated collection containing 25 account masters on each page, sorted by the property AccountMasterId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.AccountMaster> MixERP.Net.Api.Core.AccountMasterController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 account masters on each page, sorted by the property AccountMasterId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 account masters on each page, sorted by the property AccountMasterId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation