Skip to main content

Fields

basis : PartnerCommissionBasis! required

Whether the commission is paid once or on a trailing basis.

Fixed amount for a one-off commission, in the currency's minor units. Null for trailing commissions.

name : String! required

The name of the partner commission.

number : ID! required

Unique identifier for the partner commission.

How a trailing commission is calculated. Null for one-off commissions.

percentage : Decimal

Trailing commission percentage. Null when the commission is not percentage-based.

Products and rate specifications uplifted by a trailing commission. Empty for one-off commissions.

targetEntity : PartnerCommissionTargetEntity! required

The entity the commission applies to.

unitAmount : Decimal

Trailing commission amount per unit. Null when the commission is not unit-based.

validFrom : DateTime! required

When the commission becomes valid.

validTo : DateTime

When the commission stops being valid. Null when the commission is open-ended.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "basis": "ONE_OFF", "fixedAmount": PartnerCommissionMoneyType, "name": "green-our-center-professor-wall", "number": "41355099", "payoutType": "UNIT", "percentage": "1.0", "productUpliftConfigurations": [PartnerCommissionProductUpliftConfigurationType], "targetEntity": "LEAD", "unitAmount": "1.0", "validFrom": "1984-07-29T19:53:17.388175+00:00", "validTo": "1984-01-19T22:18:56.897916+00:00" }