Skip to Content

EarningsApi

All URIs are relative to https://business.apis.kesk.app/v1 

MethodHTTP requestDescription
getDriverEarningsGET /vendors/{vendor_id}/drivers/{driver_id}/earningsGet driver earnings balance
getVendorEarningsGET /vendors/{vendor_id}/earningsGet 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

NameTypeDescriptionNotes
vendor_idLongVendor ID[default to null]
driver_idLongDriver ID[default to null]

Return type

EarningApiResponseData

Authorization

JwtAuthScheme

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

NameTypeDescriptionNotes
vendor_idLongVendor ID[default to null]

Return type

EarningApiResponseData

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8