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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "payment card" entity. More...

long	Count ()
	Counts the number of payment cards. More...

IEnumerable< MixERP.Net.Entities.Core.PaymentCard >	Get ()
	Returns collection of payment card for export. More...

MixERP.Net.Entities.Core.PaymentCard	Get (int paymentCardId)
	Returns an instance of payment card. More...

IEnumerable< MixERP.Net.Entities.Core.PaymentCard >	Get ([FromUri] int[] paymentCardIds)

IEnumerable< MixERP.Net.Entities.Core.PaymentCard >	GetPagedResult ()
	Creates a paginated collection containing 25 payment cards on each page, sorted by the property PaymentCardId. More...

IEnumerable< MixERP.Net.Entities.Core.PaymentCard >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 payment cards on each page, sorted by the property PaymentCardId. More...

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.PaymentCard paymentCard)
	Adds your instance of PaymentCard class. More...

void	Edit (int paymentCardId, [FromBody] MixERP.Net.Entities.Core.PaymentCard paymentCard)
	Edits existing record with your instance of PaymentCard class. More...

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

void	Delete (int paymentCardId)
	Deletes an existing instance of PaymentCard class via PaymentCardId. 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 Payment Cards.

Member Function Documentation

void MixERP.Net.Api.Core.PaymentCardController.Add ( MixERP.Net.Entities.Core.PaymentCard paymentCard )

Adds your instance of PaymentCard class.

Parameters

paymentCard Your instance of payment cards class to add.

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

Adds or edits your instance of PaymentCard class.

Parameters

paymentCard Your instance of payment cards class to add or edit.

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

Adds or edits multiple instances of PaymentCard class.

Parameters

collection Your collection of PaymentCard class to bulk import.

Returns: Returns list of imported paymentCardIds.

Exceptions

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

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

Counts the number of payment cards.

Returns: Returns the count of the payment cards.

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

Counts the number of payment cards using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered payment cards.

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

Counts the number of payment cards using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered payment cards.

void MixERP.Net.Api.Core.PaymentCardController.Delete ( int paymentCardId )

Deletes an existing instance of PaymentCard class via PaymentCardId.

Parameters

paymentCardId Enter the value for PaymentCardId in order to find and delete the existing record.

void MixERP.Net.Api.Core.PaymentCardController.Edit	(	int	paymentCardId,
		[FromBody] MixERP.Net.Entities.Core.PaymentCard	paymentCard
	)

Edits existing record with your instance of PaymentCard class.

Parameters

paymentCard	Your instance of PaymentCard class to edit.
paymentCardId	Enter the value for PaymentCardId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.PaymentCard> MixERP.Net.Api.Core.PaymentCardController.Get ( )

Returns collection of payment card for export.

Returns

MixERP.Net.Entities.Core.PaymentCard MixERP.Net.Api.Core.PaymentCardController.Get ( int paymentCardId )

Returns an instance of payment card.

Parameters

paymentCardId Enter PaymentCardId to search for.

Returns

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

A custom field is a user defined field for payment cards.

Returns: Returns an enumerable custom field collection of payment cards.

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

A custom field is a user defined field for payment cards.

Returns: Returns an enumerable custom field collection of payment cards.

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

Displayfield is a lightweight key/value collection of payment cards.

Returns: Returns an enumerable key/value collection of payment cards.

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

Creates meta information of "payment card" entity.

Returns: Returns the "payment card" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 payment cards on each page, sorted by the property PaymentCardId.

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

Creates a paginated collection containing 25 payment cards on each page, sorted by the property PaymentCardId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.PaymentCard> MixERP.Net.Api.Core.PaymentCardController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 payment cards on each page, sorted by the property PaymentCardId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 payment cards on each page, sorted by the property PaymentCardId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation