Sale Commission Referral

Get commission referral form

Gets the dynamic commission-referral form for the specified sale. Call this immediately before add/patch operations to get current required fields and constraints, including referral type requirements when enabled for the subscriber.

Validation & Requirements

Required Parameters

  • saleGuid (path, string, format=guid)

Required JSON Body Fields

  • None

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.
get/api/files/sales/{saleGuid}/commissionReferralForm

Request

  • Base URL
    https://api.skyslope.com
  • URL
    https://api.skyslope.com/api/files/sales/{saleGuid}/commissionReferralForm
  • Auth
    OpenID Connect (https://example.com/.well-known/openid-configuration)

Path parameters

saleGuidstring guid required

GUID of the sale whose commission referral form you want to retrieve.

Response

warningsstring[] nullable

Changes

No recorded changes to this operation across all 6 revisions of this API.