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

Inheritance diagram for MixERP.Net.Api.Office.CostCenterController:

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "cost center" entity. More...

long	Count ()
	Counts the number of cost centers. More...

IEnumerable< MixERP.Net.Entities.Office.CostCenter >	Get ()
	Returns collection of cost center for export. More...

MixERP.Net.Entities.Office.CostCenter	Get (int costCenterId)
	Returns an instance of cost center. More...

IEnumerable< MixERP.Net.Entities.Office.CostCenter >	Get ([FromUri] int[] costCenterIds)

IEnumerable< MixERP.Net.Entities.Office.CostCenter >	GetPagedResult ()
	Creates a paginated collection containing 25 cost centers on each page, sorted by the property CostCenterId. More...

IEnumerable< MixERP.Net.Entities.Office.CostCenter >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 cost centers on each page, sorted by the property CostCenterId. More...

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

IEnumerable< MixERP.Net.Entities.Office.CostCenter >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 cost centers on each page, sorted by the property CostCenterId. More...

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

IEnumerable< MixERP.Net.Entities.Office.CostCenter >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 cost centers on each page, sorted by the property CostCenterId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Office.CostCenter costCenter)
	Adds your instance of CostCenter class. More...

void	Edit (int costCenterId, [FromBody] MixERP.Net.Entities.Office.CostCenter costCenter)
	Edits existing record with your instance of CostCenter class. More...

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

void	Delete (int costCenterId)
	Deletes an existing instance of CostCenter class via CostCenterId. 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 Cost Centers.

Member Function Documentation

void MixERP.Net.Api.Office.CostCenterController.Add ( MixERP.Net.Entities.Office.CostCenter costCenter )

Adds your instance of CostCenter class.

Parameters

costCenter Your instance of cost centers class to add.

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

Adds or edits your instance of CostCenter class.

Parameters

costCenter Your instance of cost centers class to add or edit.

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

Adds or edits multiple instances of CostCenter class.

Parameters

collection Your collection of CostCenter class to bulk import.

Returns: Returns list of imported costCenterIds.

Exceptions

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

long MixERP.Net.Api.Office.CostCenterController.Count ( )

Counts the number of cost centers.

Returns: Returns the count of the cost centers.

long MixERP.Net.Api.Office.CostCenterController.CountFiltered ( string filterName )

Counts the number of cost centers using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered cost centers.

long MixERP.Net.Api.Office.CostCenterController.CountWhere ( [FromBody] dynamic filters )

Counts the number of cost centers using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered cost centers.

void MixERP.Net.Api.Office.CostCenterController.Delete ( int costCenterId )

Deletes an existing instance of CostCenter class via CostCenterId.

Parameters

costCenterId Enter the value for CostCenterId in order to find and delete the existing record.

void MixERP.Net.Api.Office.CostCenterController.Edit	(	int	costCenterId,
		[FromBody] MixERP.Net.Entities.Office.CostCenter	costCenter
	)

Edits existing record with your instance of CostCenter class.

Parameters

costCenter	Your instance of CostCenter class to edit.
costCenterId	Enter the value for CostCenterId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Office.CostCenter> MixERP.Net.Api.Office.CostCenterController.Get ( )

Returns collection of cost center for export.

Returns

MixERP.Net.Entities.Office.CostCenter MixERP.Net.Api.Office.CostCenterController.Get ( int costCenterId )

Returns an instance of cost center.

Parameters

costCenterId Enter CostCenterId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Office.CostCenterController.GetCustomFields ( )

A custom field is a user defined field for cost centers.

Returns: Returns an enumerable custom field collection of cost centers.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Office.CostCenterController.GetCustomFields ( string resourceId )

A custom field is a user defined field for cost centers.

Returns: Returns an enumerable custom field collection of cost centers.

IEnumerable<DisplayField> MixERP.Net.Api.Office.CostCenterController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of cost centers.

Returns: Returns an enumerable key/value collection of cost centers.

EntityView MixERP.Net.Api.Office.CostCenterController.GetEntityView ( )

Creates meta information of "cost center" entity.

Returns: Returns the "cost center" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Office.CostCenter> MixERP.Net.Api.Office.CostCenterController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 cost centers on each page, sorted by the property CostCenterId.

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.Office.CostCenter> MixERP.Net.Api.Office.CostCenterController.GetPagedResult ( )

Creates a paginated collection containing 25 cost centers on each page, sorted by the property CostCenterId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Office.CostCenter> MixERP.Net.Api.Office.CostCenterController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 cost centers on each page, sorted by the property CostCenterId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Office.CostCenter> MixERP.Net.Api.Office.CostCenterController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 cost centers on each page, sorted by the property CostCenterId.

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/Libraries/Web API/Office/CostCenterController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation