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

Inheritance diagram for MixERP.Net.Api.Transactions.TransactionDetailController:

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

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

IEnumerable< MixERP.Net.Entities.Transactions.TransactionDetail >	Get ()
	Returns collection of transaction detail for export. More...

MixERP.Net.Entities.Transactions.TransactionDetail	Get (long transactionDetailId)
	Returns an instance of transaction detail. More...

IEnumerable< MixERP.Net.Entities.Transactions.TransactionDetail >	Get ([FromUri] long[] transactionDetailIds)

IEnumerable< MixERP.Net.Entities.Transactions.TransactionDetail >	GetPagedResult ()
	Creates a paginated collection containing 25 transaction details on each page, sorted by the property TransactionDetailId. More...

IEnumerable< MixERP.Net.Entities.Transactions.TransactionDetail >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 transaction details on each page, sorted by the property TransactionDetailId. More...

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Transactions.TransactionDetail transactionDetail)
	Adds your instance of TransactionDetail class. More...

void	Edit (long transactionDetailId, [FromBody] MixERP.Net.Entities.Transactions.TransactionDetail transactionDetail)
	Edits existing record with your instance of TransactionDetail class. More...

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

void	Delete (long transactionDetailId)
	Deletes an existing instance of TransactionDetail class via TransactionDetailId. 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 Details.

Member Function Documentation

void MixERP.Net.Api.Transactions.TransactionDetailController.Add ( MixERP.Net.Entities.Transactions.TransactionDetail transactionDetail )

Adds your instance of TransactionDetail class.

Parameters

transactionDetail Your instance of transaction details class to add.

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

Adds or edits your instance of TransactionDetail class.

Parameters

transactionDetail Your instance of transaction details class to add or edit.

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

Adds or edits multiple instances of TransactionDetail class.

Parameters

collection Your collection of TransactionDetail class to bulk import.

Returns: Returns list of imported transactionDetailIds.

Exceptions

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

long MixERP.Net.Api.Transactions.TransactionDetailController.Count ( )

Counts the number of transaction details.

Returns: Returns the count of the transaction details.

long MixERP.Net.Api.Transactions.TransactionDetailController.CountFiltered ( string filterName )

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered transaction details.

long MixERP.Net.Api.Transactions.TransactionDetailController.CountWhere ( [FromBody] dynamic filters )

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered transaction details.

void MixERP.Net.Api.Transactions.TransactionDetailController.Delete ( long transactionDetailId )

Deletes an existing instance of TransactionDetail class via TransactionDetailId.

Parameters

transactionDetailId Enter the value for TransactionDetailId in order to find and delete the existing record.

void MixERP.Net.Api.Transactions.TransactionDetailController.Edit	(	long	transactionDetailId,
		[FromBody] MixERP.Net.Entities.Transactions.TransactionDetail	transactionDetail
	)

Edits existing record with your instance of TransactionDetail class.

Parameters

transactionDetail	Your instance of TransactionDetail class to edit.
transactionDetailId	Enter the value for TransactionDetailId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Transactions.TransactionDetail> MixERP.Net.Api.Transactions.TransactionDetailController.Get ( )

Returns collection of transaction detail for export.

Returns

MixERP.Net.Entities.Transactions.TransactionDetail MixERP.Net.Api.Transactions.TransactionDetailController.Get ( long transactionDetailId )

Returns an instance of transaction detail.

Parameters

transactionDetailId Enter TransactionDetailId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Transactions.TransactionDetailController.GetCustomFields ( )

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

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

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Transactions.TransactionDetailController.GetCustomFields ( string resourceId )

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

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

IEnumerable<DisplayField> MixERP.Net.Api.Transactions.TransactionDetailController.GetDisplayFields ( )

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

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

EntityView MixERP.Net.Api.Transactions.TransactionDetailController.GetEntityView ( )

Creates meta information of "transaction detail" entity.

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

IEnumerable<MixERP.Net.Entities.Transactions.TransactionDetail> MixERP.Net.Api.Transactions.TransactionDetailController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

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

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.Transactions.TransactionDetail> MixERP.Net.Api.Transactions.TransactionDetailController.GetPagedResult ( )

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Transactions.TransactionDetail> MixERP.Net.Api.Transactions.TransactionDetailController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Transactions.TransactionDetail> MixERP.Net.Api.Transactions.TransactionDetailController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

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

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/Transactions/TransactionDetailController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation