MixERP.Net.Api.Core.CashFlowHeadingController Class Reference

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Cash Flow Headings. More...

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

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "cash flow heading" entity. More...
 
long Count ()
 Counts the number of cash flow headings. More...
 
IEnumerable< MixERP.Net.Entities.Core.CashFlowHeadingGet ()
 Returns collection of cash flow heading for export. More...
 
MixERP.Net.Entities.Core.CashFlowHeading Get (int cashFlowHeadingId)
 Returns an instance of cash flow heading. More...
 
IEnumerable< MixERP.Net.Entities.Core.CashFlowHeadingGet ([FromUri] int[] cashFlowHeadingIds)
 
IEnumerable< MixERP.Net.Entities.Core.CashFlowHeadingGetPagedResult ()
 Creates a paginated collection containing 25 cash flow headings on each page, sorted by the property CashFlowHeadingId. More...
 
IEnumerable< MixERP.Net.Entities.Core.CashFlowHeadingGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 cash flow headings on each page, sorted by the property CashFlowHeadingId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of cash flow headings using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Core.CashFlowHeadingGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 cash flow headings on each page, sorted by the property CashFlowHeadingId. More...
 
long CountFiltered (string filterName)
 Counts the number of cash flow headings using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Core.CashFlowHeadingGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 cash flow headings on each page, sorted by the property CashFlowHeadingId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of cash flow headings. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for cash flow headings. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for cash flow headings. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of CashFlowHeading class. More...
 
void Add (MixERP.Net.Entities.Core.CashFlowHeading cashFlowHeading)
 Adds your instance of CashFlowHeading class. More...
 
void Edit (int cashFlowHeadingId, [FromBody] MixERP.Net.Entities.Core.CashFlowHeading cashFlowHeading)
 Edits existing record with your instance of CashFlowHeading class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of CashFlowHeading class. More...
 
void Delete (int cashFlowHeadingId)
 Deletes an existing instance of CashFlowHeading class via CashFlowHeadingId. 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 Cash Flow Headings.

Member Function Documentation

void MixERP.Net.Api.Core.CashFlowHeadingController.Add ( MixERP.Net.Entities.Core.CashFlowHeading  cashFlowHeading)

Adds your instance of CashFlowHeading class.

Parameters
cashFlowHeadingYour instance of cash flow headings class to add.
void MixERP.Net.Api.Core.CashFlowHeadingController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of CashFlowHeading class.

Parameters
cashFlowHeadingYour instance of cash flow headings class to add or edit.
List<object> MixERP.Net.Api.Core.CashFlowHeadingController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of CashFlowHeading class.

Parameters
collectionYour collection of CashFlowHeading class to bulk import.
Returns
Returns list of imported cashFlowHeadingIds.
Exceptions
MixERPExceptionThrown when your any CashFlowHeading class in the collection is invalid or malformed.
long MixERP.Net.Api.Core.CashFlowHeadingController.Count ( )

Counts the number of cash flow headings.

Returns
Returns the count of the cash flow headings.
long MixERP.Net.Api.Core.CashFlowHeadingController.CountFiltered ( string  filterName)

Counts the number of cash flow headings using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered cash flow headings.
long MixERP.Net.Api.Core.CashFlowHeadingController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of cash flow headings using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered cash flow headings.
void MixERP.Net.Api.Core.CashFlowHeadingController.Delete ( int  cashFlowHeadingId)

Deletes an existing instance of CashFlowHeading class via CashFlowHeadingId.

Parameters
cashFlowHeadingIdEnter the value for CashFlowHeadingId in order to find and delete the existing record.
void MixERP.Net.Api.Core.CashFlowHeadingController.Edit ( int  cashFlowHeadingId,
[FromBody] MixERP.Net.Entities.Core.CashFlowHeading  cashFlowHeading 
)

Edits existing record with your instance of CashFlowHeading class.

Parameters
cashFlowHeadingYour instance of CashFlowHeading class to edit.
cashFlowHeadingIdEnter the value for CashFlowHeadingId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Core.CashFlowHeading> MixERP.Net.Api.Core.CashFlowHeadingController.Get ( )

Returns collection of cash flow heading for export.

Returns
MixERP.Net.Entities.Core.CashFlowHeading MixERP.Net.Api.Core.CashFlowHeadingController.Get ( int  cashFlowHeadingId)

Returns an instance of cash flow heading.

Parameters
cashFlowHeadingIdEnter CashFlowHeadingId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.CashFlowHeadingController.GetCustomFields ( )

A custom field is a user defined field for cash flow headings.

Returns
Returns an enumerable custom field collection of cash flow headings.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.CashFlowHeadingController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for cash flow headings.

Returns
Returns an enumerable custom field collection of cash flow headings.
IEnumerable<DisplayField> MixERP.Net.Api.Core.CashFlowHeadingController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of cash flow headings.

Returns
Returns an enumerable key/value collection of cash flow headings.
EntityView MixERP.Net.Api.Core.CashFlowHeadingController.GetEntityView ( )

Creates meta information of "cash flow heading" entity.

Returns
Returns the "cash flow heading" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Core.CashFlowHeading> MixERP.Net.Api.Core.CashFlowHeadingController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 cash flow headings on each page, sorted by the property CashFlowHeadingId.

Parameters
pageNumberEnter the page number to produce the resultset.
filterNameThe named filter.
Returns
Returns the requested page from the collection using the supplied filters.
IEnumerable<MixERP.Net.Entities.Core.CashFlowHeading> MixERP.Net.Api.Core.CashFlowHeadingController.GetPagedResult ( )

Creates a paginated collection containing 25 cash flow headings on each page, sorted by the property CashFlowHeadingId.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Core.CashFlowHeading> MixERP.Net.Api.Core.CashFlowHeadingController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 cash flow headings on each page, sorted by the property CashFlowHeadingId.

Parameters
pageNumberEnter the page number to produce the resultset.
Returns
Returns the requested page from the collection.
IEnumerable<MixERP.Net.Entities.Core.CashFlowHeading> MixERP.Net.Api.Core.CashFlowHeadingController.GetWhere ( long  pageNumber,
[FromBody] dynamic  filters 
)

Creates a filtered and paginated collection containing 25 cash flow headings on each page, sorted by the property CashFlowHeadingId.

Parameters
pageNumberEnter the page number to produce the resultset.
filtersThe 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: