Responses

• 200 application/json

  Request succeeded.

  Hide response attributes Show response attributes object

  • id string(uuid)

    The unique id.

  • createdTimestamp string(date-time) | null

    The date and time of creation in UTC time.

  • modifiedTimestamp string(date-time) | null

    The date and time last modification in UTC time.

  • number string | null

    The number assigned to the transaction.

  • mlsNumber string | null

    The MLS number for the listing associated with the transaction.

  • statusCode string | null

    The code for the status of the transaction.

  • addressStreetNumber string | null

    The street number.

  • addressStreetName string | null

    The street name.

  • addressStreetDirection string | null

    The street direction.

  • addressUnitNumber string | null

    The unit number.

  • addressCity string | null

    The city.

  • addressProvinceCode string | null

    The two character state or province code.

  • addressPostalCode string | null

    The postal code. This will be unformatted.

  • classificationId string(uuid) | null

    The id of the classification.

  • classificationName string | null

    The name of the classification.

  • propertyTypeId string(uuid) | null

    The id of the property type.

  • propertyTypeName string | null

    The name of the property type.

  • offerDate string(date) | null

    The date an offer was made.

  • closeDate string(date) | null

    The date the transaction closed.

  • closePrice number(double) | null

    The price.

  • finalizeDate string(date) | null

    The date the transaction was finalized and all the agents were paid.

  • firmDate string(date) | null

    The date the transaction was firmed up, meaning all conditions were met and the transaction is moving forward.

  • tiers array[object] | null

    A collection of tiers.

    Represents a summary of a tier in a transaction.

    Hide tiers attributes Show tiers attributes object

    • id string(uuid)

      The unique id.

    • createdTimestamp string(date-time) | null

      The date and time of creation in UTC time.

    • modifiedTimestamp string(date-time) | null

      The date and time last modification in UTC time.

    • name string | null

      The name of the tier.

    • commissions array[object] | null

      A collection of commissions related to the tier.

      A summary of the commission for an agent.

      Hide commissions attributes Show commissions attributes object

      • id string(uuid)

        The unique id.

      • createdTimestamp string(date-time) | null

        The date and time of creation in UTC time.

      • modifiedTimestamp string(date-time) | null

        The date and time last modification in UTC time.

      • agentId string(uuid)

        The unique id of the agent that gets the commission.

      • officeId string(uuid)

        The unique id of the office with which the agent is associated.

      • firstName string | null

        The first name of the agent.

      • middleName string | null

        The middle name of the agent.

      • lastName string | null

        The last name of the agent.

      • officeName string | null

        The name of the office.

      • amount number(currency)

        The total commission amount the agent is receiving. This includes any fees that were subtracted.

      • percentage number(double)

        The percentage of the total commission for the agent.

      • endCode string | null

        The code representing the end or side of the transaction.

        Values are B or S.

      • endCount number(double)

        The total number of ends or sides this commission represents.

• 400 application/json

  Invalid request. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 401 application/json

  Unauthorized. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 403 application/json

  Permission denied. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.