/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

8 total

Query · 8

branchSlugstringRequired

Branch slug.

pagestring | number

Page number (1-based).

Range: 1–∞

limitstring | number

Items per page.

Range: 1–500

orderBystring

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

monthCountstring

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

filterMonthstring

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.

filterSourcestring | string

Restrict to one canonical receipt source.

filterDirectionstring | string

Restrict to incoming or outgoing (refund) receipts.

Request

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"

Response

JSON payload

{
  "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
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key