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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "fiscal year" entity. More...

long	Count ()
	Counts the number of fiscal years. More...

IEnumerable< MixERP.Net.Entities.Core.FiscalYear >	Get ()
	Returns collection of fiscal year for export. More...

MixERP.Net.Entities.Core.FiscalYear	Get (string fiscalYearCode)
	Returns an instance of fiscal year. More...

IEnumerable< MixERP.Net.Entities.Core.FiscalYear >	Get ([FromUri] string[] fiscalYearCodes)

IEnumerable< MixERP.Net.Entities.Core.FiscalYear >	GetPagedResult ()
	Creates a paginated collection containing 25 fiscal years on each page, sorted by the property FiscalYearCode. More...

IEnumerable< MixERP.Net.Entities.Core.FiscalYear >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 fiscal years on each page, sorted by the property FiscalYearCode. More...

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

IEnumerable< MixERP.Net.Entities.Core.FiscalYear >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 fiscal years on each page, sorted by the property FiscalYearCode. More...

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

IEnumerable< MixERP.Net.Entities.Core.FiscalYear >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 fiscal years on each page, sorted by the property FiscalYearCode. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Core.FiscalYear fiscalYear)
	Adds your instance of FiscalYear class. More...

void	Edit (string fiscalYearCode, [FromBody] MixERP.Net.Entities.Core.FiscalYear fiscalYear)
	Edits existing record with your instance of FiscalYear class. More...

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

void	Delete (string fiscalYearCode)
	Deletes an existing instance of FiscalYear class via FiscalYearCode. 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 Fiscal Years.

Member Function Documentation

void MixERP.Net.Api.Core.FiscalYearController.Add ( MixERP.Net.Entities.Core.FiscalYear fiscalYear )

Adds your instance of FiscalYear class.

Parameters

fiscalYear Your instance of fiscal years class to add.

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

Adds or edits your instance of FiscalYear class.

Parameters

fiscalYear Your instance of fiscal years class to add or edit.

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

Adds or edits multiple instances of FiscalYear class.

Parameters

collection Your collection of FiscalYear class to bulk import.

Returns: Returns list of imported fiscalYearCodes.

Exceptions

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

long MixERP.Net.Api.Core.FiscalYearController.Count ( )

Counts the number of fiscal years.

Returns: Returns the count of the fiscal years.

long MixERP.Net.Api.Core.FiscalYearController.CountFiltered ( string filterName )

Counts the number of fiscal years using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered fiscal years.

long MixERP.Net.Api.Core.FiscalYearController.CountWhere ( [FromBody] dynamic filters )

Counts the number of fiscal years using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered fiscal years.

void MixERP.Net.Api.Core.FiscalYearController.Delete ( string fiscalYearCode )

Deletes an existing instance of FiscalYear class via FiscalYearCode.

Parameters

fiscalYearCode Enter the value for FiscalYearCode in order to find and delete the existing record.

void MixERP.Net.Api.Core.FiscalYearController.Edit	(	string	fiscalYearCode,
		[FromBody] MixERP.Net.Entities.Core.FiscalYear	fiscalYear
	)

Edits existing record with your instance of FiscalYear class.

Parameters

fiscalYear	Your instance of FiscalYear class to edit.
fiscalYearCode	Enter the value for FiscalYearCode in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.FiscalYear> MixERP.Net.Api.Core.FiscalYearController.Get ( )

Returns collection of fiscal year for export.

Returns

MixERP.Net.Entities.Core.FiscalYear MixERP.Net.Api.Core.FiscalYearController.Get ( string fiscalYearCode )

Returns an instance of fiscal year.

Parameters

fiscalYearCode Enter FiscalYearCode to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.FiscalYearController.GetCustomFields ( )

A custom field is a user defined field for fiscal years.

Returns: Returns an enumerable custom field collection of fiscal years.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.FiscalYearController.GetCustomFields ( string resourceId )

A custom field is a user defined field for fiscal years.

Returns: Returns an enumerable custom field collection of fiscal years.

IEnumerable<DisplayField> MixERP.Net.Api.Core.FiscalYearController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of fiscal years.

Returns: Returns an enumerable key/value collection of fiscal years.

EntityView MixERP.Net.Api.Core.FiscalYearController.GetEntityView ( )

Creates meta information of "fiscal year" entity.

Returns: Returns the "fiscal year" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Core.FiscalYear> MixERP.Net.Api.Core.FiscalYearController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 fiscal years on each page, sorted by the property FiscalYearCode.

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

Creates a paginated collection containing 25 fiscal years on each page, sorted by the property FiscalYearCode.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.FiscalYear> MixERP.Net.Api.Core.FiscalYearController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 fiscal years on each page, sorted by the property FiscalYearCode.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Core.FiscalYear> MixERP.Net.Api.Core.FiscalYearController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 fiscal years on each page, sorted by the property FiscalYearCode.

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/Core/FiscalYearController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation