Path parameters

• transactionId string(uuid) Required

  The id of the transaction.

• tierId string(uuid) Required

  The id of the tier.

Responses

• 200

  OK

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

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

• 409 application/json

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