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

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

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

long	Count ()
	Counts the number of transaction types. More...

IEnumerable< MixERP.Net.Entities.Core.TransactionType >	Get ()
	Returns collection of transaction type for export. More...

MixERP.Net.Entities.Core.TransactionType	Get (short transactionTypeId)
	Returns an instance of transaction type. More...

IEnumerable< MixERP.Net.Entities.Core.TransactionType >	Get ([FromUri] short[] transactionTypeIds)

IEnumerable< MixERP.Net.Entities.Core.TransactionType >	GetPagedResult ()
	Creates a paginated collection containing 25 transaction types on each page, sorted by the property TransactionTypeId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.TransactionType transactionType)
	Adds your instance of TransactionType class. More...

void	Edit (short transactionTypeId, [FromBody] MixERP.Net.Entities.Core.TransactionType transactionType)
	Edits existing record with your instance of TransactionType class. More...

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

void	Delete (short transactionTypeId)
	Deletes an existing instance of TransactionType class via TransactionTypeId. 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 Transaction Types.

Member Function Documentation

void MixERP.Net.Api.Core.TransactionTypeController.Add ( MixERP.Net.Entities.Core.TransactionType transactionType )

Adds your instance of TransactionType class.

Parameters

transactionType Your instance of transaction types class to add.

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

Adds or edits your instance of TransactionType class.

Parameters

transactionType Your instance of transaction types class to add or edit.

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

Adds or edits multiple instances of TransactionType class.

Parameters

collection Your collection of TransactionType class to bulk import.

Returns: Returns list of imported transactionTypeIds.

Exceptions

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

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

Counts the number of transaction types.

Returns: Returns the count of the transaction types.

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

Counts the number of transaction types using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered transaction types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered transaction types.

void MixERP.Net.Api.Core.TransactionTypeController.Delete ( short transactionTypeId )

Deletes an existing instance of TransactionType class via TransactionTypeId.

Parameters

transactionTypeId Enter the value for TransactionTypeId in order to find and delete the existing record.

void MixERP.Net.Api.Core.TransactionTypeController.Edit	(	short	transactionTypeId,
		[FromBody] MixERP.Net.Entities.Core.TransactionType	transactionType
	)

Edits existing record with your instance of TransactionType class.

Parameters

transactionType	Your instance of TransactionType class to edit.
transactionTypeId	Enter the value for TransactionTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.TransactionType> MixERP.Net.Api.Core.TransactionTypeController.Get ( )

Returns collection of transaction type for export.

Returns

MixERP.Net.Entities.Core.TransactionType MixERP.Net.Api.Core.TransactionTypeController.Get ( short transactionTypeId )

Returns an instance of transaction type.

Parameters

transactionTypeId Enter TransactionTypeId to search for.

Returns

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

A custom field is a user defined field for transaction types.

Returns: Returns an enumerable custom field collection of transaction types.

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

A custom field is a user defined field for transaction types.

Returns: Returns an enumerable custom field collection of transaction types.

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

Displayfield is a lightweight key/value collection of transaction types.

Returns: Returns an enumerable key/value collection of transaction types.

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

Creates meta information of "transaction type" entity.

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

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

Creates a filtered and paginated collection containing 25 transaction types on each page, sorted by the property TransactionTypeId.

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

Creates a paginated collection containing 25 transaction types on each page, sorted by the property TransactionTypeId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.TransactionType> MixERP.Net.Api.Core.TransactionTypeController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 transaction types on each page, sorted by the property TransactionTypeId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 transaction types on each page, sorted by the property TransactionTypeId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation