DocsAPI ReferenceBranch/bff/branch/franchise-fee-list
getBranchAdmin BFF

/bff/branch/franchise-fee-list

Returns the chronological list of franchise-fee percentages configured for the branch. Each row defines a percentage that applies between fromDate (inclusive) and toDate (inclusive, NULL = open-ended). The Branch Finance roll-up uses the row whose window covers each month's last day to compute the franchiseFeeAmount column.

BranchgetBffBranchFranchise-fee-list

Parameters

1 query

1 total
Query · 1
slugstringRequired

Branch slug.

Request

GET /bff/branch/franchise-fee-list

get
curl -X GET "https://api.bizkithub.com/bff/branch/franchise-fee-list?slug=nusle" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "items": [
    {
      "id": "example_id",
      "fromDate": "example_fromDate",
      "percentage": 0
    }
  ],
  "itemCount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key