EarningsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| getDriverEarnings | GET /vendors/{vendor_id}/drivers/{driver_id}/earnings | Get driver earnings balance |
| getVendorEarnings | GET /vendors/{vendor_id}/earnings | Get vendor earnings balance |
getDriverEarnings
EarningApiResponseData getDriverEarnings(vendor_id, driver_id)
Get driver earnings balance
Retrieves the total accumulated earnings for a specific driver under a driver partner. Requires the authenticated user to have access to the driver partner organization.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Vendor ID | [default to null] |
| driver_id | Long | Driver ID | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getVendorEarnings
EarningApiResponseData getVendorEarnings(vendor_id)
Get vendor earnings balance
Retrieves the total accumulated earnings for a specific vendor. Only authorized managers of the vendor can access this information. Creates earnings record if none exists.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Vendor ID | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8