For support support@leadrat.com

Create or update commission settings

PUT

/commission-settings

Maintainer:Not configured

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

x-tenant-id

Example:

x-tenant-id: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Settings saved successfully

Body

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/commission-settings' \
--header 'Authorization: Bearer <token>' \
--header 'x-tenant-id: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "defaultCommissionType": "PERCENTAGE",
    "defaultCommissionRate": 0,
    "gstRate": 0,
    "tdsRate": 0,
    "notificationLeadTimeDays": 0,
    "adminEmailAddresses": [
        "string"
    ],
    "adminMobileNumbers": [
        "string"
    ]
}'

Response Example

200 - Success

{
    "defaultCommissionType": "PERCENTAGE",
    "defaultCommissionRate": 3,
    "gstRate": 18,
    "tdsRate": 10
}

Modified at 2026-04-16 18:43:47

Get commission settings for current tenant

Mark a commission payout as paid (after bank transfer/cheque)