MixERP.Net.Api.Core.MerchantFeeSetupController Class Reference

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Merchant Fee Setups. More...

Inheritance diagram for MixERP.Net.Api.Core.MerchantFeeSetupController:

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "merchant fee setup" entity. More...
 
long Count ()
 Counts the number of merchant fee setups. More...
 
IEnumerable< MixERP.Net.Entities.Core.MerchantFeeSetupGet ()
 Returns collection of merchant fee setup for export. More...
 
MixERP.Net.Entities.Core.MerchantFeeSetup Get (int merchantFeeSetupId)
 Returns an instance of merchant fee setup. More...
 
IEnumerable< MixERP.Net.Entities.Core.MerchantFeeSetupGet ([FromUri] int[] merchantFeeSetupIds)
 
IEnumerable< MixERP.Net.Entities.Core.MerchantFeeSetupGetPagedResult ()
 Creates a paginated collection containing 25 merchant fee setups on each page, sorted by the property MerchantFeeSetupId. More...
 
IEnumerable< MixERP.Net.Entities.Core.MerchantFeeSetupGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 merchant fee setups on each page, sorted by the property MerchantFeeSetupId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of merchant fee setups using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Core.MerchantFeeSetupGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 merchant fee setups on each page, sorted by the property MerchantFeeSetupId. More...
 
long CountFiltered (string filterName)
 Counts the number of merchant fee setups using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Core.MerchantFeeSetupGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 merchant fee setups on each page, sorted by the property MerchantFeeSetupId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of merchant fee setups. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for merchant fee setups. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for merchant fee setups. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of MerchantFeeSetup class. More...
 
void Add (MixERP.Net.Entities.Core.MerchantFeeSetup merchantFeeSetup)
 Adds your instance of MerchantFeeSetup class. More...
 
void Edit (int merchantFeeSetupId, [FromBody] MixERP.Net.Entities.Core.MerchantFeeSetup merchantFeeSetup)
 Edits existing record with your instance of MerchantFeeSetup class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of MerchantFeeSetup class. More...
 
void Delete (int merchantFeeSetupId)
 Deletes an existing instance of MerchantFeeSetup class via MerchantFeeSetupId. 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 Merchant Fee Setups.

Member Function Documentation

void MixERP.Net.Api.Core.MerchantFeeSetupController.Add ( MixERP.Net.Entities.Core.MerchantFeeSetup  merchantFeeSetup)

Adds your instance of MerchantFeeSetup class.

Parameters
merchantFeeSetupYour instance of merchant fee setups class to add.
void MixERP.Net.Api.Core.MerchantFeeSetupController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of MerchantFeeSetup class.

Parameters
merchantFeeSetupYour instance of merchant fee setups class to add or edit.
List<object> MixERP.Net.Api.Core.MerchantFeeSetupController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of MerchantFeeSetup class.

Parameters
collectionYour collection of MerchantFeeSetup class to bulk import.
Returns
Returns list of imported merchantFeeSetupIds.
Exceptions
MixERPExceptionThrown when your any MerchantFeeSetup class in the collection is invalid or malformed.
long MixERP.Net.Api.Core.MerchantFeeSetupController.Count ( )

Counts the number of merchant fee setups.

Returns
Returns the count of the merchant fee setups.
long MixERP.Net.Api.Core.MerchantFeeSetupController.CountFiltered ( string  filterName)

Counts the number of merchant fee setups using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered merchant fee setups.
long MixERP.Net.Api.Core.MerchantFeeSetupController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of merchant fee setups using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered merchant fee setups.
void MixERP.Net.Api.Core.MerchantFeeSetupController.Delete ( int  merchantFeeSetupId)

Deletes an existing instance of MerchantFeeSetup class via MerchantFeeSetupId.

Parameters
merchantFeeSetupIdEnter the value for MerchantFeeSetupId in order to find and delete the existing record.
void MixERP.Net.Api.Core.MerchantFeeSetupController.Edit ( int  merchantFeeSetupId,
[FromBody] MixERP.Net.Entities.Core.MerchantFeeSetup  merchantFeeSetup 
)

Edits existing record with your instance of MerchantFeeSetup class.

Parameters
merchantFeeSetupYour instance of MerchantFeeSetup class to edit.
merchantFeeSetupIdEnter the value for MerchantFeeSetupId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Core.MerchantFeeSetup> MixERP.Net.Api.Core.MerchantFeeSetupController.Get ( )

Returns collection of merchant fee setup for export.

Returns
MixERP.Net.Entities.Core.MerchantFeeSetup MixERP.Net.Api.Core.MerchantFeeSetupController.Get ( int  merchantFeeSetupId)

Returns an instance of merchant fee setup.

Parameters
merchantFeeSetupIdEnter MerchantFeeSetupId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.MerchantFeeSetupController.GetCustomFields ( )

A custom field is a user defined field for merchant fee setups.

Returns
Returns an enumerable custom field collection of merchant fee setups.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.MerchantFeeSetupController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for merchant fee setups.

Returns
Returns an enumerable custom field collection of merchant fee setups.
IEnumerable<DisplayField> MixERP.Net.Api.Core.MerchantFeeSetupController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of merchant fee setups.

Returns
Returns an enumerable key/value collection of merchant fee setups.
EntityView MixERP.Net.Api.Core.MerchantFeeSetupController.GetEntityView ( )

Creates meta information of "merchant fee setup" entity.

Returns
Returns the "merchant fee setup" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Core.MerchantFeeSetup> MixERP.Net.Api.Core.MerchantFeeSetupController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 merchant fee setups on each page, sorted by the property MerchantFeeSetupId.

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.Core.MerchantFeeSetup> MixERP.Net.Api.Core.MerchantFeeSetupController.GetPagedResult ( )

Creates a paginated collection containing 25 merchant fee setups on each page, sorted by the property MerchantFeeSetupId.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Core.MerchantFeeSetup> MixERP.Net.Api.Core.MerchantFeeSetupController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 merchant fee setups on each page, sorted by the property MerchantFeeSetupId.

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

Creates a filtered and paginated collection containing 25 merchant fee setups on each page, sorted by the property MerchantFeeSetupId.

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: