BizKitHub
DocsAPI ReferenceBranch/api/v1/branch/my-monthly-breakdown
getBranchPublic API v1

/api/v1/branch/my-monthly-breakdown

Per-month financial roll-up of one branch for the logged-in franchisee: turnover, cash-in, credit settlement, write-offs, franchise fee, gateway fee, fixed and variable costs, the resulting net and the settlement invoice of each month (number, due date, paid date, PDF link), plus window totals and average / median / best / worst month reference values.

Figures are identical to the Finance tab in the BizKitHub admin. Internal data (franchise-fee rule notes, settlement bookkeeping details, internal order identifiers, other branches) is not included.

Access rule (same as /branch/my-branch-list): a caller whose contact is linked to an organisation member holding root (directly or via a role) may open any active branch; everyone else only active branches where their contact is the technician in shop__branch_person. Any other slug, including a non-existent one, answers 403 BRANCH_FORBIDDEN.

branchgetApiV1BranchMy-monthly-breakdown

Parameters

4 query

Query parameters

· 4
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
identityIdstringRequired

Logged user identity (from your frontend cookies). Learn more

ExampleZ9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg
branchSlugstringRequired

Branch slug (from /branch/my-branch-list).

Examplegymroom-vinohrady
monthCountstringOptional

How many calendar months to return (default 12, clamped to [1, 60]). The window always ends with the current month and never starts before the branch opened.

Example12

Response schema

2 status codes documented

200Success
branchSlugstringRequired
branchNamestringRequired
currencystringRequired

ISO 4217 code of the organisation default currency.

ExampleCZK
franchiseFeePercentagenumber | nullRequired

Franchise-fee rate in force today (percent); null when not configured.

One of 2:
Variant 1
number
Variant 2
null
monthCountnumberRequired

Effective number of returned months (post-clamp).

monthsobject[]Required

Months in ascending order.

Each array item:
monthstringRequired

Month identifier in "YYYY-MM" format.

Example2026-10
revenuenumberRequired

Gross revenue (turnover) of the month, storno items excluded.

cashInAmountnumberRequired

Money actually received in the month (gateway payments + matched bank transfers) for orders attributed to the branch. Cash-flow figure dated by payment day, not turnover.

creditAmountnumberRequired

Net credit balance moved in the month (credit settlement).

writeoffnumberRequired

Sum of write-offs (corrections) effective in the month.

franchiseFeePercentagenumberRequired

Franchise-fee rate in force in this month (percent). 0 when no rule covers the month.

Example9
franchiseFeeAmountnumberRequired

revenue × franchiseFeePercentage ÷ 100, rounded.

gatewayFeeAmountnumberRequired

Payment-gateway commission on the gateway-routed part of cash-in.

costAmountnumberRequired

Fixed branch costs (rent, energy, …) applied to the month.

variableCostnumberRequired

Variable cost of sold items (positive magnitude).

netnumberRequired

What the branch keeps: revenue − franchiseFeeAmount + writeoff − costAmount − gatewayFeeAmount − variableCost.

invoicenull | objectRequired

Settlement order (vyrovnání) of the month. null when none has been issued yet.

One of 2:
Variant 1
null
Variant 2
orderNumberstringRequired

Public number of the settlement order.

Example2026100012
dueDatestring | nullRequired

ISO due date; null when not set.

One of 2:
Variant 1
string
Variant 2
null
paidDatestring | nullRequired

ISO timestamp of payment; null while unpaid.

One of 2:
Variant 1
string
Variant 2
null
isStornobooleanRequired

True when the settlement order has been cancelled (storno).

documentTypestring | nullRequired

Type of the linked accounting document (invoice, proforma, …); null when none is issued.

One of 2:
Variant 1
string
Variant 2
null
pdfUrlstring | nullRequired

Direct download URL of the accounting document PDF (final invoice preferred over proforma). May be time-limited for private storage; fetch fresh from this endpoint instead of caching it. null when no document has been issued (e.g. a zero-amount statement).

One of 2:
Variant 1
string
Variant 2
null
totalsobjectRequired
revenuenumberRequired
cashInAmountnumberRequired
creditAmountnumberRequired
writeoffnumberRequired
franchiseFeeAmountnumberRequired
gatewayFeeAmountnumberRequired
costAmountnumberRequired
variableCostnumberRequired
netnumberRequired
monthlyAverageRevenuenumberRequired
monthlyMedianRevenuenumberRequired
monthlyAverageNetnumberRequired
monthlyMedianNetnumberRequired
bestMonthnull | objectRequired
One of 2:
Variant 1
null
Variant 2
monthstringRequired
netnumberRequired
worstMonthnull | objectRequired
One of 2:
Variant 1
null
Variant 2
monthstringRequired
netnumberRequired

Response example

application/json
{
  "branchSlug": "example_branchSlug",
  "branchName": "example_branchName",
  "currency": "CZK",
  "franchiseFeePercentage": 9,
  "monthCount": 0,
  "months": [
    {
      "month": "2026-10",
      "revenue": 0,
      "cashInAmount": 0,
      "creditAmount": 0,
      "writeoff": 0,
      "franchiseFeePercentage": 9,
      "franchiseFeeAmount": 0,
      "gatewayFeeAmount": 0,
      "costAmount": 0,
      "variableCost": 0,
      "net": 0
    }
  ],
  "totals": {
    "revenue": 0,
    "cashInAmount": 0,
    "creditAmount": 0,
    "writeoff": 0,
    "franchiseFeeAmount": 0,
    "gatewayFeeAmount": 0,
    "costAmount": 0,
    "variableCost": 0,
    "net": 0,
    "monthlyAverageRevenue": 0,
    "monthlyMedianRevenue": 0,
    "monthlyAverageNet": 0,
    "monthlyMedianNet": 0
  }
}

All documented status codes

· 2

Request example

GET /api/v1/branch/my-monthly-breakdown

get
curl -X GET "https://api.bizkithub.com/api/v1/branch/my-monthly-breakdown?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg&branchSlug=gymroom-vinohrady&monthCount=12" \
  -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