iotoms Docs

Remove a person from a commission plan

DELETE
/api/v1/commission/assignments/{assignmentId}

Deactivates a plan assignment so the person stops earning under that plan. Past settlement runs that used the assignment keep referring to it.

How to use it

  1. Find the assignment ID with List commission plan assignments (filter by planId or userRef).
  2. Delete it. The assignment becomes inactive and, if it had no end date, ends today.
  3. The person stops earning under that plan in future runs; past runs keep referring to the assignment.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

assignmentId*string

ID of the plan assignment to remove, from List commission plan assignments.

Formatuuid

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the request: SUCCESS when it worked; errors return an error status with the reason in message.

message*string

Short human-readable message describing the outcome.

data?

The plan assignment as it now stands.

Example Request
curl -X DELETE 'https://beta.iotoms.com/api/v1/commission/assignments/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",    "planName": "string",    "userRef": "string",    "rateOverrideBp": 0,    "effectiveRateBp": 0,    "effectiveFrom": "2019-08-24",    "effectiveTo": "2019-08-24",    "active": true  }}