$moxi_works_agent_id
$moxi_works_agent_id : string
$stage : integer
$stage_name : string
$commission_percentage : float
If the agent is to receive commission based on percentage of sale price for the property associated with this BuyerTransaction, then this will represent the commission that the agent is to receive.This should be null if the BuyerTransaction uses commission_flat_fee.
-- both commission_flat_fee and commission_percentage cannot be set
$commission_flat_fee : integer
If the agent is to receive a flat-rate commission upon sale of the property associated with this BuyerTransaction, then this will represent the commission that the agent is to receive. This should be null if the BuyerTransaction uses commission_percentage.
-- both commission_flat_fee and commission_percentage cannot be set
$promote_transaction : boolean
In order to promote a BuyerTransaction to the next stage, set the promote_transaction attribute to true. For more information about BuyerTransaction stages, see The Moxi Works Platform Promoting BuyerTransaction Documentation.
promote_transaction is only available for BuyerTransaction updates. Newly created BuyerTransaction objects will automatically be created in stage 3 (active)
create(array $attributes = array()) : \MoxiworksPlatform\BuyerTransaction|null
Create a BuyerTransaction on The Moxi Works Platform <code> MoxiworksPlatform\BuyerTransaction::create([ 'moxi_works_agent_id' => '123abc', 'moxi_works_contact_id' =>'deadbeef-dead-beef-bad4-feedfacebad', 'notes' => 'foo deeaz', 'name' => 'whateverz' 'address' => '1234 there ave', 'city' => 'cityville' 'state' => 'provinceland', 'zip_code' => '12323', 'beds' => 12, 'baths' => 34.5, 'sqft' => 12345, 'is_mls_transaction' => true, 'commission_flat_fee' => nil, 'commission_percentage' => 12.34, 'target_price' => 12345, 'min_price' => nil, 'max_price' => nil, 'mls_number' => 'abc1234']); </code>
moxi_works_agent_id REQUIRED The Moxi Works Agent ID for the agent to which this transaction is to be associated
partner_transaction_id REQUIRED Your system's unique ID for this transaction.
partner_contact_id REQUIRED Your system's unique id for associated contact. should already have been created in Moxi Works Platform.
<h2>
optional BuyerTransaction parameters
</h2>
<br><b> notes</b> human readable notes associated with the transaction meaningful to the agent
<br><b> name</b> short description of the transaction meaningful to the agent
<br><b> address</b> street address of the property associated with the transaction
<br><b> city</b> city of the property associated with the transaction
<br><b> state</b> state or province of the property associated with the transaction
<br><b> zip_code</b> postal code of the property associated with the transaction
<br><b> beds</b> number of bedrooms associated with the transaction
<br><b> baths</b> number of bathrooms associated with the transaction
<br><b> sqft</b> square feet of living area associated with the transaction
<br><b> max_sqft</b> maximum square feet of living area desired for transaction
<br><b> area_of_interest</b> an area that desired for the transaction
<br><b> transaction_state</b> current state of the transaction, can be 'marketing', 'prospects' , 'actives' , 'pending' , 'completed'
<br><b> transaction_category</b> category of transaction, can be 'buyer', 'buyer'
<br><b> commission_flat_fee</b> how much the commission is if flat fee
<br><b> commission_percentage</b> what percentage the commission is if percentage based
<br><b> target_price</b> target price associated with the transaction
<br><b> price</b> price associated with the transaction
<br><b> max_price</b> maximum price associated with the transaction
<br><b> mls_number</b> mls number associated with the transaction
<br><b> closing_price</b> closing price associated with the transaction
<br><b> closing_timestamp</b> Unix timestamp representing the date the transaction closed associated with the transaction| array | $attributes |
if required parameters are not included
update(array $attributes = array()) : \MoxiworksPlatform\BuyerTransaction|null
Update a previously created BuyerTransaction on The Moxi Works Platform <code> MoxiworksPlatform\BuyerTransaction::create([ 'moxi_works_agent_id' => '123abc', 'moxi_works_transaction_id' =>'deadbeef-dead-beef-bad4-feedfacebad', 'notes' => 'foo deeaz', 'name' => 'whateverz' 'address' => '1234 there ave', 'city' => 'cityville' 'state' => 'provinceland', 'zip_code' => '12323', 'beds' => 12, 'baths' => 34.5, 'sqft' => 12345, 'is_mls_transaction' => true, 'commission_flat_fee' => nil, 'commission_percentage' => 12.34, 'target_price' => 12345, 'min_price' => nil, 'max_price' => nil, 'mls_number' => 'abc1234', 'closing_timestamp' => time(), 'closing_price' => 123456, 'promote_transaction => true ]); </code>
moxi_works_agent_id REQUIRED The Moxi Works Agent ID for the agent to which this transaction is to be associated
partner_transaction_id REQUIRED The Moxi Works Platform unique ID for the BuyerTransaction you want to update.
<h2>
optional BuyerTransaction parameters
</h2>
<br><b> notes</b> human readable notes associated with the transaction meaningful to the agent
<br><b> name</b> short description of the transaction meaningful to the agent
<br><b> address</b> street address of the property associated with the transaction
<br><b> city</b> city of the property associated with the transaction
<br><b> state</b> state or province of the property associated with the transaction
<br><b> zip_code</b> postal code of the property associated with the transaction
<br><b> beds</b> number of bedrooms associated with the transaction
<br><b> baths</b> number of bathrooms associated with the transaction
<br><b> sqft</b> square feet of living area associated with the transaction
<br><b> max_sqft</b> maximum square feet of living area desired for transaction
<br><b> area_of_interest</b> an area that desired for the transaction
<br><b> transaction_state</b> current state of the transaction, can be 'marketing', 'prospects' , 'actives' , 'pending' , 'completed'
<br><b> transaction_category</b> category of transaction, can be 'buyer', 'buyer'
<br><b> commission_flat_fee</b> how much the commission is if flat fee
<br><b> commission_percentage</b> what percentage the commission is if percentage based
<br><b> target_price</b> target price associated with the transaction
<br><b> price</b> price associated with the transaction
<br><b> max_price</b> maximum price associated with the transaction
<br><b> mls_number</b> mls number associated with the transaction
<br><b> closing_price</b> closing price associated with the transaction
<br><b> closing_timestamp</b> Unix timestamp representing the date the transaction closed associated with the transaction
<br><b> promote_transaction</b> If this is set to true then The Moxi Works Platform will promote this transaction to the next stage| array | $attributes |
if required parameters are not included
find(array $attributes = array()) : \MoxiworksPlatform\BuyerTransaction|null
Find a previously created BuyerTransaction on Moxi Works Platform.
find can be performed including the Moxi Works BuyerTransaction id and the Moxi Works Agent ID in a parameter array
\MoxiworksPlatform\BuyerTransaction::find([moxi_works_agent_id: 'abc123', moxi_works_transaction_id: 'deadbeef-feed-face-bad4-dad2feedface'])
| array | $attributes |
|
if required parameters are not included
search(array $attributes = array()) : Array
Search for BuyerTransaction objects for an Agent on Moxi Works Platform.
search can be performed by including moxi_works_agent_id in a parameter array
\MoxiworksPlatform\BuyerTransaction::search(['moxi_works_agent_id' => 'abc123', 'page_number' => 3, moxi_works_contact_id => 'deadbeef-feed-face-bad4-dad2feedface'])
| array | $attributes |
|
if required parameters are not included
if at least one search parameter is not defined
paged response array with the format: [ page_number: [Integer], total_pages: [Integer], transactions: [Array] containing MoxiworkPlatform\BuyerTransaction objects ]
save() : \MoxiworksPlatform\BuyerTransaction|null
Save BuyerTransaction to Moxi Works Platform
$transaction = MoxiworksPlatform\BuyerTransaction::find([
moxi_works_agent_id: '123abc', moxi_works_transaction_id: 'defjhi]);
$transaction->city = 'Cityville';
$transaction->save();
sendRequest( $method, array $opts = array(), null $url = null) : \MoxiworksPlatform\BuyerTransaction|null
| $method | ||
| array | $opts | |
| null | $url |
if required parameters are not included