BizKitHub
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

Query parameters

· 1
slugstringRequired

Branch slug.

Examplenusle

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

Internal database ID of the validity period.

fromDatestringRequired

Start of the period (inclusive), YYYY-MM-DD.

toDatestring | nullRequired

End of the period (inclusive). NULL = open-ended (still in force).

One of 2:
Variant 1
string
Variant 2
null
percentagenumberRequired

Franchise fee in percent (e.g. 9 = 9 %). 0–100.

notestring | nullRequired

Optional human note (contract ref, reason for change, …).

One of 2:
Variant 1
string
Variant 2
null
insertedDateDate | string | string | numberRequired

When the row was created.

One of 4:
Variant 1
Date

When the row was created.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemCountnumberRequired

Response example

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

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key