MixERP.Net.Api.Core.RecurringInvoiceSetupController Class Reference

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Recurring Invoice Setups. More...

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

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "recurring invoice setup" entity. More...
 
long Count ()
 Counts the number of recurring invoice setups. More...
 
IEnumerable< MixERP.Net.Entities.Core.RecurringInvoiceSetupGet ()
 Returns collection of recurring invoice setup for export. More...
 
MixERP.Net.Entities.Core.RecurringInvoiceSetup Get (int recurringInvoiceSetupId)
 Returns an instance of recurring invoice setup. More...
 
IEnumerable< MixERP.Net.Entities.Core.RecurringInvoiceSetupGet ([FromUri] int[] recurringInvoiceSetupIds)
 
IEnumerable< MixERP.Net.Entities.Core.RecurringInvoiceSetupGetPagedResult ()
 Creates a paginated collection containing 25 recurring invoice setups on each page, sorted by the property RecurringInvoiceSetupId. More...
 
IEnumerable< MixERP.Net.Entities.Core.RecurringInvoiceSetupGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 recurring invoice setups on each page, sorted by the property RecurringInvoiceSetupId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of recurring invoice setups using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Core.RecurringInvoiceSetupGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 recurring invoice setups on each page, sorted by the property RecurringInvoiceSetupId. More...
 
long CountFiltered (string filterName)
 Counts the number of recurring invoice setups using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Core.RecurringInvoiceSetupGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 recurring invoice setups on each page, sorted by the property RecurringInvoiceSetupId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of recurring invoice setups. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for recurring invoice setups. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for recurring invoice setups. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of RecurringInvoiceSetup class. More...
 
void Add (MixERP.Net.Entities.Core.RecurringInvoiceSetup recurringInvoiceSetup)
 Adds your instance of RecurringInvoiceSetup class. More...
 
void Edit (int recurringInvoiceSetupId, [FromBody] MixERP.Net.Entities.Core.RecurringInvoiceSetup recurringInvoiceSetup)
 Edits existing record with your instance of RecurringInvoiceSetup class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of RecurringInvoiceSetup class. More...
 
void Delete (int recurringInvoiceSetupId)
 Deletes an existing instance of RecurringInvoiceSetup class via RecurringInvoiceSetupId. 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 Recurring Invoice Setups.

Member Function Documentation

void MixERP.Net.Api.Core.RecurringInvoiceSetupController.Add ( MixERP.Net.Entities.Core.RecurringInvoiceSetup  recurringInvoiceSetup)

Adds your instance of RecurringInvoiceSetup class.

Parameters
recurringInvoiceSetupYour instance of recurring invoice setups class to add.
void MixERP.Net.Api.Core.RecurringInvoiceSetupController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of RecurringInvoiceSetup class.

Parameters
recurringInvoiceSetupYour instance of recurring invoice setups class to add or edit.
List<object> MixERP.Net.Api.Core.RecurringInvoiceSetupController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of RecurringInvoiceSetup class.

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

Counts the number of recurring invoice setups.

Returns
Returns the count of the recurring invoice setups.
long MixERP.Net.Api.Core.RecurringInvoiceSetupController.CountFiltered ( string  filterName)

Counts the number of recurring invoice setups using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered recurring invoice setups.
long MixERP.Net.Api.Core.RecurringInvoiceSetupController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of recurring invoice setups using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered recurring invoice setups.
void MixERP.Net.Api.Core.RecurringInvoiceSetupController.Delete ( int  recurringInvoiceSetupId)

Deletes an existing instance of RecurringInvoiceSetup class via RecurringInvoiceSetupId.

Parameters
recurringInvoiceSetupIdEnter the value for RecurringInvoiceSetupId in order to find and delete the existing record.
void MixERP.Net.Api.Core.RecurringInvoiceSetupController.Edit ( int  recurringInvoiceSetupId,
[FromBody] MixERP.Net.Entities.Core.RecurringInvoiceSetup  recurringInvoiceSetup 
)

Edits existing record with your instance of RecurringInvoiceSetup class.

Parameters
recurringInvoiceSetupYour instance of RecurringInvoiceSetup class to edit.
recurringInvoiceSetupIdEnter the value for RecurringInvoiceSetupId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Core.RecurringInvoiceSetup> MixERP.Net.Api.Core.RecurringInvoiceSetupController.Get ( )

Returns collection of recurring invoice setup for export.

Returns
MixERP.Net.Entities.Core.RecurringInvoiceSetup MixERP.Net.Api.Core.RecurringInvoiceSetupController.Get ( int  recurringInvoiceSetupId)

Returns an instance of recurring invoice setup.

Parameters
recurringInvoiceSetupIdEnter RecurringInvoiceSetupId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.RecurringInvoiceSetupController.GetCustomFields ( )

A custom field is a user defined field for recurring invoice setups.

Returns
Returns an enumerable custom field collection of recurring invoice setups.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.RecurringInvoiceSetupController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for recurring invoice setups.

Returns
Returns an enumerable custom field collection of recurring invoice setups.
IEnumerable<DisplayField> MixERP.Net.Api.Core.RecurringInvoiceSetupController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of recurring invoice setups.

Returns
Returns an enumerable key/value collection of recurring invoice setups.
EntityView MixERP.Net.Api.Core.RecurringInvoiceSetupController.GetEntityView ( )

Creates meta information of "recurring invoice setup" entity.

Returns
Returns the "recurring invoice setup" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Core.RecurringInvoiceSetup> MixERP.Net.Api.Core.RecurringInvoiceSetupController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 recurring invoice setups on each page, sorted by the property RecurringInvoiceSetupId.

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

Creates a paginated collection containing 25 recurring invoice setups on each page, sorted by the property RecurringInvoiceSetupId.

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

Creates a paginated collection containing 25 recurring invoice setups on each page, sorted by the property RecurringInvoiceSetupId.

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

Creates a filtered and paginated collection containing 25 recurring invoice setups on each page, sorted by the property RecurringInvoiceSetupId.

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: