v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB

SaleFee

Retrieve a sale fee

Get a sale fee for the specified business id, branch id and sale fee id

get/api/business/{businessId}/branch/{branchId}/salefee/{saleFeeId}

Path parameters

businessIdstring required

branchIdstring required

saleFeeIdstring required

Response

Specified sale fee retrieved

saleFeeIdstring

namestring

type'PERCENT' | 'AMOUNT'

The type of fee. Can be either PERCENT or AMOUNT

valuenumber

taxRateIdstring

automaticboolean

Is the fee automatically applied to sales

servicesOnlyboolean

Does the fee only apply to services

archivedboolean

activeboolean

deletedboolean

createTimestring date-time

updateTimestring date-time

restrictedServiceIdsstring[]

List of service ids the sale fee does not apply to

Example response

{
  "saleFeeId": "eTC3QY5W3p_HmGHezKfxJw",
  "name": "Additional fee",
  "type": "PERCENT",
  "value": 7,
  "taxRateId": "eTC3QY5W3p_HmGHezKfxJw",
  "active": true,
  "createTime": "2025-06-10T11:33:38Z",
  "updateTime": "2025-05-26T14:32:08Z",
  "restrictedServiceIds": [
    "serviceId"
  ]
}