MixERP.Net.Api.Core.TaxAuthorityController Class Reference

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

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

Public Member Functions

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

Member Function Documentation

void MixERP.Net.Api.Core.TaxAuthorityController.Add ( MixERP.Net.Entities.Core.TaxAuthority  taxAuthority)

Adds your instance of TaxAuthority class.

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

Adds or edits your instance of TaxAuthority class.

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

Adds or edits multiple instances of TaxAuthority class.

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

Counts the number of tax authorities.

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

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

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

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

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered tax authorities.
void MixERP.Net.Api.Core.TaxAuthorityController.Delete ( int  taxAuthorityId)

Deletes an existing instance of TaxAuthority class via TaxAuthorityId.

Parameters
taxAuthorityIdEnter the value for TaxAuthorityId in order to find and delete the existing record.
void MixERP.Net.Api.Core.TaxAuthorityController.Edit ( int  taxAuthorityId,
[FromBody] MixERP.Net.Entities.Core.TaxAuthority  taxAuthority 
)

Edits existing record with your instance of TaxAuthority class.

Parameters
taxAuthorityYour instance of TaxAuthority class to edit.
taxAuthorityIdEnter the value for TaxAuthorityId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Core.TaxAuthority> MixERP.Net.Api.Core.TaxAuthorityController.Get ( )

Returns collection of tax authority for export.

Returns
MixERP.Net.Entities.Core.TaxAuthority MixERP.Net.Api.Core.TaxAuthorityController.Get ( int  taxAuthorityId)

Returns an instance of tax authority.

Parameters
taxAuthorityIdEnter TaxAuthorityId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.TaxAuthorityController.GetCustomFields ( )

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

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

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

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

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

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

Creates meta information of "tax authority" entity.

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

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

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

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

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

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

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

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

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: