MixERP.Net.Api.HRM.WagesSetupController Class Reference

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

Inheritance diagram for MixERP.Net.Api.HRM.WagesSetupController:

Public Member Functions

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

Member Function Documentation

void MixERP.Net.Api.HRM.WagesSetupController.Add ( MixERP.Net.Entities.HRM.WagesSetup  wagesSetup)

Adds your instance of WagesSetup class.

Parameters
wagesSetupYour instance of wages setups class to add.
void MixERP.Net.Api.HRM.WagesSetupController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of WagesSetup class.

Parameters
wagesSetupYour instance of wages setups class to add or edit.
List<object> MixERP.Net.Api.HRM.WagesSetupController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of WagesSetup class.

Parameters
collectionYour collection of WagesSetup class to bulk import.
Returns
Returns list of imported wagesSetupIds.
Exceptions
MixERPExceptionThrown when your any WagesSetup class in the collection is invalid or malformed.
long MixERP.Net.Api.HRM.WagesSetupController.Count ( )

Counts the number of wages setups.

Returns
Returns the count of the wages setups.
long MixERP.Net.Api.HRM.WagesSetupController.CountFiltered ( string  filterName)

Counts the number of wages setups using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered wages setups.
long MixERP.Net.Api.HRM.WagesSetupController.CountWhere ( [FromBody] dynamic  filters)

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

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered wages setups.
void MixERP.Net.Api.HRM.WagesSetupController.Delete ( int  wagesSetupId)

Deletes an existing instance of WagesSetup class via WagesSetupId.

Parameters
wagesSetupIdEnter the value for WagesSetupId in order to find and delete the existing record.
void MixERP.Net.Api.HRM.WagesSetupController.Edit ( int  wagesSetupId,
[FromBody] MixERP.Net.Entities.HRM.WagesSetup  wagesSetup 
)

Edits existing record with your instance of WagesSetup class.

Parameters
wagesSetupYour instance of WagesSetup class to edit.
wagesSetupIdEnter the value for WagesSetupId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.HRM.WagesSetup> MixERP.Net.Api.HRM.WagesSetupController.Get ( )

Returns collection of wages setup for export.

Returns
MixERP.Net.Entities.HRM.WagesSetup MixERP.Net.Api.HRM.WagesSetupController.Get ( int  wagesSetupId)

Returns an instance of wages setup.

Parameters
wagesSetupIdEnter WagesSetupId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.WagesSetupController.GetCustomFields ( )

A custom field is a user defined field for wages setups.

Returns
Returns an enumerable custom field collection of wages setups.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.WagesSetupController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for wages setups.

Returns
Returns an enumerable custom field collection of wages setups.
IEnumerable<DisplayField> MixERP.Net.Api.HRM.WagesSetupController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of wages setups.

Returns
Returns an enumerable key/value collection of wages setups.
EntityView MixERP.Net.Api.HRM.WagesSetupController.GetEntityView ( )

Creates meta information of "wages setup" entity.

Returns
Returns the "wages setup" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.HRM.WagesSetup> MixERP.Net.Api.HRM.WagesSetupController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 wages setups on each page, sorted by the property WagesSetupId.

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.HRM.WagesSetup> MixERP.Net.Api.HRM.WagesSetupController.GetPagedResult ( )

Creates a paginated collection containing 25 wages setups on each page, sorted by the property WagesSetupId.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.HRM.WagesSetup> MixERP.Net.Api.HRM.WagesSetupController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 wages setups on each page, sorted by the property WagesSetupId.

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

Creates a filtered and paginated collection containing 25 wages setups on each page, sorted by the property WagesSetupId.

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: