MixERP.Net.Api.Core.SalespersonBonusSetupController Class Reference

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

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

Public Member Functions

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

Member Function Documentation

void MixERP.Net.Api.Core.SalespersonBonusSetupController.Add ( MixERP.Net.Entities.Core.SalespersonBonusSetup  salespersonBonusSetup)

Adds your instance of SalespersonBonusSetup class.

Parameters
salespersonBonusSetupYour instance of salesperson bonus setups class to add.
void MixERP.Net.Api.Core.SalespersonBonusSetupController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of SalespersonBonusSetup class.

Parameters
salespersonBonusSetupYour instance of salesperson bonus setups class to add or edit.
List<object> MixERP.Net.Api.Core.SalespersonBonusSetupController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of SalespersonBonusSetup class.

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

Counts the number of salesperson bonus setups.

Returns
Returns the count of the salesperson bonus setups.
long MixERP.Net.Api.Core.SalespersonBonusSetupController.CountFiltered ( string  filterName)

Counts the number of salesperson bonus setups using the supplied filter name.

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

Counts the number of salesperson bonus setups using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered salesperson bonus setups.
void MixERP.Net.Api.Core.SalespersonBonusSetupController.Delete ( int  salespersonBonusSetupId)

Deletes an existing instance of SalespersonBonusSetup class via SalespersonBonusSetupId.

Parameters
salespersonBonusSetupIdEnter the value for SalespersonBonusSetupId in order to find and delete the existing record.
void MixERP.Net.Api.Core.SalespersonBonusSetupController.Edit ( int  salespersonBonusSetupId,
[FromBody] MixERP.Net.Entities.Core.SalespersonBonusSetup  salespersonBonusSetup 
)

Edits existing record with your instance of SalespersonBonusSetup class.

Parameters
salespersonBonusSetupYour instance of SalespersonBonusSetup class to edit.
salespersonBonusSetupIdEnter the value for SalespersonBonusSetupId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Core.SalespersonBonusSetup> MixERP.Net.Api.Core.SalespersonBonusSetupController.Get ( )

Returns collection of salesperson bonus setup for export.

Returns
MixERP.Net.Entities.Core.SalespersonBonusSetup MixERP.Net.Api.Core.SalespersonBonusSetupController.Get ( int  salespersonBonusSetupId)

Returns an instance of salesperson bonus setup.

Parameters
salespersonBonusSetupIdEnter SalespersonBonusSetupId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.SalespersonBonusSetupController.GetCustomFields ( )

A custom field is a user defined field for salesperson bonus setups.

Returns
Returns an enumerable custom field collection of salesperson bonus setups.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.SalespersonBonusSetupController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for salesperson bonus setups.

Returns
Returns an enumerable custom field collection of salesperson bonus setups.
IEnumerable<DisplayField> MixERP.Net.Api.Core.SalespersonBonusSetupController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of salesperson bonus setups.

Returns
Returns an enumerable key/value collection of salesperson bonus setups.
EntityView MixERP.Net.Api.Core.SalespersonBonusSetupController.GetEntityView ( )

Creates meta information of "salesperson bonus setup" entity.

Returns
Returns the "salesperson bonus setup" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Core.SalespersonBonusSetup> MixERP.Net.Api.Core.SalespersonBonusSetupController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 salesperson bonus setups on each page, sorted by the property SalespersonBonusSetupId.

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

Creates a paginated collection containing 25 salesperson bonus setups on each page, sorted by the property SalespersonBonusSetupId.

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

Creates a paginated collection containing 25 salesperson bonus setups on each page, sorted by the property SalespersonBonusSetupId.

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

Creates a filtered and paginated collection containing 25 salesperson bonus setups on each page, sorted by the property SalespersonBonusSetupId.

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: