Get Transaction
Fetches a single transaction that belongs to the given lead.
Prerequisites:
- leadId must be manageable by the caller; otherwise 404 LEAD_NOT_EXIST.
- transactionId must exist, not be deleted, AND belong to leadId; otherwise 404 TRANSACTION_NOT_EXIST. For security, cross-lead transactionIds are treated as ‘not exist’ rather than ‘forbidden’.
Headers
Bearer [access_token]
Path Parameters
Lead ID. Must be manageable by the caller.
Transaction ID. Must exist and be bound to leadId.
Response
The requested transaction.
Property address or deal name. Required on create. Must not be blank and must not contain '<' or '>' characters.
"123 Main St"
Transaction creation timestamp, in milliseconds since Unix epoch (UTC). Do not supply on create.
1518078026000
Transaction last-modified timestamp, in milliseconds since Unix epoch (UTC). Do not supply on create or update.
1518078026000
Transaction ID. Do not supply on create.
10001
Name of the lead this transaction belongs to. Ignored if supplied in a request body.
"Bob"
User ID of the agent this transaction is assigned to. Ignored if supplied in a request body.
100001
Transaction type. Case-sensitive; must be one of the supported values. Values not matching the team's configured pipeline types fall back silently to the first pipeline (typically 'Purchase / Pre-contract'); always pass a valid type to avoid this silent behavior.
Purchase, Listing, Lease, Other "Purchase"
Home price of the transaction.
1000000
Transaction status name. Must match one of the statuses configured in the team's pipeline for the given transactionType; unmatched values silently fall back to the first status of that type.
"Pre-contract"
Expected close date, in milliseconds since Unix epoch (UTC).
1508580010000
Actual close date, in milliseconds since Unix epoch (UTC).
1508580010000
Commission rate, expressed as a percentage (e.g. 3 for 3%).
3
Gross Commission Income (GCI) of the transaction.
5000
Portion of the GCI attributed to the team.
1000
Portion of the GCI attributed to the agent.
4000
Appointment date, in milliseconds since Unix epoch (UTC).
1508580010000
Agreement-signed date, in milliseconds since Unix epoch (UTC).
1508580010000
Offer date, in milliseconds since Unix epoch (UTC).
1508580010000
Contract date, in milliseconds since Unix epoch (UTC).
1508580010000
Appraisal date, in milliseconds since Unix epoch (UTC).
1508580010000
Home-inspection date, in milliseconds since Unix epoch (UTC).
1508580010000
Escrow date, in milliseconds since Unix epoch (UTC).
1508580010000
Expiration date (listing / contract), in milliseconds since Unix epoch (UTC).
1508580010000
Custom field values; full-coverage update or insertion. See GET /v1.0/transaction/customfields for the team's custom field definitions.
Commission structure (preSplit / split / postSplit). See POST /v1.0/leads/{leadId}/transaction description for validation rules.