Skip to main content
POST
Add decant entitlement

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Path Parameters

id
string
required

Body

application/json
item
string
required
basis
string
required
fromOn
string
required
unit
enum<string>
required
Available options:
per_day,
one_payment,
metered
rechargeTo
enum<string>
required
Available options:
building_insurer,
landlord,
agency
toOn
string · null · null
rateMinor
amountMinor
rateText
string · null · null

Response

Success

case
object
required
entitlements
object[]
required
payments
object[]
required
rates
object[]
required
totals
object
required
payee
object | null
required