Path parameters

• tierId string(uuid) Required

  The id of the tier.

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.

  • name string Required

    The name of the tier.

  • closePrice number(double)

    The close price for the tier.

  • closeDate string(date) | null

    The date the tier closed.

  • statusCode string | null

    The code for the status of the tier.

    Values are C, F, O, or X.

  • classificationId string(uuid) | null

    The unique id of the classification associated with this tier.

  • sellingCommissionAmount number(currency)

    The total commission amount for the selling end or side of the tier.

  • sellingCommissionPercentage number(double)

    The commission percentage for the selling end or side of the tier. This will be specified as a decimal. For example, 5% will be specified as 0.05.

  • sellingCommissionCalculationMethodCode string | null

    The code representing the method used to calculate the selling commission.

    Values are A or P.

  • buyingCommissionAmount number(currency)

    The total commission amount for the buying end or side of the tier.

  • buyingCommissionPercentage number(double)

    The commission percentage for the buying end or side of the tier. This will be specified as a decimal. For example, 5% will be specified as 0.05.

  • buyingCommissionCalculationMethodCode string | null

    The code representing the method used to calculate the buying commission.

    Values are A or P.

  • classification object

    A read only representation of a transaction classification.

    Additional properties are NOT allowed.

    Hide classification attributes Show classification attributes object

    • name string | null

      The name of the classification.

    • code string | null

      The code for the classification.

    • endCount number(double)

      The total number of ends or sides this classification represents. This value will be either 0, 1 or 2.

      Minimum value is 0, maximum value is 2.

    • endTypeCode string | null

      The code representing the end or side for the classification.

      Values are B, D, M, S, or X.

  • commissions array[object] | null

    A collection of commissions associated with the tier.

    Hide commissions attributes Show commissions attributes object

    Represents a commission for an agent on a transaction.

    • 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) Required

      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.

    • 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. This will be specified as a decimal. For example, 5% will be specified as 0.05.

    • endCode string Required

      The code representing the end or side of the transaction.

      Values are B or S.

    • endCount number(double) Required

      The total number of ends or sides this commission represents.

      Minimum value is 0, maximum value is 2.

    • calculationMethodCode string | null

      The code representing the calculation method used for the commission. This will be "A" for amount or "P" for percentage.

      Values are A or P.

    • taxAmount number(currency)

      The total amount in tax applied to the commission.

    • totalFeeAmount number(currency)

      The total amount of fees applied to the commission.

    • totalFeeTaxAmount number(currency)

      The total amount in tax applied to just the fees for the commission.

    • fees array[object] | null

      The list of fees associated with the commission.

      Hide fees attributes Show fees attributes object

      Represents a fee that is related to a commission.

      • 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.

      • percentage number(double)

        The percentage of the commission. This will be specified as a decimal. For example, 5% will be specified as 0.05.

      • amount number(currency)

        The amount of the fee.

      • calculationMethodCode string | null

        The code for the method used to calculate the fee.

        Values are A or P.

      • taxAmount number(currency)

        The amount of tax applied to the fee.

      • taxPercentage number(double)

        The tax rate applied to the fee. This will be specified as a decimal. For example, 5% will be specified as 0.05.

      • paymentMethodCode string | null

        The code for the method used to pay the fee.

      • fee object

        A read only representation of a fee associated with a transaction.

        Additional properties are NOT allowed.

        Hide fee attributes Show fee attributes object

        • shortName string | null

          The short name of the fee.

        • name string | null

          The name of the fee.

    • agent object

      A read only representation of an agent.

      Additional properties are NOT allowed.

      Hide agent attributes Show agent attributes object

      • 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.

    • office object

      A read only representation of an office.

      Additional properties are NOT allowed.

      Hide office attributes Show office attributes object

      • name string | null

        The name of the office.

      • code string | null

        The code for the office.

  • externalCommissions array[object] | null

    A collection of external commissions associated with the tier.

    Hide externalCommissions attributes Show externalCommissions attributes object

    Represents a commission paid to an external agent involved in a transaction.

    • 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.

    • endCode string Required

      The code for the end or side of the transaction.

      Values are B or S.

    • percentage number(double)

      The percentage of the commission paid to the external agent. This will be specified as a decimal. For example, 5% will be specified as 0.05.

    • amount number(currency)

      The amount of the commission paid to the external agent.

    • calculationMethodCode string | null

      The code for the method used to calculate the commission.

      Values are A or P.

    • paymentMethodCode string | null

      The code for the method of payment for the commission.

      Values are B, N, or E.

    • externalAgentId string(uuid) Required

      The unique id of the external agent associated with this commission.

    • externalAgent object

      Represents an agent involved in the transaction that does not work for the brokerage.

      Additional properties are NOT allowed.

      Hide externalAgent attributes Show externalAgent 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.

      • endCode string Required

        The code end or side of the transaction.

        Values are B or S.

      • typeCode string Required

        The code for the type of external agent this is. This will be either "B" for outside broker or "R" for referral.

        Values are B or R.

      • paymentMethodCode string | null

        The code for the method use to pay the external agent.

        Values are B, N, or E.

      • firstName string Required

        The first name of the external agent.

      • lastName string Required

        The last name of the external agent.

      • companyName string | null

        The name of the company for which the external agent works.

      • addressLine1 string | null

        The street address.

      • addressLine2 string | null

        The address unit number.

      • addressCity string | null

        The city of the address.

      • addressPostalCode string | null

        The postal code of the address. This will be unformatted.

      • addressProvinceCode string | null

        The two character state or province code.

      • addressCountryCode string | null

        The two character country code.

      • phoneNumberMain string | null

        The external agent's main phone number.

      • phoneNumberBusiness string | null

        The external agent's business phone number.

      • faxNumberMain string | null

        The external agent's main fax number.

      • emailAddressMain string | null

        The external agent's main email address.

      • emailAddressBusiness string | null

        The external agent's business email address.

• 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.

• 404 application/json

  Not found. 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.

• 422 application/json

  Validation failed. 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.