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

Inheritance diagram for MixERP.Net.Api.Transactions.CustomerReceiptController:

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "customer receipt" entity. More...

long	Count ()
	Counts the number of customer receipts. More...

IEnumerable< MixERP.Net.Entities.Transactions.CustomerReceipt >	Get ()
	Returns collection of customer receipt for export. More...

MixERP.Net.Entities.Transactions.CustomerReceipt	Get (long receiptId)
	Returns an instance of customer receipt. More...

IEnumerable< MixERP.Net.Entities.Transactions.CustomerReceipt >	Get ([FromUri] long[] receiptIds)

IEnumerable< MixERP.Net.Entities.Transactions.CustomerReceipt >	GetPagedResult ()
	Creates a paginated collection containing 25 customer receipts on each page, sorted by the property ReceiptId. More...

IEnumerable< MixERP.Net.Entities.Transactions.CustomerReceipt >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 customer receipts on each page, sorted by the property ReceiptId. More...

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

IEnumerable< MixERP.Net.Entities.Transactions.CustomerReceipt >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 customer receipts on each page, sorted by the property ReceiptId. More...

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

IEnumerable< MixERP.Net.Entities.Transactions.CustomerReceipt >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 customer receipts on each page, sorted by the property ReceiptId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Transactions.CustomerReceipt customerReceipt)
	Adds your instance of CustomerReceipt class. More...

void	Edit (long receiptId, [FromBody] MixERP.Net.Entities.Transactions.CustomerReceipt customerReceipt)
	Edits existing record with your instance of CustomerReceipt class. More...

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

void	Delete (long receiptId)
	Deletes an existing instance of CustomerReceipt class via ReceiptId. 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 Customer Receipts.

Member Function Documentation

void MixERP.Net.Api.Transactions.CustomerReceiptController.Add ( MixERP.Net.Entities.Transactions.CustomerReceipt customerReceipt )

Adds your instance of CustomerReceipt class.

Parameters

customerReceipt Your instance of customer receipts class to add.

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

Adds or edits your instance of CustomerReceipt class.

Parameters

customerReceipt Your instance of customer receipts class to add or edit.

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

Adds or edits multiple instances of CustomerReceipt class.

Parameters

collection Your collection of CustomerReceipt class to bulk import.

Returns: Returns list of imported receiptIds.

Exceptions

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

long MixERP.Net.Api.Transactions.CustomerReceiptController.Count ( )

Counts the number of customer receipts.

Returns: Returns the count of the customer receipts.

long MixERP.Net.Api.Transactions.CustomerReceiptController.CountFiltered ( string filterName )

Counts the number of customer receipts using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered customer receipts.

long MixERP.Net.Api.Transactions.CustomerReceiptController.CountWhere ( [FromBody] dynamic filters )

Counts the number of customer receipts using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered customer receipts.

void MixERP.Net.Api.Transactions.CustomerReceiptController.Delete ( long receiptId )

Deletes an existing instance of CustomerReceipt class via ReceiptId.

Parameters

receiptId Enter the value for ReceiptId in order to find and delete the existing record.

void MixERP.Net.Api.Transactions.CustomerReceiptController.Edit	(	long	receiptId,
		[FromBody] MixERP.Net.Entities.Transactions.CustomerReceipt	customerReceipt
	)

Edits existing record with your instance of CustomerReceipt class.

Parameters

customerReceipt	Your instance of CustomerReceipt class to edit.
receiptId	Enter the value for ReceiptId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Transactions.CustomerReceipt> MixERP.Net.Api.Transactions.CustomerReceiptController.Get ( )

Returns collection of customer receipt for export.

Returns

MixERP.Net.Entities.Transactions.CustomerReceipt MixERP.Net.Api.Transactions.CustomerReceiptController.Get ( long receiptId )

Returns an instance of customer receipt.

Parameters

receiptId Enter ReceiptId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Transactions.CustomerReceiptController.GetCustomFields ( )

A custom field is a user defined field for customer receipts.

Returns: Returns an enumerable custom field collection of customer receipts.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Transactions.CustomerReceiptController.GetCustomFields ( string resourceId )

A custom field is a user defined field for customer receipts.

Returns: Returns an enumerable custom field collection of customer receipts.

IEnumerable<DisplayField> MixERP.Net.Api.Transactions.CustomerReceiptController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of customer receipts.

Returns: Returns an enumerable key/value collection of customer receipts.

EntityView MixERP.Net.Api.Transactions.CustomerReceiptController.GetEntityView ( )

Creates meta information of "customer receipt" entity.

Returns: Returns the "customer receipt" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Transactions.CustomerReceipt> MixERP.Net.Api.Transactions.CustomerReceiptController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 customer receipts on each page, sorted by the property ReceiptId.

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.Transactions.CustomerReceipt> MixERP.Net.Api.Transactions.CustomerReceiptController.GetPagedResult ( )

Creates a paginated collection containing 25 customer receipts on each page, sorted by the property ReceiptId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Transactions.CustomerReceipt> MixERP.Net.Api.Transactions.CustomerReceiptController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 customer receipts on each page, sorted by the property ReceiptId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Transactions.CustomerReceipt> MixERP.Net.Api.Transactions.CustomerReceiptController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 customer receipts on each page, sorted by the property ReceiptId.

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/Transactions/CustomerReceiptController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation