BizKitHub
DocsAPI ReferenceBranch/bff/branch/inkaso-entries
getBranchAdmin BFF

/bff/branch/inkaso-entries

Returns one DataGrid page of pre-pro-rated real-money receipts that compose the "Inkaso" headline on the Finance tab. The same CTE drives both — by construction, SUM(allocatedAmount) over the filtered set equals the Inkaso cell on Finance for the same branchSlug + filterMonth to the cent.

BranchgetBffBranchInkaso-entries

Parameters

8 query

Query parameters

· 8
branchSlugstringRequired

Branch slug.

Examplegymroom-vinohrady
pagestring | numberOptional

Page number (1-based).

Range: 1–∞
limitstring | numberOptional

Items per page.

Range: 1–500
orderBystringOptional

Sort directive in field:direction form. Supported fields: receiptDate, allocatedAmount, signedAmount, grossAmount, branchShare, source, direction, status, orderNumber.

ExamplereceiptDate:desc
monthCountstringOptional

Window size in months (default 24, clamped to [1, 60]). Identical semantics to /monthly-breakdown.

Example24
filterMonthstringOptional

Restrict to a single calendar month, expressed as YYYY-MM. Receipts are bucketed by receipt_date (when the money moved), the SAME dimension the Inkaso column on Finance uses, so totalAllocated here equals the Inkaso cell for that month exactly. Malformed values are ignored.

Example2026-06
filterSource"gateway" | "bank_transaction"Optional

Restrict to one canonical receipt source.

filterDirection"in" | "out"Optional

Restrict to incoming or outgoing (refund) receipts.

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

Stable composite id (source-sourceId).

source"gateway" | "bank_transaction"Required
sourceIdnumberRequired

Raw primary key in the source table.

receiptDatestringRequired

When the money actually moved (ISO 8601). To the nearest second the source records.

statusstringRequired

Source status. Gateway: PAID / AUTHORIZED / COMPLETE. Bank wire: "reconciled".

direction"in" | "out"Required

Incoming money vs. refund. Bank wires with negative price → "out".

grossAmountnumberRequired

Source row gross amount (positive, sign in direction).

signedAmountnumberRequired

signedAmount = direction-encoded gross. Negative = refund.

branchSharenumberRequired

Branch's pro-rate share of this order in [0, 1]. 1.0 = single-branch order. Denominator keeps storno (so storno reduces the share) and clamps negative discount lines so the share can't exceed 1.

allocatedAmountnumberRequired

Branch-allocated cash-in for this receipt = signedAmount × branchShare. SUM over the filtered set equals the Inkaso cell on Finance.

currencystring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
gatewayTransactionIdstring | nullRequired

Top-level mirror of gateway.transactionId. Lifted so the admin DataGrid can address it as a sortable column field.

One of 2:
Variant 1
string
Variant 2
null
orderobjectRequired
orderNumberstringRequired
hashstringRequired

For deep-link to /order/.

customerobjectOptional
contactIdstringRequired
firstNamestringOptional
lastNamestringOptional
companyNamestringOptional
gatewayobjectOptional
providerNamestringRequired

e.g. "GoPay", "Stripe".

instanceCodestringRequired

Per-organisation instance code.

transactionIdstring | nullRequired

Transaction id at the gateway provider (shop__order_payment.gateway_id). NULL on legacy rows.

One of 2:
Variant 1
string
Variant 2
null
bankobjectOptional
bankExternalIdstringRequired

Bank's transaction id (Fio bank_transaction_id).

accountNamestringRequired

Bank account display name or "-/".

counterpartyAccountstringOptional
counterpartyNamestringOptional
messagestringOptional

Joined message + user_notice + to_message.

variableSymbolstringOptional
itemCountnumberRequired

Total rows matching filters (across all pages).

totalAllocatednumberRequired

Sum of allocatedAmount over the filtered set (NOT just the current page). Matches the Finance Inkaso cell for the same window + month.

incomingCountnumberRequired

How many receipts in the filtered set are direction='in'.

outgoingCountnumberRequired

How many receipts are direction='out' (refunds). They subtract from totalAllocated.

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "sourceId": 0,
      "receiptDate": "example_receiptDate",
      "status": "example_status",
      "grossAmount": 0,
      "signedAmount": 0,
      "branchShare": 0,
      "allocatedAmount": 0,
      "order": {
        "orderNumber": "example_orderNumber",
        "hash": "example_hash"
      },
      "customer": {
        "contactId": "example_contactId",
        "firstName": "example_firstName",
        "lastName": "example_lastName",
        "companyName": "example_companyName"
      },
      "gateway": {
        "providerName": "example_providerName",
        "instanceCode": "example_instanceCode"
      },
      "bank": {
        "bankExternalId": "example_bankExternalId",
        "accountName": "example_accountName",
        "counterpartyAccount": "example_counterpartyAccount",
        "counterpartyName": "example_counterpartyName",
        "message": "example_message",
        "variableSymbol": "example_variableSymbol"
      }
    }
  ],
  "itemCount": 0,
  "totalAllocated": 0,
  "incomingCount": 0,
  "outgoingCount": 0
}

Request example

GET /bff/branch/inkaso-entries

get
curl -X GET "https://api.bizkithub.com/bff/branch/inkaso-entries?branchSlug=gymroom-vinohrady&orderBy=receiptDate%3Adesc&monthCount=24&filterMonth=2026-06" \
  -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