Entity representing buyer-side of transactions that agents are working on. More...

Public Member Functions
bool	Validate ()
	Validates the following: More...

Public Attributes
List< string >	Errors = new List<string>()
	List of erros found while trying to validate this object. More...

bool	HasErrors => Errors.Count > 0
	Check if we have any errors. More...

Properties
string	AgentUuid `[get, set]`
	This is the Moxi Works Platform ID of the Agent which the BuyerTransaction entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or MoxiWorksAgentId is required and must reference a valid Moxi Works Agent ID for your BuyerTransaction request to be accepted. More...

string	MoxiWorksAgentId `[get, set]`
	This is the Moxi Works Platform ID of the Agent which this BuyerTransaction object is to be associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or MoxiWorksAgentId is required and must reference a valid Moxi Works Agent ID for your BuyerTransaction request to be accepted. More...

string	MoxiWorksContactId `[get, set]`
	This is the Moxi Works Platform ID of the Contact which this BuyerTransaction object is to be associated with. This will be an RFC 4122 compliant UUID. This data is required and must reference a valid Moxi Works Contact ID for your BuyerTransaction Create request to be accepted. This is the same as the MoxiWorksContactId attribute of the Contact response. More...

string	MoxiWorksTransactionId `[get, set]`
	This is the Moxi Works Platform ID of the Contact which this BuyerTransaction object is to be associated with. This will be an RFC 4122 compliant UUID. This data is required and must reference a valid Moxi Works Contact ID for your BuyerTransaction Create request to be accepted. This is the same as the moxi_works_contact_id attribute of the Contact response. More...

string	PartnerContactId `[get, set]`
	This is the unique identifer you use in your system that has been associated with the Contact that this BuyerTransaction regards. If the referenced contact was not created by you, then this should not be used, instead use moxi_works_contact_id. More...

string	TransactionName `[get, set]`
	A brief, human readable title that will be shown to the agent as the subject of the BuyerTransaction that you are creating. More...

string	Notes `[get, set]`
	Brief, human readable content that will be shown to the agent as notes about the BuyerTransaction that you are creating. More...

string	Address `[get, set]`
	The street address of the property being purchased. This should be populated if this BuyerTransaction is_mls_transaction is false. More...

string	City `[get, set]`
	The city or township of the property being purchased. This should be populated if this BuyerTransaction is_mls_transaction is false. More...

string	State `[get, set]`
	The state or province of the property being purchased. This should be populated if this BuyerTransaction is_mls_transaction is false. More...

string	ZipCode `[get, set]`
	The postal code of the property being purchased. This should be populated if this BuyerTransaction is_mls_transaction is false. More...

int	MinSqft `[get, set]`
	The minimum desired living area for prospective properties. More...

int	MiniSqft `[get, set]`
	The maximum desired living area for prospective properties. More...

decimal	MinBeds `[get, set]`
	The minimum number of bedrooms for prospective properties. More...

decimal	MaxBeds `[get, set]`
	The maximum number of bedrooms for prospective properties. More...

decimal	MinBaths `[get, set]`
	The minimum number of bathrooms for prospective properties. More...

decimal	MaxBaths `[get, set]`
	The maximum number of bathrooms for prospective properties. More...

string	AreaOfInterest `[get, set]`
	The name of a locality representing an area of interest for prospective properties. More...

bool	IsMlsTransaction `[get, set]`
	Whether the property being purchased is being listed on an MLS. This should be false for paperwork-only, for sale by owner, off-market, or pocket listing type transactions or any transactions that will not be tracked through an MLS. More...

string	MlsNumber `[get, set]`
	The MLS number of the the property being purchased. More...

int	StartTimeStamp `[get, set]`
	This is the Unix timestamp representing the date that the agent initiated transaction discussions with the client. More...

decimal	CommissionPercentage `[get, set]`
	Commission for the transaction. If the commission for the transaction is based on a percentage of the purchase amount, use this attribute. If no commission (either commission_percentage or commission_flat_fee) is supplied during creation, commission_percentage is set to the default commission_percentage for the associated More...

decimal	CommissionFlatFee `[get, set]`
	Commission for the transaction. If the commission for the transaction is based on a flat dollar amount, use this attribute. More...

decimal	TargetPrice `[get, set]`
	The desired purchase price for a property if using target rather than range. More...

decimal	MinPrice `[get, set]`
	The minimum price range for a property if using a price range rather than target price. More...

decimal	MaxPrice `[get, set]`
	The maximum price range for a property if using a price range rather than target price. More...

Detailed Description

Entity representing buyer-side of transactions that agents are working on.

Member Function Documentation

◆ Validate()

bool MoxiWorks.Platform.BuyerTransaction.Validate ( )

Validates the following:

Either MoxiWorksContactId or partner_contact_id must be populated; however, you should only populate one of these attributes.

MlsNumber should be populated only if IsMlsTransaction is true.

A BuyerTransaction can only have either CommissionPercentage or CommissionFlatFee populated. Both can not be populated.

When setting a BuyerTransaction price, you can set either a target price or a price range, but not both. If using target_price then min_price and max_price should not be populated. If using either min_price or max_price, then target_price should not be populated.

Returns: whether BuyerTransaction is valid

Member Data Documentation

◆ Errors

List<string> MoxiWorks.Platform.BuyerTransaction.Errors = new List<string>()

List of erros found while trying to validate this object.

◆ HasErrors

bool MoxiWorks.Platform.BuyerTransaction.HasErrors => Errors.Count > 0

Check if we have any errors.

Property Documentation

◆ Address

string MoxiWorks.Platform.BuyerTransaction.Address

getset

The street address of the property being purchased. This should be populated if this BuyerTransaction is_mls_transaction is false.

◆ AgentUuid

string MoxiWorks.Platform.BuyerTransaction.AgentUuid

getset

This is the Moxi Works Platform ID of the Agent which the BuyerTransaction entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or MoxiWorksAgentId is required and must reference a valid Moxi Works Agent ID for your BuyerTransaction request to be accepted.

◆ AreaOfInterest

string MoxiWorks.Platform.BuyerTransaction.AreaOfInterest

getset

The name of a locality representing an area of interest for prospective properties.

◆ City

string MoxiWorks.Platform.BuyerTransaction.City

getset

The city or township of the property being purchased. This should be populated if this BuyerTransaction is_mls_transaction is false.

◆ CommissionFlatFee

decimal MoxiWorks.Platform.BuyerTransaction.CommissionFlatFee

getset

Commission for the transaction. If the commission for the transaction is based on a flat dollar amount, use this attribute.

◆ CommissionPercentage

decimal MoxiWorks.Platform.BuyerTransaction.CommissionPercentage

getset

Commission for the transaction. If the commission for the transaction is based on a percentage of the purchase amount, use this attribute. If no commission (either commission_percentage or commission_flat_fee) is supplied during creation, commission_percentage is set to the default commission_percentage for the associated

◆ IsMlsTransaction

bool MoxiWorks.Platform.BuyerTransaction.IsMlsTransaction

getset

Whether the property being purchased is being listed on an MLS. This should be false for paperwork-only, for sale by owner, off-market, or pocket listing type transactions or any transactions that will not be tracked through an MLS.

◆ MaxBaths

decimal MoxiWorks.Platform.BuyerTransaction.MaxBaths

getset

The maximum number of bathrooms for prospective properties.

◆ MaxBeds

decimal MoxiWorks.Platform.BuyerTransaction.MaxBeds

getset

The maximum number of bedrooms for prospective properties.

◆ MaxPrice

decimal MoxiWorks.Platform.BuyerTransaction.MaxPrice

getset

The maximum price range for a property if using a price range rather than target price.

◆ MinBaths

decimal MoxiWorks.Platform.BuyerTransaction.MinBaths

getset

The minimum number of bathrooms for prospective properties.

◆ MinBeds

decimal MoxiWorks.Platform.BuyerTransaction.MinBeds

getset

The minimum number of bedrooms for prospective properties.

◆ MiniSqft

int MoxiWorks.Platform.BuyerTransaction.MiniSqft

getset

The maximum desired living area for prospective properties.

◆ MinPrice

decimal MoxiWorks.Platform.BuyerTransaction.MinPrice

getset

The minimum price range for a property if using a price range rather than target price.

◆ MinSqft

int MoxiWorks.Platform.BuyerTransaction.MinSqft

getset

The minimum desired living area for prospective properties.

◆ MlsNumber

string MoxiWorks.Platform.BuyerTransaction.MlsNumber

getset

The MLS number of the the property being purchased.

◆ MoxiWorksAgentId

string MoxiWorks.Platform.BuyerTransaction.MoxiWorksAgentId

getset

This is the Moxi Works Platform ID of the Agent which this BuyerTransaction object is to be associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or MoxiWorksAgentId is required and must reference a valid Moxi Works Agent ID for your BuyerTransaction request to be accepted.

◆ MoxiWorksContactId

string MoxiWorks.Platform.BuyerTransaction.MoxiWorksContactId

getset

This is the Moxi Works Platform ID of the Contact which this BuyerTransaction object is to be associated with. This will be an RFC 4122 compliant UUID. This data is required and must reference a valid Moxi Works Contact ID for your BuyerTransaction Create request to be accepted. This is the same as the MoxiWorksContactId attribute of the Contact response.

◆ MoxiWorksTransactionId

string MoxiWorks.Platform.BuyerTransaction.MoxiWorksTransactionId

getset

This is the Moxi Works Platform ID of the Contact which this BuyerTransaction object is to be associated with. This will be an RFC 4122 compliant UUID. This data is required and must reference a valid Moxi Works Contact ID for your BuyerTransaction Create request to be accepted. This is the same as the moxi_works_contact_id attribute of the Contact response.

◆ Notes

string MoxiWorks.Platform.BuyerTransaction.Notes

getset

Brief, human readable content that will be shown to the agent as notes about the BuyerTransaction that you are creating.

◆ PartnerContactId

string MoxiWorks.Platform.BuyerTransaction.PartnerContactId

getset

This is the unique identifer you use in your system that has been associated with the Contact that this BuyerTransaction regards. If the referenced contact was not created by you, then this should not be used, instead use moxi_works_contact_id.

◆ StartTimeStamp

int MoxiWorks.Platform.BuyerTransaction.StartTimeStamp

getset

This is the Unix timestamp representing the date that the agent initiated transaction discussions with the client.

◆ State

string MoxiWorks.Platform.BuyerTransaction.State

getset

The state or province of the property being purchased. This should be populated if this BuyerTransaction is_mls_transaction is false.

◆ TargetPrice

decimal MoxiWorks.Platform.BuyerTransaction.TargetPrice

getset

The desired purchase price for a property if using target rather than range.

A BuyerTransaction can only have either CommissionPercentage or CommissionFlatFee populated. Both can not be populated.

◆ TransactionName

string MoxiWorks.Platform.BuyerTransaction.TransactionName

getset

A brief, human readable title that will be shown to the agent as the subject of the BuyerTransaction that you are creating.

◆ ZipCode

string MoxiWorks.Platform.BuyerTransaction.ZipCode

getset

The postal code of the property being purchased. This should be populated if this BuyerTransaction is_mls_transaction is false.

The documentation for this class was generated from the following file:

BuyerTransaction.cs

Public Member Functions

Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ Validate()

Member Data Documentation

◆ Errors

◆ HasErrors

Property Documentation

◆ Address

◆ AgentUuid

◆ AreaOfInterest

◆ City

◆ CommissionFlatFee

◆ CommissionPercentage

◆ IsMlsTransaction

◆ MaxBaths

◆ MaxBeds

◆ MaxPrice

◆ MinBaths

◆ MinBeds

◆ MiniSqft

◆ MinPrice

◆ MinSqft

◆ MlsNumber

◆ MoxiWorksAgentId

◆ MoxiWorksContactId

◆ MoxiWorksTransactionId

◆ Notes

◆ PartnerContactId

◆ StartTimeStamp

◆ State

◆ TargetPrice

◆ TransactionName

◆ ZipCode