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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "stock return" entity. More...

long	Count ()
	Counts the number of stock returns. More...

IEnumerable< MixERP.Net.Entities.Transactions.StockReturn >	Get ()
	Returns collection of stock return for export. More...

MixERP.Net.Entities.Transactions.StockReturn	Get (long salesReturnId)
	Returns an instance of stock return. More...

IEnumerable< MixERP.Net.Entities.Transactions.StockReturn >	Get ([FromUri] long[] salesReturnIds)

IEnumerable< MixERP.Net.Entities.Transactions.StockReturn >	GetPagedResult ()
	Creates a paginated collection containing 25 stock returns on each page, sorted by the property SalesReturnId. More...

IEnumerable< MixERP.Net.Entities.Transactions.StockReturn >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 stock returns on each page, sorted by the property SalesReturnId. More...

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Transactions.StockReturn stockReturn)
	Adds your instance of StockReturn class. More...

void	Edit (long salesReturnId, [FromBody] MixERP.Net.Entities.Transactions.StockReturn stockReturn)
	Edits existing record with your instance of StockReturn class. More...

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

void	Delete (long salesReturnId)
	Deletes an existing instance of StockReturn class via SalesReturnId. 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 Stock Returns.

Member Function Documentation

void MixERP.Net.Api.Transactions.StockReturnController.Add ( MixERP.Net.Entities.Transactions.StockReturn stockReturn )

Adds your instance of StockReturn class.

Parameters

stockReturn Your instance of stock returns class to add.

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

Adds or edits your instance of StockReturn class.

Parameters

stockReturn Your instance of stock returns class to add or edit.

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

Adds or edits multiple instances of StockReturn class.

Parameters

collection Your collection of StockReturn class to bulk import.

Returns: Returns list of imported salesReturnIds.

Exceptions

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

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

Counts the number of stock returns.

Returns: Returns the count of the stock returns.

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

Counts the number of stock returns using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered stock returns.

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

Counts the number of stock returns using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered stock returns.

void MixERP.Net.Api.Transactions.StockReturnController.Delete ( long salesReturnId )

Deletes an existing instance of StockReturn class via SalesReturnId.

Parameters

salesReturnId Enter the value for SalesReturnId in order to find and delete the existing record.

void MixERP.Net.Api.Transactions.StockReturnController.Edit	(	long	salesReturnId,
		[FromBody] MixERP.Net.Entities.Transactions.StockReturn	stockReturn
	)

Edits existing record with your instance of StockReturn class.

Parameters

stockReturn	Your instance of StockReturn class to edit.
salesReturnId	Enter the value for SalesReturnId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Transactions.StockReturn> MixERP.Net.Api.Transactions.StockReturnController.Get ( )

Returns collection of stock return for export.

Returns

MixERP.Net.Entities.Transactions.StockReturn MixERP.Net.Api.Transactions.StockReturnController.Get ( long salesReturnId )

Returns an instance of stock return.

Parameters

salesReturnId Enter SalesReturnId to search for.

Returns

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

A custom field is a user defined field for stock returns.

Returns: Returns an enumerable custom field collection of stock returns.

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

A custom field is a user defined field for stock returns.

Returns: Returns an enumerable custom field collection of stock returns.

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

Displayfield is a lightweight key/value collection of stock returns.

Returns: Returns an enumerable key/value collection of stock returns.

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

Creates meta information of "stock return" entity.

Returns: Returns the "stock return" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 stock returns on each page, sorted by the property SalesReturnId.

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

Creates a paginated collection containing 25 stock returns on each page, sorted by the property SalesReturnId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Transactions.StockReturn> MixERP.Net.Api.Transactions.StockReturnController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 stock returns on each page, sorted by the property SalesReturnId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 stock returns on each page, sorted by the property SalesReturnId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation