Transactions

Create Transaction

Creates a new transaction for the authenticated user. name is required. data can include key-value pairs from the Transaction Data Keys appendix. transactionType and propertyType accept string or integer enum values.

post/transactions

Request

  • Base URL: https://ws.zipformplus.com/api
  • URL: https://ws.zipformplus.com/api/transactions
  • Auth: API key in header X-Auth-ContextId

Request body

namestring required
statusstring
transactionType'Listing' | 'Purchase' | 'Lease' | 'LeaseListing'

Integer values: Listing=0, Purchase=1, Lease=2, LeaseListing=3

propertyType'Residential' | 'Commercial' | 'Industrial' | 'VacantLand' | 'MultiUnit' | 'FarmAndRanch' | 'Condominium' | 'ManufacturedHome' | 'Coop' | 'Unlisted'

Integer values: Residential=0, Commercial=1, Industrial=2, VacantLand=3, MultiUnit=4, FarmAndRanch=5, Condominium=6, ManufacturedHome=7, Coop=8, Unlisted=9

dataobject

Key-value pairs of transaction data. See Transaction Data Keys in the introduction.

Example request

{
  "name": "123 Main Street",
  "status": "active"
}

Response

Transaction created successfully

idstring uuid

Transaction GUID

namestring
status'active' | 'pending' | 'closed' | 'inactive' | 'locked'
expirationstring date-time
transactionType'Listing' | 'Purchase' | 'Lease' | 'LeaseListing'
propertyType'Residential' | 'Commercial' | 'Industrial' | 'VacantLand' | 'MultiUnit' | 'FarmAndRanch' | 'Condominium' | 'ManufacturedHome' | 'Coop' | 'Unlisted'
hasFilesboolean
createdstring date-time
lastUpdatedstring date-time
ownerNamestring
numberinteger
sellerstring
buyerstring
propertyAddressstring

Full address in one value

addressstring
citystring
statestring
zipstring
isSignedboolean

Whether the transaction has signed documents

EncryptedOwnerIdstring uuid

GUID of the agent who owns this transaction

Example response

{
  "name": "1060 Mountain St",
  "status": "active",
  "number": 1033771
}

Changes

No recorded changes to this operation across all 1 revision of this API.