MixERP.Net.Api.Transactions.StockDetailController Class Reference

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

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

Public Member Functions

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

Member Function Documentation

void MixERP.Net.Api.Transactions.StockDetailController.Add ( MixERP.Net.Entities.Transactions.StockDetail  stockDetail)

Adds your instance of StockDetail class.

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

Adds or edits your instance of StockDetail class.

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

Adds or edits multiple instances of StockDetail class.

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

Counts the number of stock details.

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

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

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

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

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered stock details.
void MixERP.Net.Api.Transactions.StockDetailController.Delete ( long  stockDetailId)

Deletes an existing instance of StockDetail class via StockDetailId.

Parameters
stockDetailIdEnter the value for StockDetailId in order to find and delete the existing record.
void MixERP.Net.Api.Transactions.StockDetailController.Edit ( long  stockDetailId,
[FromBody] MixERP.Net.Entities.Transactions.StockDetail  stockDetail 
)

Edits existing record with your instance of StockDetail class.

Parameters
stockDetailYour instance of StockDetail class to edit.
stockDetailIdEnter the value for StockDetailId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Transactions.StockDetail> MixERP.Net.Api.Transactions.StockDetailController.Get ( )

Returns collection of stock detail for export.

Returns
MixERP.Net.Entities.Transactions.StockDetail MixERP.Net.Api.Transactions.StockDetailController.Get ( long  stockDetailId)

Returns an instance of stock detail.

Parameters
stockDetailIdEnter StockDetailId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Transactions.StockDetailController.GetCustomFields ( )

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

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

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

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

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

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

Creates meta information of "stock detail" entity.

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

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

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

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

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

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

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

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

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: