MixERP.Net.Api.Transactions.TransactionMasterController Class Reference

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

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

Public Member Functions

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

Member Function Documentation

void MixERP.Net.Api.Transactions.TransactionMasterController.Add ( MixERP.Net.Entities.Transactions.TransactionMaster  transactionMaster)

Adds your instance of TransactionMaster class.

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

Adds or edits your instance of TransactionMaster class.

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

Adds or edits multiple instances of TransactionMaster class.

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

Counts the number of transaction masters.

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

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

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

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

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered transaction masters.
void MixERP.Net.Api.Transactions.TransactionMasterController.Delete ( long  transactionMasterId)

Deletes an existing instance of TransactionMaster class via TransactionMasterId.

Parameters
transactionMasterIdEnter the value for TransactionMasterId in order to find and delete the existing record.
void MixERP.Net.Api.Transactions.TransactionMasterController.Edit ( long  transactionMasterId,
[FromBody] MixERP.Net.Entities.Transactions.TransactionMaster  transactionMaster 
)

Edits existing record with your instance of TransactionMaster class.

Parameters
transactionMasterYour instance of TransactionMaster class to edit.
transactionMasterIdEnter the value for TransactionMasterId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Transactions.TransactionMaster> MixERP.Net.Api.Transactions.TransactionMasterController.Get ( )

Returns collection of transaction master for export.

Returns
MixERP.Net.Entities.Transactions.TransactionMaster MixERP.Net.Api.Transactions.TransactionMasterController.Get ( long  transactionMasterId)

Returns an instance of transaction master.

Parameters
transactionMasterIdEnter TransactionMasterId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Transactions.TransactionMasterController.GetCustomFields ( )

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

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

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

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

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

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

Creates meta information of "transaction master" entity.

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

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

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

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

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

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

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

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

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: