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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "salary type" entity. More...

long	Count ()
	Counts the number of salary types. More...

IEnumerable< MixERP.Net.Entities.HRM.SalaryType >	Get ()
	Returns collection of salary type for export. More...

MixERP.Net.Entities.HRM.SalaryType	Get (int salaryTypeId)
	Returns an instance of salary type. More...

IEnumerable< MixERP.Net.Entities.HRM.SalaryType >	Get ([FromUri] int[] salaryTypeIds)

IEnumerable< MixERP.Net.Entities.HRM.SalaryType >	GetPagedResult ()
	Creates a paginated collection containing 25 salary types on each page, sorted by the property SalaryTypeId. More...

IEnumerable< MixERP.Net.Entities.HRM.SalaryType >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 salary types on each page, sorted by the property SalaryTypeId. More...

long	CountWhere ([FromBody]dynamic filters)
	Counts the number of salary types using the supplied filter(s). More...

IEnumerable< MixERP.Net.Entities.HRM.SalaryType >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 salary types on each page, sorted by the property SalaryTypeId. More...

long	CountFiltered (string filterName)
	Counts the number of salary types using the supplied filter name. More...

IEnumerable< MixERP.Net.Entities.HRM.SalaryType >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 salary types on each page, sorted by the property SalaryTypeId. More...

IEnumerable< DisplayField >	GetDisplayFields ()
	Displayfield is a lightweight key/value collection of salary types. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields ()
	A custom field is a user defined field for salary types. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields (string resourceId)
	A custom field is a user defined field for salary types. More...

void	AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
	Adds or edits your instance of SalaryType class. More...

void	Add (MixERP.Net.Entities.HRM.SalaryType salaryType)
	Adds your instance of SalaryType class. More...

void	Edit (int salaryTypeId, [FromBody] MixERP.Net.Entities.HRM.SalaryType salaryType)
	Edits existing record with your instance of SalaryType class. More...

List< object >	BulkImport ([FromBody]dynamic collection)
	Adds or edits multiple instances of SalaryType class. More...

void	Delete (int salaryTypeId)
	Deletes an existing instance of SalaryType class via SalaryTypeId. 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 Salary Types.

Member Function Documentation

void MixERP.Net.Api.HRM.SalaryTypeController.Add ( MixERP.Net.Entities.HRM.SalaryType salaryType )

Adds your instance of SalaryType class.

Parameters

salaryType Your instance of salary types class to add.

void MixERP.Net.Api.HRM.SalaryTypeController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray form )

Adds or edits your instance of SalaryType class.

Parameters

salaryType Your instance of salary types class to add or edit.

List<object> MixERP.Net.Api.HRM.SalaryTypeController.BulkImport ( [FromBody] dynamic collection )

Adds or edits multiple instances of SalaryType class.

Parameters

collection Your collection of SalaryType class to bulk import.

Returns: Returns list of imported salaryTypeIds.

Exceptions

MixERPException Thrown when your any SalaryType class in the collection is invalid or malformed.

long MixERP.Net.Api.HRM.SalaryTypeController.Count ( )

Counts the number of salary types.

Returns: Returns the count of the salary types.

long MixERP.Net.Api.HRM.SalaryTypeController.CountFiltered ( string filterName )

Counts the number of salary types using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered salary types.

long MixERP.Net.Api.HRM.SalaryTypeController.CountWhere ( [FromBody] dynamic filters )

Counts the number of salary types using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered salary types.

void MixERP.Net.Api.HRM.SalaryTypeController.Delete ( int salaryTypeId )

Deletes an existing instance of SalaryType class via SalaryTypeId.

Parameters

salaryTypeId Enter the value for SalaryTypeId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.SalaryTypeController.Edit	(	int	salaryTypeId,
		[FromBody] MixERP.Net.Entities.HRM.SalaryType	salaryType
	)

Edits existing record with your instance of SalaryType class.

Parameters

salaryType	Your instance of SalaryType class to edit.
salaryTypeId	Enter the value for SalaryTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.SalaryType> MixERP.Net.Api.HRM.SalaryTypeController.Get ( )

Returns collection of salary type for export.

Returns

MixERP.Net.Entities.HRM.SalaryType MixERP.Net.Api.HRM.SalaryTypeController.Get ( int salaryTypeId )

Returns an instance of salary type.

Parameters

salaryTypeId Enter SalaryTypeId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.SalaryTypeController.GetCustomFields ( )

A custom field is a user defined field for salary types.

Returns: Returns an enumerable custom field collection of salary types.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.SalaryTypeController.GetCustomFields ( string resourceId )

A custom field is a user defined field for salary types.

Returns: Returns an enumerable custom field collection of salary types.

IEnumerable<DisplayField> MixERP.Net.Api.HRM.SalaryTypeController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of salary types.

Returns: Returns an enumerable key/value collection of salary types.

EntityView MixERP.Net.Api.HRM.SalaryTypeController.GetEntityView ( )

Creates meta information of "salary type" entity.

Returns: Returns the "salary type" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.HRM.SalaryType> MixERP.Net.Api.HRM.SalaryTypeController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 salary types on each page, sorted by the property SalaryTypeId.

Parameters

pageNumber	Enter the page number to produce the resultset.
filterName	The named filter.

Returns: Returns the requested page from the collection using the supplied filters.

IEnumerable<MixERP.Net.Entities.HRM.SalaryType> MixERP.Net.Api.HRM.SalaryTypeController.GetPagedResult ( )

Creates a paginated collection containing 25 salary types on each page, sorted by the property SalaryTypeId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.SalaryType> MixERP.Net.Api.HRM.SalaryTypeController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 salary types on each page, sorted by the property SalaryTypeId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.SalaryType> MixERP.Net.Api.HRM.SalaryTypeController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 salary types on each page, sorted by the property SalaryTypeId.

Parameters

pageNumber	Enter the page number to produce the resultset.
filters	The 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:

C:/Users/nirvan/Desktop/mixerp/0. GitHub/src/FrontEnd/MixERP.Net.FrontEnd/Modules/HRM.API/SalaryTypeController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation