/bff/branch/franchise-fee-add

Organisation branches (pobočky) management. Each organisation can create any number of branches. A branch contains name, description, internal code, address, GPS coordinates, manager, opening hours (regular + exceptions), email/phone contacts and a photo gallery with a dedicated main photo.

BranchpostBffBranchFranchise-fee-add

Parameters

JSON body

Request body

application/json

slugstringRequired

Branch slug the period belongs to.

Examplenusle

fromDatestringRequired

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

Example2026-01-01

toDatestring | nullOptional

End of the validity period (inclusive). Omit or pass null for open-ended.

One of 2:

Variant 1

string

Variant 2

null

percentagenumberRequired

Franchise fee in percent (e.g. 9 for 9 %). Must be between 0 and 100.

Example9

notestring | nullOptional

Free-form description of what the tariff covers (services, agreement scope). Max 5000 characters. Rendered into the branch finance-report PDF for the month this rule covers so the franchisee sees which services justify the percentage.

One of 2:

Variant 1

string

Length: 0–5000

Variant 2

null

Response schema

1 status code documented

200Success

successbooleanRequired

Default: true

idstringRequired

Response example

application/json

{
  "success": true,
  "id": "example_id"
}

Request example

POST /bff/branch/franchise-fee-add

post

curl -X POST "https://api.bizkithub.com/bff/branch/franchise-fee-add" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "slug": "nusle",
  "fromDate": "2026-01-01",
  "toDate": "2026-12-31",
  "percentage": 9
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key