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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "recurring invoice" entity. More...

long	Count ()
	Counts the number of recurring invoices. More...

IEnumerable< MixERP.Net.Entities.Core.RecurringInvoice >	Get ()
	Returns collection of recurring invoice for export. More...

MixERP.Net.Entities.Core.RecurringInvoice	Get (int recurringInvoiceId)
	Returns an instance of recurring invoice. More...

IEnumerable< MixERP.Net.Entities.Core.RecurringInvoice >	Get ([FromUri] int[] recurringInvoiceIds)

IEnumerable< MixERP.Net.Entities.Core.RecurringInvoice >	GetPagedResult ()
	Creates a paginated collection containing 25 recurring invoices on each page, sorted by the property RecurringInvoiceId. More...

IEnumerable< MixERP.Net.Entities.Core.RecurringInvoice >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 recurring invoices on each page, sorted by the property RecurringInvoiceId. More...

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.RecurringInvoice recurringInvoice)
	Adds your instance of RecurringInvoice class. More...

void	Edit (int recurringInvoiceId, [FromBody] MixERP.Net.Entities.Core.RecurringInvoice recurringInvoice)
	Edits existing record with your instance of RecurringInvoice class. More...

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

void	Delete (int recurringInvoiceId)
	Deletes an existing instance of RecurringInvoice class via RecurringInvoiceId. 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 Recurring Invoices.

Member Function Documentation

void MixERP.Net.Api.Core.RecurringInvoiceController.Add ( MixERP.Net.Entities.Core.RecurringInvoice recurringInvoice )

Adds your instance of RecurringInvoice class.

Parameters

recurringInvoice Your instance of recurring invoices class to add.

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

Adds or edits your instance of RecurringInvoice class.

Parameters

recurringInvoice Your instance of recurring invoices class to add or edit.

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

Adds or edits multiple instances of RecurringInvoice class.

Parameters

collection Your collection of RecurringInvoice class to bulk import.

Returns: Returns list of imported recurringInvoiceIds.

Exceptions

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

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

Counts the number of recurring invoices.

Returns: Returns the count of the recurring invoices.

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

Counts the number of recurring invoices using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered recurring invoices.

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

Counts the number of recurring invoices using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered recurring invoices.

void MixERP.Net.Api.Core.RecurringInvoiceController.Delete ( int recurringInvoiceId )

Deletes an existing instance of RecurringInvoice class via RecurringInvoiceId.

Parameters

recurringInvoiceId Enter the value for RecurringInvoiceId in order to find and delete the existing record.

void MixERP.Net.Api.Core.RecurringInvoiceController.Edit	(	int	recurringInvoiceId,
		[FromBody] MixERP.Net.Entities.Core.RecurringInvoice	recurringInvoice
	)

Edits existing record with your instance of RecurringInvoice class.

Parameters

recurringInvoice	Your instance of RecurringInvoice class to edit.
recurringInvoiceId	Enter the value for RecurringInvoiceId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.RecurringInvoice> MixERP.Net.Api.Core.RecurringInvoiceController.Get ( )

Returns collection of recurring invoice for export.

Returns

MixERP.Net.Entities.Core.RecurringInvoice MixERP.Net.Api.Core.RecurringInvoiceController.Get ( int recurringInvoiceId )

Returns an instance of recurring invoice.

Parameters

recurringInvoiceId Enter RecurringInvoiceId to search for.

Returns

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

A custom field is a user defined field for recurring invoices.

Returns: Returns an enumerable custom field collection of recurring invoices.

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

A custom field is a user defined field for recurring invoices.

Returns: Returns an enumerable custom field collection of recurring invoices.

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

Displayfield is a lightweight key/value collection of recurring invoices.

Returns: Returns an enumerable key/value collection of recurring invoices.

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

Creates meta information of "recurring invoice" entity.

Returns: Returns the "recurring invoice" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 recurring invoices on each page, sorted by the property RecurringInvoiceId.

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

Creates a paginated collection containing 25 recurring invoices on each page, sorted by the property RecurringInvoiceId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.RecurringInvoice> MixERP.Net.Api.Core.RecurringInvoiceController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 recurring invoices on each page, sorted by the property RecurringInvoiceId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 recurring invoices on each page, sorted by the property RecurringInvoiceId.

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/RecurringInvoiceController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation