/bff/branch/settlement/issue-invoice

Creates an internal "vyrovnání" order between the branch's operating company and the counterparty (parent branch operating company if parent_branch_id is set, otherwise the organisation's internal contact). Direction is driven by the sign of settlementAmount. Idempotent on (branchSlug, settlementMonth): if an active (non-storno) settlement order already exists, returns it with HTTP 409 so the caller can navigate to it; a storno'd predecessor does not block re-issuing.

BranchpostBffBranchSettlementIssue-invoice

Parameters

JSON body

Request body

application/json

branchSlugstringRequired

Slug of the branch the settlement belongs to.

Examplegymroom-vinohrady

settlementMonthstringRequired

Month identifier in "YYYY-MM" format.

Example2026-05

settlementAmountnumberRequired

Signed settlement amount in the branch currency. Positive or zero = branch owes the organisation (branch-to-org): the branch is the invoice issuer and waits for payment. Negative = organisation owes the branch (org-to-branch): the order is issued with price = 0 (stays in "new" forever) and a matching writeoff expense is booked automatically so the difference settles cumulatively next month.

currencystringRequired

ISO 4217 code of the order currency (typically the organisation default).

ExampleCZK

Response schema

3 status codes documented

200Success

orderIdnumberRequired

orderHashstringRequired

orderNumberstringRequired

direction"org-to-branch" | "branch-to-org"Required

paidDatestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

dueDatestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

isStornobooleanRequired

Response example

application/json

{
  "orderId": 0,
  "orderHash": "example_orderHash",
  "orderNumber": "example_orderNumber",
  "isStorno": false
}

All documented status codes

· 3

Request example

POST /bff/branch/settlement/issue-invoice

post

curl -X POST "https://api.bizkithub.com/bff/branch/settlement/issue-invoice" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "branchSlug": "gymroom-vinohrady",
  "settlementMonth": "2026-05",
  "settlementAmount": 0,
  "currency": "CZK"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key