/bff/branch-cost/edit

Edit an existing branch cost

Branch CostpostBffBranch-costEdit

Parameters

13 body

13 total

Body · 13

costIdstringRequired

External id of the cost to edit.

namestring

Length: 1–200

typestring | string

defaultAmountMoneynumber

Range: 0–∞

appliesFromstring

appliesTostring | null

isActiveboolean

recurringIntervalMonthsnumber

Range: 1–36

paymentDayOfMonthnumber | null

notestring | null

contactExternalIdstring | null

payerContactExternalIdstring | null

Request

POST /bff/branch-cost/edit

post

curl -X POST "https://api.bizkithub.com/bff/branch-cost/edit" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "costId": "example_costId",
  "name": "example_name",
  "defaultAmountMoney": 0,
  "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