BizKitHub
DocsAPI ReferenceBranch/api/v1/branch/my-finance-report-pdf
getBranchPublic API v1

/api/v1/branch/my-finance-report-pdf

Returns the print-ready A4 monthly finance report (application/pdf, inline) of one branch: headline KPIs (turnover, cash-in, franchise fee, write-offs, costs, gateway fee, net, settlement) and the detail tables. It is the same report the franchisee receives with the settlement invoice, rendered fresh on every request, so the numbers match /branch/my-monthly-breakdown to the cent.

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-finance-report-pdf

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
monthstringRequired

Month identifier in YYYY-MM format.

Example2026-10

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

GET /api/v1/branch/my-finance-report-pdf

get
curl -X GET "https://api.bizkithub.com/api/v1/branch/my-finance-report-pdf?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg&branchSlug=gymroom-vinohrady&month=2026-10" \
  -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