/bff/branch/franchise-fee-update

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-update

Parameters

JSON body

Request body

application/json

idstringRequired

Franchise-fee period ID.

Example1

fromDatestringOptional

New start (YYYY-MM-DD).

toDatestring | nullOptional

New end (YYYY-MM-DD) or null for open-ended.

One of 2:

Variant 1

string

Variant 2

null

percentagenumberOptional

New percentage. Must be between 0 and 100.

notestring | nullOptional

New free-form description of what the tariff covers (max 5000 chars). Also propagated into the finance-report PDF.

One of 2:

Variant 1

string

Length: 0–5000

Variant 2

null

Response schema

1 status code documented

200Success

successbooleanRequired

Default: true

Response example

application/json

{
  "success": true
}

Request example

POST /bff/branch/franchise-fee-update

post

curl -X POST "https://api.bizkithub.com/bff/branch/franchise-fee-update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "1",
  "fromDate": "example_fromDate",
  "percentage": 0
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key