/bff/branch-cost/create

Create a recurring branch cost

Branch CostpostBffBranch-costCreate

Parameters

14 body

14 total

Body · 14

branchSlugstringRequired

namestringRequired

Length: 1–200

typestring | stringRequired

defaultAmountMoneynumberRequired

Amount in minor units (cents / haléře). Non-negative.

Range: 0–∞

currencystring

ISO 4217 — defaults to the organisation default currency.

appliesFromstringRequired

ISO YYYY-MM-DD.

appliesTostring | null

isActiveboolean

recurringIntervalMonthsnumber

Range: 1–36

paymentDayOfMonthnumber | null

notestring | null

contactExternalIdstring | null

payerContactExternalIdstring | null

Request

POST /bff/branch-cost/create

post

curl -X POST "https://api.bizkithub.com/bff/branch-cost/create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "branchSlug": "example_branchSlug",
  "name": "example_name",
  "defaultAmountMoney": 0,
  "currency": "example_currency",
  "appliesFrom": "example_appliesFrom",
  "isActive": false,
  "recurringIntervalMonths": 0
}'

Response

JSON payload

{
  "success": false,
  "costId": "example_costId"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key