Commission Profiles
A commission profile defines how an agent or dealer earns commission. See the Commission Profiles guide for how they are used.
Methods
Section titled “Methods”Retrieve Single Commission Profile
Section titled “Retrieve Single Commission Profile”/backend/api/v1/commissionProfiles/ID - fetch the commission profile with the specified ID.
List Commission Profiles
Section titled “List Commission Profiles”/backend/api/v1/commissionProfiles/ - list all commission profiles.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include profiles with a higher ID |
createdSince | datetime | No | Only include profiles created since the given time |
updatedSince | datetime | No | Only include profiles updated since the given time |
/backend/api/v1/commissionProfiles/ - add a new commission profile. The newly-added profile will be returned.
/backend/api/v1/commissionProfiles/ID - update the commission profile with the specified ID. The modified profile will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/commissionProfiles/ID - delete the commission profile with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| commissionProfileName | Commission Profile | Text | Name of the commission profile |
| commissionProfileTransactionSources | Use For | Preset Value(s) | Array of transaction source names this commission profile applies to |
| commissionType | Commission Type | Preset Value | Name of the commission type for this profile |
| commissionValue | Commission Value | Currency | Commission value before targets are met |
| commissionValuePostTarget | Commission Value (After Targets) | Currency | Commission value after targets are met |
| id | Commission Profile ID | Text | The unique identifier for this commission profile |