iotoms Docs

Get a commission plan

GET
/api/v1/commission/plans/{id}

Returns one commission plan by id, including its rate structure (flat rate or slabs), effective dates and how many people are actively assigned to it.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

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 commission plan.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/commission/plans/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "basis": "NET_SALES_EXCL_TAX",    "rateStructure": "FLAT",    "flatRateBp": 0,    "slabs": [      {        "seq": 0,        "fromAmount": 0,        "toAmount": 0,        "rateBp": 0      }    ],    "payoutCycle": "MONTHLY",    "effectiveFrom": "2019-08-24",    "effectiveTo": "2019-08-24",    "active": true,    "assignedCount": 0,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}