MixERP.Net.Api.HRM.EmployeeWageController Class Reference

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

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

Public Member Functions

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

Member Function Documentation

void MixERP.Net.Api.HRM.EmployeeWageController.Add ( MixERP.Net.Entities.HRM.EmployeeWage  employeeWage)

Adds your instance of EmployeeWage class.

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

Adds or edits your instance of EmployeeWage class.

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

Adds or edits multiple instances of EmployeeWage class.

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

Counts the number of employee wages.

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

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

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

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

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered employee wages.
void MixERP.Net.Api.HRM.EmployeeWageController.Delete ( long  employeeWageId)

Deletes an existing instance of EmployeeWage class via EmployeeWageId.

Parameters
employeeWageIdEnter the value for EmployeeWageId in order to find and delete the existing record.
void MixERP.Net.Api.HRM.EmployeeWageController.Edit ( long  employeeWageId,
[FromBody] MixERP.Net.Entities.HRM.EmployeeWage  employeeWage 
)

Edits existing record with your instance of EmployeeWage class.

Parameters
employeeWageYour instance of EmployeeWage class to edit.
employeeWageIdEnter the value for EmployeeWageId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.HRM.EmployeeWage> MixERP.Net.Api.HRM.EmployeeWageController.Get ( )

Returns collection of employee wage for export.

Returns
MixERP.Net.Entities.HRM.EmployeeWage MixERP.Net.Api.HRM.EmployeeWageController.Get ( long  employeeWageId)

Returns an instance of employee wage.

Parameters
employeeWageIdEnter EmployeeWageId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.EmployeeWageController.GetCustomFields ( )

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

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

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

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

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

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

Creates meta information of "employee wage" entity.

Returns
Returns the "employee wage" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.HRM.EmployeeWage> MixERP.Net.Api.HRM.EmployeeWageController.GetFiltered ( long  pageNumber,
string  filterName 
)

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

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

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

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

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

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

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

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: