iotoms Docs

List commission plans

GET
/api/v1/commission/plans

Returns commission plans, flat-rate or slab-based, with the number of people actively assigned to each. Paginated with 0-based page and size (default 20).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

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?

One page of commission plans.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/commission/plans' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "content": [      {        "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"      }    ],    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0  }}