MixERP.Net.Api.Transactions.StockMasterController Class Reference

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

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

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "stock master" entity. More...
 
long Count ()
 Counts the number of stock masters. More...
 
IEnumerable< MixERP.Net.Entities.Transactions.StockMasterGet ()
 Returns collection of stock master for export. More...
 
MixERP.Net.Entities.Transactions.StockMaster Get (long stockMasterId)
 Returns an instance of stock master. More...
 
IEnumerable< MixERP.Net.Entities.Transactions.StockMasterGet ([FromUri] long[] stockMasterIds)
 
IEnumerable< MixERP.Net.Entities.Transactions.StockMasterGetPagedResult ()
 Creates a paginated collection containing 25 stock masters on each page, sorted by the property StockMasterId. More...
 
IEnumerable< MixERP.Net.Entities.Transactions.StockMasterGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 stock masters on each page, sorted by the property StockMasterId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of stock masters using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Transactions.StockMasterGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 stock masters on each page, sorted by the property StockMasterId. More...
 
long CountFiltered (string filterName)
 Counts the number of stock masters using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Transactions.StockMasterGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 stock masters on each page, sorted by the property StockMasterId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of stock masters. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for stock masters. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for stock masters. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of StockMaster class. More...
 
void Add (MixERP.Net.Entities.Transactions.StockMaster stockMaster)
 Adds your instance of StockMaster class. More...
 
void Edit (long stockMasterId, [FromBody] MixERP.Net.Entities.Transactions.StockMaster stockMaster)
 Edits existing record with your instance of StockMaster class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of StockMaster class. More...
 
void Delete (long stockMasterId)
 Deletes an existing instance of StockMaster class via StockMasterId. 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 Masters.

Member Function Documentation

void MixERP.Net.Api.Transactions.StockMasterController.Add ( MixERP.Net.Entities.Transactions.StockMaster  stockMaster)

Adds your instance of StockMaster class.

Parameters
stockMasterYour instance of stock masters class to add.
void MixERP.Net.Api.Transactions.StockMasterController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of StockMaster class.

Parameters
stockMasterYour instance of stock masters class to add or edit.
List<object> MixERP.Net.Api.Transactions.StockMasterController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of StockMaster class.

Parameters
collectionYour collection of StockMaster class to bulk import.
Returns
Returns list of imported stockMasterIds.
Exceptions
MixERPExceptionThrown when your any StockMaster class in the collection is invalid or malformed.
long MixERP.Net.Api.Transactions.StockMasterController.Count ( )

Counts the number of stock masters.

Returns
Returns the count of the stock masters.
long MixERP.Net.Api.Transactions.StockMasterController.CountFiltered ( string  filterName)

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

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered stock masters.
long MixERP.Net.Api.Transactions.StockMasterController.CountWhere ( [FromBody] dynamic  filters)

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

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered stock masters.
void MixERP.Net.Api.Transactions.StockMasterController.Delete ( long  stockMasterId)

Deletes an existing instance of StockMaster class via StockMasterId.

Parameters
stockMasterIdEnter the value for StockMasterId in order to find and delete the existing record.
void MixERP.Net.Api.Transactions.StockMasterController.Edit ( long  stockMasterId,
[FromBody] MixERP.Net.Entities.Transactions.StockMaster  stockMaster 
)

Edits existing record with your instance of StockMaster class.

Parameters
stockMasterYour instance of StockMaster class to edit.
stockMasterIdEnter the value for StockMasterId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Transactions.StockMaster> MixERP.Net.Api.Transactions.StockMasterController.Get ( )

Returns collection of stock master for export.

Returns
MixERP.Net.Entities.Transactions.StockMaster MixERP.Net.Api.Transactions.StockMasterController.Get ( long  stockMasterId)

Returns an instance of stock master.

Parameters
stockMasterIdEnter StockMasterId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Transactions.StockMasterController.GetCustomFields ( )

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

Returns
Returns an enumerable custom field collection of stock masters.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Transactions.StockMasterController.GetCustomFields ( string  resourceId)

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

Returns
Returns an enumerable custom field collection of stock masters.
IEnumerable<DisplayField> MixERP.Net.Api.Transactions.StockMasterController.GetDisplayFields ( )

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

Returns
Returns an enumerable key/value collection of stock masters.
EntityView MixERP.Net.Api.Transactions.StockMasterController.GetEntityView ( )

Creates meta information of "stock master" entity.

Returns
Returns the "stock master" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Transactions.StockMaster> MixERP.Net.Api.Transactions.StockMasterController.GetFiltered ( long  pageNumber,
string  filterName 
)

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

Parameters
pageNumberEnter the page number to produce the resultset.
filterNameThe named filter.
Returns
Returns the requested page from the collection using the supplied filters.
IEnumerable<MixERP.Net.Entities.Transactions.StockMaster> MixERP.Net.Api.Transactions.StockMasterController.GetPagedResult ( )

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

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Transactions.StockMaster> MixERP.Net.Api.Transactions.StockMasterController.GetPagedResult ( long  pageNumber)

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

Parameters
pageNumberEnter the page number to produce the resultset.
Returns
Returns the requested page from the collection.
IEnumerable<MixERP.Net.Entities.Transactions.StockMaster> MixERP.Net.Api.Transactions.StockMasterController.GetWhere ( long  pageNumber,
[FromBody] dynamic  filters 
)

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

Parameters
pageNumberEnter the page number to produce the resultset.
filtersThe 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: