BizKitHub
DocsAPI ReferenceLedger/bff/ledger/bank-rule/save
postLedgerAdmin BFF

/bff/ledger/bank-rule/save

Create or update a bank rule

LedgerpostBffLedgerBank-ruleSave

Parameters

JSON body

Request body

application/json
entityIdstringRequired

Accounting entity external id.

Length: 16–24
idstringOptional
Length: 24–24
namestringRequired
Length: 1–120
direction"in" | "out"Required
counterpartyAccountstring | nullOptional
One of 2:
Variant 1
string
Length: 0–64
Variant 2
null
counterpartyBankstring | nullOptional
One of 2:
Variant 1
string
Length: 0–4
Variant 2
null
counterpartyPrefixstring | nullOptional
One of 2:
Variant 1
string
Length: 0–6
Variant 2
null
variableSymbolstring | nullOptional
One of 2:
Variant 1
string
Length: 0–10
Variant 2
null
messageContainsstring | nullOptional
One of 2:
Variant 1
string
Length: 0–120
Variant 2
null
amountMinnumber | nullOptional
One of 2:
Variant 1
number
Range: 0–∞
Variant 2
null
amountMaxnumber | nullOptional
One of 2:
Variant 1
number
Range: 0–∞
Variant 2
null
currencystring | nullOptional
One of 2:
Variant 1
string
Length: 0–3
Variant 2
null
accountCodestringRequired
Length: 3–16
entryDescriptionstring | nullOptional
One of 2:
Variant 1
string
Length: 0–255
Variant 2
null
prioritystring | integerOptional
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 1–999
isActivebooleanOptional
origin"manual" | "template" | "mined"Optional
templateKeystring | nullOptional
One of 2:
Variant 1
string
Length: 0–64
Variant 2
null

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

POST /bff/ledger/bank-rule/save

post
curl -X POST "https://api.bizkithub.com/bff/ledger/bank-rule/save" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "entityId": "example_entityId",
  "id": "example_id",
  "name": "example_name",
  "accountCode": "example_accountCode",
  "isActive": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key