MixERP.Net.Api.Core.TaxMasterController Class Reference

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

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

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "tax master" entity. More...
 
long Count ()
 Counts the number of tax masters. More...
 
IEnumerable< MixERP.Net.Entities.Core.TaxMasterGet ()
 Returns collection of tax master for export. More...
 
MixERP.Net.Entities.Core.TaxMaster Get (int taxMasterId)
 Returns an instance of tax master. More...
 
IEnumerable< MixERP.Net.Entities.Core.TaxMasterGet ([FromUri] int[] taxMasterIds)
 
IEnumerable< MixERP.Net.Entities.Core.TaxMasterGetPagedResult ()
 Creates a paginated collection containing 25 tax masters on each page, sorted by the property TaxMasterId. More...
 
IEnumerable< MixERP.Net.Entities.Core.TaxMasterGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 tax masters on each page, sorted by the property TaxMasterId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of tax masters using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Core.TaxMasterGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 tax masters on each page, sorted by the property TaxMasterId. More...
 
long CountFiltered (string filterName)
 Counts the number of tax masters using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Core.TaxMasterGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 tax masters on each page, sorted by the property TaxMasterId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of tax masters. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for tax masters. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for tax masters. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of TaxMaster class. More...
 
void Add (MixERP.Net.Entities.Core.TaxMaster taxMaster)
 Adds your instance of TaxMaster class. More...
 
void Edit (int taxMasterId, [FromBody] MixERP.Net.Entities.Core.TaxMaster taxMaster)
 Edits existing record with your instance of TaxMaster class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of TaxMaster class. More...
 
void Delete (int taxMasterId)
 Deletes an existing instance of TaxMaster class via TaxMasterId. 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 Tax Masters.

Member Function Documentation

void MixERP.Net.Api.Core.TaxMasterController.Add ( MixERP.Net.Entities.Core.TaxMaster  taxMaster)

Adds your instance of TaxMaster class.

Parameters
taxMasterYour instance of tax masters class to add.
void MixERP.Net.Api.Core.TaxMasterController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of TaxMaster class.

Parameters
taxMasterYour instance of tax masters class to add or edit.
List<object> MixERP.Net.Api.Core.TaxMasterController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of TaxMaster class.

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

Counts the number of tax masters.

Returns
Returns the count of the tax masters.
long MixERP.Net.Api.Core.TaxMasterController.CountFiltered ( string  filterName)

Counts the number of tax masters using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered tax masters.
long MixERP.Net.Api.Core.TaxMasterController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of tax masters using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered tax masters.
void MixERP.Net.Api.Core.TaxMasterController.Delete ( int  taxMasterId)

Deletes an existing instance of TaxMaster class via TaxMasterId.

Parameters
taxMasterIdEnter the value for TaxMasterId in order to find and delete the existing record.
void MixERP.Net.Api.Core.TaxMasterController.Edit ( int  taxMasterId,
[FromBody] MixERP.Net.Entities.Core.TaxMaster  taxMaster 
)

Edits existing record with your instance of TaxMaster class.

Parameters
taxMasterYour instance of TaxMaster class to edit.
taxMasterIdEnter the value for TaxMasterId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Core.TaxMaster> MixERP.Net.Api.Core.TaxMasterController.Get ( )

Returns collection of tax master for export.

Returns
MixERP.Net.Entities.Core.TaxMaster MixERP.Net.Api.Core.TaxMasterController.Get ( int  taxMasterId)

Returns an instance of tax master.

Parameters
taxMasterIdEnter TaxMasterId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.TaxMasterController.GetCustomFields ( )

A custom field is a user defined field for tax masters.

Returns
Returns an enumerable custom field collection of tax masters.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.TaxMasterController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for tax masters.

Returns
Returns an enumerable custom field collection of tax masters.
IEnumerable<DisplayField> MixERP.Net.Api.Core.TaxMasterController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of tax masters.

Returns
Returns an enumerable key/value collection of tax masters.
EntityView MixERP.Net.Api.Core.TaxMasterController.GetEntityView ( )

Creates meta information of "tax master" entity.

Returns
Returns the "tax master" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Core.TaxMaster> MixERP.Net.Api.Core.TaxMasterController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 tax masters on each page, sorted by the property TaxMasterId.

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

Creates a paginated collection containing 25 tax masters on each page, sorted by the property TaxMasterId.

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

Creates a paginated collection containing 25 tax masters on each page, sorted by the property TaxMasterId.

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

Creates a filtered and paginated collection containing 25 tax masters on each page, sorted by the property TaxMasterId.

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: