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

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

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

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

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

MixERP.Net.Entities.Core.PaymentTerm	Get (int paymentTermId)
	Returns an instance of payment term. More...

IEnumerable< MixERP.Net.Entities.Core.PaymentTerm >	Get ([FromUri] int[] paymentTermIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.PaymentTerm paymentTerm)
	Adds your instance of PaymentTerm class. More...

void	Edit (int paymentTermId, [FromBody] MixERP.Net.Entities.Core.PaymentTerm paymentTerm)
	Edits existing record with your instance of PaymentTerm class. More...

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

void	Delete (int paymentTermId)
	Deletes an existing instance of PaymentTerm class via PaymentTermId. 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 Terms.

Member Function Documentation

void MixERP.Net.Api.Core.PaymentTermController.Add ( MixERP.Net.Entities.Core.PaymentTerm paymentTerm )

Adds your instance of PaymentTerm class.

Parameters

paymentTerm Your instance of payment terms class to add.

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

Adds or edits your instance of PaymentTerm class.

Parameters

paymentTerm Your instance of payment terms class to add or edit.

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

Adds or edits multiple instances of PaymentTerm class.

Parameters

collection Your collection of PaymentTerm class to bulk import.

Returns: Returns list of imported paymentTermIds.

Exceptions

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

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

Counts the number of payment terms.

Returns: Returns the count of the payment terms.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered payment terms.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered payment terms.

void MixERP.Net.Api.Core.PaymentTermController.Delete ( int paymentTermId )

Deletes an existing instance of PaymentTerm class via PaymentTermId.

Parameters

paymentTermId Enter the value for PaymentTermId in order to find and delete the existing record.

void MixERP.Net.Api.Core.PaymentTermController.Edit	(	int	paymentTermId,
		[FromBody] MixERP.Net.Entities.Core.PaymentTerm	paymentTerm
	)

Edits existing record with your instance of PaymentTerm class.

Parameters

paymentTerm	Your instance of PaymentTerm class to edit.
paymentTermId	Enter the value for PaymentTermId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.PaymentTerm> MixERP.Net.Api.Core.PaymentTermController.Get ( )

Returns collection of payment term for export.

Returns

MixERP.Net.Entities.Core.PaymentTerm MixERP.Net.Api.Core.PaymentTermController.Get ( int paymentTermId )

Returns an instance of payment term.

Parameters

paymentTermId Enter PaymentTermId to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "payment term" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.PaymentTerm> MixERP.Net.Api.Core.PaymentTermController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation