PublicAPI.CRM.Inpayment

ELMA API Documentation

Inpayment

Methods

	Name	Description
	AddComment(Inpayment, String)	Add a comment to the inpayment
	AddComment(Inpayment, String, User)
	Count	Returns the total number of objects of this type
	Count(IEntityFilter)	Get Total Number of Objects by Filter
	Create	Create New Entity (without a Database entry)
	Delete	Delete Object
	Filter	Creates an assistant for working with the "Inpayment" object filter
	Find(FetchOptions)	Find objects according to fetch options
	Find(String)	Find objects according to the filter in the EQL language
	Find(IEntityFilter, FetchOptions)	Fing objects according to fetch options and filter
	FindByIdArray	Find All Objects by Array IDs
	IsDirty	Check, if there are unsaved changes in the object
	IsNew	Check, if the object is new (not saved in the database)
	Load(Guid)	Load by UID. If not found, an exception is invoked
	Load(Int64)	Load by ID. If not found, an exception is invoked
	LoadOrCreate(Guid)	Load by ID. If not found, the new object is returned
	LoadOrCreate(Int64)	Load by ID. If not found, the new object is returned
	LoadOrNull(Guid)	Load by UID. If not found, null is returned
	LoadOrNull(Int64)	Load by ID. If not found, null is returned
	Refresh	Refresh (read over) Object from Database
	Save	Save Object to Database
	SetCancelledStatus	Set the "Cancelled" status
	SetInpaymentDate(Inpayment)	Set null value to the "inpayment" field
	SetInpaymentDate(Inpayment, DateTime)	Change the impayment date
	SetInpaymentStatus	Change Inpayment Status
	SetInPlanStatus	Set the "In Plan" status
	SetReceivedStatus	Set the "Received" status

Properties

	Name	Description
	TypeUid	Returns the unique object identifier "Inpayment"

Remarks

Section containing methods for managing inpayments

Examples

Create an inpayment for the deal, created here

Copy to Clipboard Print

var myInpayment = PublicAPI.CRM.Sale.CreateInpayment(mySale);

var myInpayment = PublicAPI.CRM.Sale.CreateInpayment(mySale);

Before you start working with mySale variable, fill in its requested fields (except for "Deal", it is already filled)

Copy to Clipboard Print

//Inpayment Name
myInpayment.Name = "Payment for equipment";
//Inpayment Sum
myInpayment.Sum = new Money{Value = 1500};
//Select inpayment status "Plan"
myInpayment.Status = InpaymentStatus.InPlan;

//Inpayment Name
myInpayment.Name = "Payment for equipment";
//Inpayment Sum
myInpayment.Sum = new Money{Value = 1500};
//Select inpayment status "Plan"
myInpayment.Status = InpaymentStatus.InPlan;

Remember to save the object to the database for its correct work

Copy to Clipboard Print

myInpayment.Save();

myInpayment.Save();

Select inpayment date

Copy to Clipboard Print

PublicAPI.CRM.Inpayment.SetInpaymentDate(myInpayment, DateTime.Now);

PublicAPI.CRM.Inpayment.SetInpaymentDate(myInpayment, DateTime.Now);

Change inpayment status from "Plan" to "Received"

Copy to Clipboard Print

PublicAPI.CRM.Inpayment.SetReceivedStatus(myInpayment, "A comment, when changing inpayment status");

PublicAPI.CRM.Inpayment.SetReceivedStatus(myInpayment, "A comment, when changing inpayment status");