Sign in
latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Sales

Create sale

Creates a sale record for the current subscriber.

Validation & Requirements

Required Parameters

  • saleForm (body, object)

Required JSON Body Fields

  • officeGuid (format=guid, minLength=1)
  • agentGuid (format=guid, minLength=1)
  • checklistTypeId (format=int32)

Validations

  • Invalid GUID values in *Guid/*Guids fields return 422 Unprocessable Entity.
  • Invalid date values in *date* fields return 422 Unprocessable Entity.
  • Missing required request body returns 422 Unprocessable Entity with Missing request body..
  • Additional business-rule validation may return 422 with details in the errors array.

Integration Requirement

  • Retrieve the corresponding ...Form endpoint immediately before write operations to get current dynamic required fields and allowed values.
post/api/files/sales

Request body

mlsNumberstring nullable
statusIdinteger

Optional initial status. Allowed values: 59 (Pending/Firm — the default) and 800 (Conditional — requires the terminology=en-CA query parameter and a Canadian subscriber). Omit for the default. Allowed values are listed in the saleForm AllowableSelections.

officeGuidstring guid required

Office guid that the sale will be created in.

agentGuidstring guid required

The agent that this sale is created for.

checklistTypeIdinteger required
contractAcceptanceDatestring date-time nullable
escrowNumberstring nullable
escrowClosingDatestring date-time nullable
sourceIdinteger nullable

SourceId can be retrieved from the AllowableSelections list.

otherSourcestring nullable

Required only for certain SourceId fields

salePricenumber nullable
isOfficeLeadboolean nullable
fileIdstring nullable
apnstring nullable

Response

warningsstring[] nullable