POST
/v1/accounting/hold-clawback-rules/runReview and apply accounting hold rules
Preview deal hold/release and clawback decisions from current evidence. Apply only a reviewed token with an explicit reason; save_defaults requires administrator access. Requires books write access even for previews.
Access class: workspace:books.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Request body
application/jsonrequiredactionstringoptional
afterIdintegeroptional
allDuebooleanoptional
dealIdnumberoptional
expectedobjectoptional
keyed by id (a cells object by column name or id); every value is TEXT — a number, date, yes/no or list is written as a string
limitintegeroptional
reasonstringoptional
rulesoptional
Responses
201application/json
the action's answer
{
"data": {
"applied": true,
"decisions": [
{
"afterClawbackMinor": 1.5,
"afterState": "string",
"beforeClawbackMinor": 1.5,
"beforeState": "string",
"currency": "string",
"dealId": 1.5,
"defaultAmountMinor": 1.5,
"defaultedOn": "string",
"reasons": [
"string"
],
"reference": "string",
"releaseEligible": true,
"releaseOn": "string",
"rules": {
"clawbackBasis": "string",
"clawbackSharePpm": 1.5,
"holdDays": 1.5,
"releaseAfterDays": 1.5,
"releaseAfterPayments": 1.5
},
"successfulPayments": 1.5,
"token": "string"
}
],
"nextAfterId": 1
}
}datarequired
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired